Pinecone

Learn how to use Pinecone with Composio

Overview

SLUG: PINECONE

Description

Long-term Memory for AI. The Pinecone vector database makes it easy to build high-performance vector search applications. Developer-friendly, fully managed, and easily scalable without infrastructure hassles.

Authentication Details

client_id
stringRequired
client_secret
stringRequired
oauth_redirect_uri
stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add
scopes
string
generic_api_key
stringRequired

Connecting to Pinecone

Create an auth config

Use the dashboard to create an auth config for the Pinecone toolkit. This allows you to connect multiple Pinecone accounts to Composio for agents to use.

1

Select App

Navigate to Pinecone.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Pinecone Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using OAuth2

1from composio import Composio
2
3# Replace these with your actual values
4pinecone_auth_config_id = "ac_YOUR_PINECONE_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000" # UUID from database/application
6
7composio = Composio()
8
9
10def authenticate_toolkit(user_id: str, auth_config_id: str):
11 connection_request = composio.connected_accounts.initiate(
12 user_id=user_id,
13 auth_config_id=auth_config_id,
14 )
15
16 print(
17 f"Visit this URL to authenticate Pinecone: {connection_request.redirect_url}"
18 )
19
20 # This will wait for the auth flow to be completed
21 connection_request.wait_for_connection(timeout=15)
22 return connection_request.id
23
24
25connection_id = authenticate_toolkit(user_id, pinecone_auth_config_id)
26
27# You can also verify the connection status using:
28connected_account = composio.connected_accounts.get(connection_id)
29print(f"Connected account: {connected_account}")

Using API Key

1from composio import Composio
2
3# Replace these with your actual values
4pinecone_auth_config_id = "ac_YOUR_PINECONE_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000" # UUID from database/app
6
7composio = Composio()
8
9def authenticate_toolkit(user_id: str, auth_config_id: str):
10 # Replace this with a method to retrieve an API key from the user.
11 # Or supply your own.
12 user_api_key = input("[!] Enter API key")
13
14 connection_request = composio.connected_accounts.initiate(
15 user_id=user_id,
16 auth_config_id=auth_config_id,
17 config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18 )
19
20 # API Key authentication is immediate - no redirect needed
21 print(f"Successfully connected Pinecone for user {user_id}")
22 print(f"Connection status: {connection_request.status}")
23
24 return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, pinecone_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Pinecone toolkit’s playground

For code examples, see the Tool calling guide and Provider examples.

Tool List

Tool Name: Cancel Bulk Import

Description

Tool to cancel a bulk import operation in Pinecone. Use when you need to stop an ongoing import operation that is not yet finished.

Action Parameters

id
stringRequired
index_host
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Configure Index

Description

Tool to configure an existing Pinecone index, including pod type, replicas, deletion protection, and tags. Use when you need to scale an index vertically or horizontally, enable/disable deletion protection, or update tags. The change is asynchronous; check index status for completion.

Action Parameters

api_version
stringDefaults to 2025-10
deletion_protection
index_name
stringRequired
spec
tags

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Backup

Description

Tool to create a backup of a Pinecone index for disaster recovery and version control. Use when you need to preserve the current state of an index including vectors, metadata, and configuration.

Action Parameters

description
index_name
stringRequired
name

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Index

Description

Tool to create a Pinecone index with specified configuration. Use when you need to initialize a new vector database index for storing and querying embeddings.

Action Parameters

deletion_protection
dimension
metric
stringRequired
name
stringRequired
spec
objectRequired
vector_type

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Index with Embedding Model

Description

Tool to create a Pinecone index with integrated embedding model for automatic vectorization. Use when you need to set up a new index that automatically converts text to vectors using a pre-configured embedding model.

Action Parameters

cloud
stringRequired
deletion_protection
embed
objectRequired
name
stringRequired
region
stringRequired
tags

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Index from Backup

Description

Tool to create an index from a backup. Use when you need to restore or duplicate index data from a previously saved backup.

Action Parameters

backup_id
stringRequired
deletion_protection
name
stringRequired
tags

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Namespace

Description

Tool to create a namespace within a serverless Pinecone index. Use when you need to organize vectors into isolated partitions.

Action Parameters

index_host
stringRequired
name
stringRequired
schema

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Index

Description

Tool to permanently delete a Pinecone index. Use when you need to remove an index from your project. Note: Deletion protection and pending collections can prevent deletion.

Action Parameters

index_name
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Namespace

Description

Tool to permanently delete a namespace from a serverless index. Use when you need to remove an entire namespace and all its data. This operation is irreversible and only supported on serverless indexes.

Action Parameters

index_host
stringRequired
namespace
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Describe Backup

Description

Tool to retrieve detailed information about a specific backup. Use when you need to check backup status, configuration, or metadata.

Action Parameters

backup_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Describe Bulk Import

Description

Tool to describe a specific bulk import operation in Pinecone. Use when you need to retrieve detailed information about an import's status, progress, timing, and any errors.

Action Parameters

id
stringRequired
index_host
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Describe Index Stats

Description

Tool to get index statistics including vector count per namespace, dimensions, and fullness. Use when you need to understand the contents and status of an index.

