# pip install --upgrade pinecone
import os
from pinecone import Pinecone
pc = Pinecone(api_key=os.environ["PINECONE_API_KEY"])
# To get the host for an index, see https://docs.pinecone.io/guides/indexes/target-an-index
index = pc.index(host="INDEX_HOST")
response = index.start_import(
uri="s3://BUCKET_NAME/PATH/TO/DIR",
error_mode="continue",
integration_id="a12b3d4c-47d2-492c-a97a-dd98c8dbefde",
)
print(response.id)
// npm install @pinecone-database/pinecone
import { Pinecone } from '@pinecone-database/pinecone';
// Reads PINECONE_API_KEY from the environment
const pc = new Pinecone();
// To get the host for an index, see https://docs.pinecone.io/guides/indexes/target-an-index
const index = pc.index({ host: 'INDEX_HOST' });
const response = await index.startImport({
uri: 's3://BUCKET_NAME/PATH/TO/DIR',
errorMode: 'continue',
integration: 'a12b3d4c-47d2-492c-a97a-dd98c8dbefde',
});
console.log(response.id);
package main
import (
"context"
"fmt"
"log"
"os"
"github.com/pinecone-io/go-pinecone/v7/pinecone"
)
func main() {
ctx := context.Background()
pc, err := pinecone.NewClient(pinecone.NewClientParams{
ApiKey: os.Getenv("PINECONE_API_KEY"),
})
if err != nil {
log.Fatalf("Failed to create Client: %v", err)
}
// To get the host for an index, see https://docs.pinecone.io/guides/indexes/target-an-index
idxConnection, err := pc.Index(pinecone.NewIndexConnParams{Host: "INDEX_HOST"})
if err != nil {
log.Fatalf("Failed to create IndexConnection: %v", err)
}
integrationId := "a12b3d4c-47d2-492c-a97a-dd98c8dbefde"
errorMode := string(pinecone.ImportErrorModeContinue)
res, err := idxConnection.StartImport(ctx, "s3://BUCKET_NAME/PATH/TO/DIR", &integrationId, &errorMode)
if err != nil {
log.Fatalf("Failed to start import: %v", err)
}
fmt.Println(res.Id)
}
# To get the unique host for an index,
# see https://docs.pinecone.io/guides/indexes/target-an-index
PINECONE_API_KEY="YOUR_API_KEY"
INDEX_HOST="INDEX_HOST"
curl "https://$INDEX_HOST/bulk/imports" \
-H "Api-Key: $PINECONE_API_KEY" \
-H 'Content-Type: application/json' \
-H 'X-Pinecone-Api-Version: 2026-07' \
-d '{
"integrationId": "a12b3d4c-47d2-492c-a97a-dd98c8dbefde",
"uri": "s3://BUCKET_NAME/PATH/TO/DIR",
"errorMode": {
"onError": "continue"
}
}'
{
"id": "101"
}{
"code": 123,
"message": "<string>",
"details": [
{
"typeUrl": "<string>",
"value": "aSDinaTvuI8gbWludGxpZnk="
}
]
}Unauthorized{
"code": 123,
"message": "<string>",
"details": [
{
"typeUrl": "<string>",
"value": "aSDinaTvuI8gbWludGxpZnk="
}
]
}{
"code": 123,
"message": "<string>",
"details": [
{
"typeUrl": "<string>",
"value": "aSDinaTvuI8gbWludGxpZnk="
}
]
}Imports
Start import
Start an asynchronous import of vectors from object storage into an index.
For guidance and examples, see Import data.
POST
/
bulk
/
imports
# pip install --upgrade pinecone
import os
from pinecone import Pinecone
pc = Pinecone(api_key=os.environ["PINECONE_API_KEY"])
# To get the host for an index, see https://docs.pinecone.io/guides/indexes/target-an-index
index = pc.index(host="INDEX_HOST")
response = index.start_import(
uri="s3://BUCKET_NAME/PATH/TO/DIR",
error_mode="continue",
integration_id="a12b3d4c-47d2-492c-a97a-dd98c8dbefde",
)
print(response.id)
// npm install @pinecone-database/pinecone
import { Pinecone } from '@pinecone-database/pinecone';
// Reads PINECONE_API_KEY from the environment
const pc = new Pinecone();
// To get the host for an index, see https://docs.pinecone.io/guides/indexes/target-an-index
const index = pc.index({ host: 'INDEX_HOST' });
const response = await index.startImport({
uri: 's3://BUCKET_NAME/PATH/TO/DIR',
errorMode: 'continue',
integration: 'a12b3d4c-47d2-492c-a97a-dd98c8dbefde',
});
console.log(response.id);
package main
import (
"context"
"fmt"
"log"
"os"
"github.com/pinecone-io/go-pinecone/v7/pinecone"
)
func main() {
ctx := context.Background()
pc, err := pinecone.NewClient(pinecone.NewClientParams{
ApiKey: os.Getenv("PINECONE_API_KEY"),
})
if err != nil {
log.Fatalf("Failed to create Client: %v", err)
}
// To get the host for an index, see https://docs.pinecone.io/guides/indexes/target-an-index
idxConnection, err := pc.Index(pinecone.NewIndexConnParams{Host: "INDEX_HOST"})
if err != nil {
log.Fatalf("Failed to create IndexConnection: %v", err)
}
integrationId := "a12b3d4c-47d2-492c-a97a-dd98c8dbefde"
errorMode := string(pinecone.ImportErrorModeContinue)
res, err := idxConnection.StartImport(ctx, "s3://BUCKET_NAME/PATH/TO/DIR", &integrationId, &errorMode)
if err != nil {
log.Fatalf("Failed to start import: %v", err)
}
fmt.Println(res.Id)
}
# To get the unique host for an index,
# see https://docs.pinecone.io/guides/indexes/target-an-index
PINECONE_API_KEY="YOUR_API_KEY"
INDEX_HOST="INDEX_HOST"
curl "https://$INDEX_HOST/bulk/imports" \
-H "Api-Key: $PINECONE_API_KEY" \
-H 'Content-Type: application/json' \
-H 'X-Pinecone-Api-Version: 2026-07' \
-d '{
"integrationId": "a12b3d4c-47d2-492c-a97a-dd98c8dbefde",
"uri": "s3://BUCKET_NAME/PATH/TO/DIR",
"errorMode": {
"onError": "continue"
}
}'
{
"id": "101"
}{
"code": 123,
"message": "<string>",
"details": [
{
"typeUrl": "<string>",
"value": "aSDinaTvuI8gbWludGxpZnk="
}
]
}Unauthorized{
"code": 123,
"message": "<string>",
"details": [
{
"typeUrl": "<string>",
"value": "aSDinaTvuI8gbWludGxpZnk="
}
]
}{
"code": 123,
"message": "<string>",
"details": [
{
"typeUrl": "<string>",
"value": "aSDinaTvuI8gbWludGxpZnk="
}
]
}This feature is in public preview and available only on Standard and Enterprise plans.
# pip install --upgrade pinecone
import os
from pinecone import Pinecone
pc = Pinecone(api_key=os.environ["PINECONE_API_KEY"])
# To get the host for an index, see https://docs.pinecone.io/guides/indexes/target-an-index
index = pc.index(host="INDEX_HOST")
response = index.start_import(
uri="s3://BUCKET_NAME/PATH/TO/DIR",
error_mode="continue",
integration_id="a12b3d4c-47d2-492c-a97a-dd98c8dbefde",
)
print(response.id)
// npm install @pinecone-database/pinecone
import { Pinecone } from '@pinecone-database/pinecone';
// Reads PINECONE_API_KEY from the environment
const pc = new Pinecone();
// To get the host for an index, see https://docs.pinecone.io/guides/indexes/target-an-index
const index = pc.index({ host: 'INDEX_HOST' });
const response = await index.startImport({
uri: 's3://BUCKET_NAME/PATH/TO/DIR',
errorMode: 'continue',
integration: 'a12b3d4c-47d2-492c-a97a-dd98c8dbefde',
});
console.log(response.id);
package main
import (
"context"
"fmt"
"log"
"os"
"github.com/pinecone-io/go-pinecone/v7/pinecone"
)
func main() {
ctx := context.Background()
pc, err := pinecone.NewClient(pinecone.NewClientParams{
ApiKey: os.Getenv("PINECONE_API_KEY"),
})
if err != nil {
log.Fatalf("Failed to create Client: %v", err)
}
// To get the host for an index, see https://docs.pinecone.io/guides/indexes/target-an-index
idxConnection, err := pc.Index(pinecone.NewIndexConnParams{Host: "INDEX_HOST"})
if err != nil {
log.Fatalf("Failed to create IndexConnection: %v", err)
}
integrationId := "a12b3d4c-47d2-492c-a97a-dd98c8dbefde"
errorMode := string(pinecone.ImportErrorModeContinue)
res, err := idxConnection.StartImport(ctx, "s3://BUCKET_NAME/PATH/TO/DIR", &integrationId, &errorMode)
if err != nil {
log.Fatalf("Failed to start import: %v", err)
}
fmt.Println(res.Id)
}
# To get the unique host for an index,
# see https://docs.pinecone.io/guides/indexes/target-an-index
PINECONE_API_KEY="YOUR_API_KEY"
INDEX_HOST="INDEX_HOST"
curl "https://$INDEX_HOST/bulk/imports" \
-H "Api-Key: $PINECONE_API_KEY" \
-H 'Content-Type: application/json' \
-H 'X-Pinecone-Api-Version: 2026-07' \
-d '{
"integrationId": "a12b3d4c-47d2-492c-a97a-dd98c8dbefde",
"uri": "s3://BUCKET_NAME/PATH/TO/DIR",
"errorMode": {
"onError": "continue"
}
}'
Authorizations
An API Key is required to call Pinecone APIs. Get yours from the console.
Body
application/json
The request for the start_import operation.
The URI of the bucket (or container) and import directory containing the namespaces and Parquet files you want to import. For example, s3://BUCKET_NAME/IMPORT_DIR for Amazon S3, gs://BUCKET_NAME/IMPORT_DIR for Google Cloud Storage, or https://STORAGE_ACCOUNT.blob.core.windows.net/CONTAINER_NAME/IMPORT_DIR for Azure Blob Storage. For more information, see Import records.
Required string length:
1 - 1500The id of the storage integration that should be used to access the data.
Maximum string length:
1000Was this page helpful?