Skip to main content
POST
/
bulk
/
imports
from pinecone import Pinecone, ImportErrorMode

pc = Pinecone(api_key="YOUR_API_KEY")

# To get the unique host for an index, 
# see https://docs.pinecone.io/guides/manage-data/target-an-index
index = pc.Index(host="INDEX_HOST")
root = "s3://BUCKET_NAME/PATH/TO/DIR"

index.start_import(
    uri=root,
    error_mode=ImportErrorMode.CONTINUE, # or ImportErrorMode.ABORT
    integration_id="a12b3d4c-47d2-492c-a97a-dd98c8dbefde" # Optional for public buckets
)

{
   "id": "101"
}
This feature is in public preview and available only on Standard and Enterprise plans.
from pinecone import Pinecone, ImportErrorMode

pc = Pinecone(api_key="YOUR_API_KEY")

# To get the unique host for an index, 
# see https://docs.pinecone.io/guides/manage-data/target-an-index
index = pc.Index(host="INDEX_HOST")
root = "s3://BUCKET_NAME/PATH/TO/DIR"

index.start_import(
    uri=root,
    error_mode=ImportErrorMode.CONTINUE, # or ImportErrorMode.ABORT
    integration_id="a12b3d4c-47d2-492c-a97a-dd98c8dbefde" # Optional for public buckets
)

{
   "id": "101"
}

Authorizations

​
Api-Key
string
header
required

An API Key is required to call Pinecone APIs. Get yours from the console.

Body

application/json

The request for the start_import operation.

​
uri
string
required

The URI prefix under which the data to import is available. All data within this prefix will be listed then imported into the target index. Currently only s3:// URIs are supported.

Required string length: 1 - 1500
​
integrationId
string

The id of the storage integration that should be used to access the data.

Maximum string length: 1000
​
errorMode
object

Indicates how to respond to errors during the import process.

Response

Successful import operation

The response for the start_import operation.

​
id
string

Unique identifier for the import operation.

Required string length: 1 - 1000
Example:

"101"