Action Parameters

filter
index_host
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Describe Restore Job

Description

Tool to get detailed information about a specific restore job in Pinecone. Use when you need to check the status, progress, or metadata of a restore operation.

Action Parameters

job_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Generate Embeddings

Description

Tool to generate vector embeddings for input text using Pinecone's hosted embedding models. Use when you need to convert text into vector representations for semantic search or similarity matching.

Action Parameters

inputs
arrayRequired
model
stringRequired
parameters

Action Response

data
arrayRequired
error
model
stringRequired
successful
booleanRequired
usage
objectRequired

Tool Name: Get Model Information

Description

Tool to retrieve detailed information about a specific model hosted by Pinecone. Use when you need to understand model capabilities for embedding and reranking operations.

Action Parameters

api_version
stringDefaults to 2025-10
model_name
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Bulk Imports

Description

Tool to list all recent and ongoing bulk import operations in Pinecone. Use when you need to monitor or track the status of data import jobs. Supports pagination with a default limit of 100 imports per page.

Action Parameters

index_host
stringRequired
limit
paginationToken

Action Response

data
arrayRequired
error
pagination
successful
booleanRequired

Tool Name: List Collections

Description

Tool to list all collections in a Pinecone project (pod-based indexes only). Use when you need to view available collections.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Index Backups

Description

Tool to list all backups for a specific Pinecone index. Use when you need to view available backups for an index. Supports pagination via limit and paginationToken parameters.

Action Parameters

index_name
stringRequired
limit
paginationToken

Action Response

data
arrayRequired
error
pagination
successful
booleanRequired

Tool Name: List Indexes

Description

Tool to list all indexes in a Pinecone project. Use when you need to retrieve all indexes with their configurations and status information.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Available Models

Description

Tool to list all available embedding and reranking models hosted by Pinecone. Use when you need to discover available models or filter by model type (embed/rerank) or vector type (dense/sparse).

Action Parameters

type
vector_type

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Namespaces

Description

Tool to list all namespaces in a serverless Pinecone index. Use when you need to discover available namespaces for data organization. Returns up to 100 namespaces by default with pagination support.

Action Parameters

api_version
stringDefaults to 2025-10
index_host
stringRequired
limit
pagination_token
prefix

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Project Backups

Description

Tool to list all backups for indexes in a Pinecone project. Use when you need to retrieve backup information across all project indexes. Supports pagination with limit and paginationToken parameters.

Action Parameters

limit
paginationToken

Action Response

data
arrayRequired
error
pagination
successful
booleanRequired

Tool Name: List Restore Jobs

Description

Tool to list all restore jobs for a project with pagination support. Use when you need to view the status of restore operations or track restore progress.

Action Parameters

limit
paginationToken

Action Response

data
arrayRequired
error
pagination
successful
booleanRequired

Tool Name: List Vectors

Description

Tool to list vector IDs in a Pinecone serverless index. Use when you need to browse or retrieve vector identifiers from a namespace. Supports filtering by prefix and pagination for large result sets.

Action Parameters

index_host
stringRequired
limit
namespace
paginationToken
prefix

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Query Vectors

Description

Tool to perform semantic search within a Pinecone index using a query vector. Retrieves IDs and similarity scores of the most similar items, ordered from most to least similar. Either vector or id parameter must be provided.

Action Parameters

filter
id
includeMetadata
includeValues
indexHost
stringRequired
namespace
sparseVector
topK
integerRequired
vector

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Rerank Documents

Description

Tool to rerank documents by semantic relevance to a query. Use when you need to order retrieved documents by their semantic relevance to a user's search query using Pinecone's hosted reranking models.

Action Parameters

documents
arrayRequired
model
stringRequired
parameters
query
stringRequired
rank_fields
return_documents
Defaults to True
top_n

Action Response

data
arrayRequired
error
model
stringRequired
successful
booleanRequired
usage
objectRequired

Tool Name: Search Records in Namespace

Description

Tool to search records within a Pinecone namespace using text, vector, or ID query. Use when you need to find similar records based on embeddings or record IDs. Results can optionally be reranked for relevance.

Action Parameters

fields
index_host
stringRequired
namespace
stringRequired
query
objectRequired
rerank

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Start Bulk Import

Description

Tool to start an asynchronous bulk import of vectors from object storage (S3, GCS, or Azure Blob Storage) into a Pinecone index. Use when you need to import large volumes of vectors from external storage. Returns an import ID to track the operation status.

Action Parameters

errorMode
index_host
stringRequired
integrationId
uri
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Vector

Description

Tool to update a vector in Pinecone by ID. Use to overwrite vector values and/or metadata. Supports bulk updates via metadata filters.

Action Parameters

dryRun
filter
id
stringRequired
index_host
stringRequired
namespace
setMetadata
sparseValues
values

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Upsert Records to Namespace

Description

Tool to upsert text records into a Pinecone namespace. Use when you need to add or update records with automatic text-to-vector conversion.

Action Parameters

api_version
stringDefaults to 2025-01
index_host
stringRequired
namespace
stringRequired
records
arrayRequired

Action Response

data
objectRequired
error
successful
booleanRequired