# Pinecone

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.

- **Category:** artificial intelligence
- **Auth:** API_KEY, OAUTH2
- **Composio Managed App Available?** No
- **Tools:** 48
- **Triggers:** 0
- **Slug:** `PINECONE`
- **Version:** 20260307_00

## Tools

### Cancel Bulk Import

**Slug:** `PINECONE_CANCEL_BULK_IMPORT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier of the import operation to cancel |
| `index_host` | string | Yes | The host URL of the index where the bulk import is running. Get this from the list indexes API or Pinecone console (e.g., 'your-index-epf46k1.svc.aped-4627-b74a.pinecone.io') |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Chat with Assistant

**Slug:** `PINECONE_CHAT_ASSISTANT`

Tool to chat with a Pinecone assistant and get structured responses with citations. Use when you need to query an assistant that has access to your knowledge base and want to get back answers with document references and citations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `model` | string | No | The large language model to use for answer generation. Default is 'gpt-4o'. |
| `filter` | object | No | Optionally filter which documents can be retrieved using metadata fields. Example: {"genre": {"$ne": "documentary"}} |
| `stream` | boolean | No | If false, the assistant returns a single JSON response. If true, the assistant returns a stream of responses. Default is false. |
| `messages` | array | Yes | List of messages in the conversation. Must include at least one message with role 'user'. |
| `temperature` | number | No | Controls randomness of model output: lower values make responses more deterministic, higher values increase creativity. Default is 0.0. |
| `json_response` | boolean | No | If true, the assistant will be instructed to return a JSON response. Cannot be used with streaming. Default is false. |
| `assistant_host` | string | Yes | The host URL for the assistant endpoint (e.g., 'prod-1-data.ke.pinecone.io'). This is the data plane host for your assistant. |
| `assistant_name` | string | Yes | The name of the assistant to chat with. |
| `context_options` | object | No | Controls the context snippets sent to the LLM. |
| `include_highlights` | boolean | No | If true, the assistant will be instructed to return highlights from the referenced documents that support its response. Default is false. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Chat with Assistant

**Slug:** `PINECONE_CHAT_COMPLETION_ASSISTANT`

Tool to chat with a Pinecone assistant through an OpenAI-compatible interface. Use when you need to interact with a Pinecone assistant that has access to indexed documents and can answer questions based on retrieved context.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `model` | string | No | The large language model to use for answer generation. |
| `filter` | object | No | Optionally filter which documents can be retrieved using metadata fields. |
| `stream` | boolean | No | If false, returns a single JSON response. If true, returns a stream of responses. |
| `messages` | array | Yes | The list of messages in the conversation, ordered from oldest to newest. |
| `temperature` | number | No | Controls the randomness of the model's output: lower values make responses more deterministic, while higher values increase creativity. Range: 0.0-2.0. |
| `assistant_host` | string | Yes | The host URL of the assistant. Get this from the list assistants operation. |
| `assistant_name` | string | Yes | The name of the assistant to chat with. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Configure Index

**Slug:** `PINECONE_CONFIGURE_INDEX`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `spec` | object | No | Index specification containing pod or serverless configuration. |
| `tags` | object | No | Updates custom tags as key-value pairs. Set value to empty string to delete a tag. Keys max 80 chars, values max 120 chars. |
| `index_name` | string | Yes | The name of the index to configure. |
| `api_version` | string | No | Required date-based version header for the Pinecone API. |
| `deletion_protection` | string ("enabled" | "disabled") | No | Sets deletion protection for the index. Use 'enabled' to prevent accidental deletion or 'disabled' to allow deletion. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Assistant

**Slug:** `PINECONE_CREATE_ASSISTANT`

Tool to create a new Pinecone assistant for RAG (Retrieval-Augmented Generation) applications. Use when you need to initialize a new assistant that can have files uploaded and support chat interactions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the assistant. Resource name must be 1-63 characters long, start and end with an alphanumeric character, and consist only of lower case alphanumeric characters or '-'. |
| `metadata` | object | No | Optional metadata associated with the assistant. JSON object that can store custom organizational data, tags, and attributes. |
| `api_version` | string | No | Required date-based version header for the Pinecone API. |
| `instructions` | string | No | Description or directive for the assistant to apply to all responses. System-level instructions that guide the assistant's behavior. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Backup

**Slug:** `PINECONE_CREATE_BACKUP`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | User-defined identifier for the backup. |
| `index_name` | string | Yes | Name of the index to backup. |
| `description` | string | No | Contextual information about the backup purpose. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Index

**Slug:** `PINECONE_CREATE_INDEX`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Index identifier (1-45 chars, lowercase alphanumeric or hyphens, must start/end with alphanumeric). |
| `spec` | object | Yes | Deployment configuration. Must provide either serverless or pod specification. |
| `metric` | string ("cosine" | "euclidean" | "dotproduct") | Yes | Similarity measure. Must be 'dotproduct' for sparse vectors. |
| `dimension` | integer | No | Vector dimensions (1-20,000). Required for dense vectors; omit for sparse vectors. |
| `vector_type` | string ("dense" | "sparse") | No | Vector type: 'dense' (default) or 'sparse'. |
| `deletion_protection` | string ("enabled" | "disabled") | No | Set to 'enabled' to prevent accidental deletion. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Index with Embedding Model

**Slug:** `PINECONE_CREATE_INDEX_FOR_MODEL`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Index identifier. Must be 1-45 characters, alphanumeric and hyphens only, must start and end with alphanumeric character. |
| `tags` | object | No | Custom metadata labels. Keys max 80 characters, values max 120 characters. |
| `cloud` | string ("gcp" | "aws" | "azure") | Yes | Cloud provider for hosting the index. |
| `embed` | object | Yes | Embedding model configuration for automatic vectorization. |
| `region` | string | Yes | Deployment region. Must be valid for the chosen cloud provider (e.g., 'us-east-1' for AWS). |
| `deletion_protection` | string ("enabled" | "disabled") | No | Protection against accidental deletion. Defaults to 'disabled' if not specified. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Index from Backup

**Slug:** `PINECONE_CREATE_INDEX_FROM_BACKUP`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Index name, 1-45 characters, alphanumeric lowercase or hyphens only. |
| `tags` | object | No | Custom key-value pairs for organization. |
| `backup_id` | string | Yes | The ID of the backup to create an index from. |
| `deletion_protection` | string | No | Enable or disable deletion safeguards. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Namespace

**Slug:** `PINECONE_CREATE_NAMESPACE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the namespace to create. |
| `schema` | object | No | Schema configuration for metadata indexing behavior. |
| `index_host` | string | Yes | The host URL of the serverless index (e.g., 'index-name-xxxxx.svc.aped-xxxx-xxxx.pinecone.io'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Assistant

**Slug:** `PINECONE_DELETE_ASSISTANT`

Tool to permanently delete a Pinecone assistant. Use when you need to remove an assistant from your project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `assistant_name` | string | Yes | The name of the assistant to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Backup

**Slug:** `PINECONE_DELETE_BACKUP`

Tool to delete a backup. Use when you need to permanently remove a backup from your project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `backup_id` | string | Yes | The ID of the backup to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete File

**Slug:** `PINECONE_DELETE_FILE`

Tool to delete an uploaded file from a Pinecone assistant. Use when you need to remove a file that was previously uploaded to an assistant.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `assistant_host` | string | Yes | The host URL of the assistant. This is typically in the format 'prod-1-data.ke.pinecone.io' or similar. |
| `assistant_name` | string | Yes | The name of the assistant to delete the file from. |
| `assistant_file_id` | string | Yes | The UUID of the file to be deleted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Index

**Slug:** `PINECONE_DELETE_INDEX`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `index_name` | string | Yes | The name of the index to delete. Example: 'test-index' |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Namespace

**Slug:** `PINECONE_DELETE_NAMESPACE`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `namespace` | string | Yes | The namespace identifier to be deleted. This operation is irreversible and will destroy all vectors in the namespace. |
| `index_host` | string | Yes | The host URL of the serverless index containing the namespace. Can be obtained from the list indexes operation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Vectors

**Slug:** `PINECONE_DELETE_VECTORS`

Tool to delete vectors by ID from a Pinecone index. Use when you need to remove specific vectors from a namespace. Supports deletion by IDs, metadata filter, or entire namespace deletion.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ids` | array | No | List of vector IDs to delete. Mutually exclusive with deleteAll and filter. Length: 1-1,000 IDs. |
| `filter` | object | No | Metadata filter to select vectors for deletion. Mutually exclusive with ids and deleteAll. Example: {"genre": {"$in": ["comedy", "documentary"]}, "year": {"$eq": 2019}} |
| `deleteAll` | boolean | No | If true, deletes all vectors in the namespace. Mutually exclusive with ids and filter. Default: false. |
| `namespace` | string | No | The namespace to delete vectors from. If not specified, uses the default namespace. |
| `index_host` | string | Yes | The host URL of the index to delete vectors from. Get this from the list_indexes response (e.g., 'my-index-abc123.svc.region.pinecone.io'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Describe Backup

**Slug:** `PINECONE_DESCRIBE_BACKUP`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `backup_id` | string | Yes | The unique identifier of the backup to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Describe Bulk Import

**Slug:** `PINECONE_DESCRIBE_BULK_IMPORT`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier for the import operation to describe. |
| `index_host` | string | Yes | The host URL of the Pinecone index where the bulk import is being performed. This is the data plane URL (e.g., 'my-index-abc123.svc.us-east1-gcp.pinecone.io'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Describe File

**Slug:** `PINECONE_DESCRIBE_FILE`

Tool to get the status and metadata of a file uploaded to a Pinecone assistant. Use when you need to check file processing status, retrieve file metadata, or get a temporary signed URL for accessing the file contents.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `api_version` | string | No | Date-based version header for the Pinecone API. |
| `include_url` | string | No | Set to 'true' to include the signed URL of the file in the response. The signed URL provides temporary, read-only access to the underlying file. |
| `assistant_host` | string | Yes | The host URL of the assistant. This is typically in the format 'prod-1-data.ke.pinecone.io' or similar. |
| `assistant_name` | string | Yes | The name of the assistant to which the file was uploaded. |
| `assistant_file_id` | string | Yes | The UUID of the file to describe. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Describe Index

**Slug:** `PINECONE_DESCRIBE_INDEX`

Tool to retrieve full Pinecone index configuration including host and integrated embedding settings. Use when you need to check if an index has integrated inference (embed config) to avoid 'Integrated inference is not configured' errors by choosing the appropriate search method.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `index_name` | string | Yes | The name of the index to describe. |
| `api_version` | string | No | Date-based version header for the Pinecone API. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Describe Index Stats

**Slug:** `PINECONE_DESCRIBE_INDEX_STATS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filter` | object | No | Metadata filter expression to get stats for only vectors matching the filter. Only supported on pod-based indexes. Serverless and starter indexes do not support this parameter. |
| `index_host` | string | Yes | The host URL of the index to get stats for (e.g., 'index-name-xxx.svc.region.pinecone.io'). Get this from the list_indexes response. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Describe Namespace

**Slug:** `PINECONE_DESCRIBE_NAMESPACE`

Tool to describe a namespace in a serverless index, including the total number of vectors. Use when you need to get metadata about a namespace such as record count and indexed fields.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `namespace` | string | Yes | The namespace to describe. |
| `index_host` | string | Yes | The host URL of the serverless index containing the namespace. Can be obtained from the list indexes operation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Describe Restore Job

**Slug:** `PINECONE_DESCRIBE_RESTORE_JOB`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_id` | string | Yes | The ID of the restore job to describe. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate Embeddings

**Slug:** `PINECONE_EMBED`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `model` | string | Yes | The embedding model to use (e.g., 'multilingual-e5-large'). |
| `inputs` | array | Yes | List of input objects to generate embeddings for. Each item contains a text field. |
| `parameters` | object | No | Optional parameters for the embedding model. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Vectors

**Slug:** `PINECONE_FETCH_VECTORS`

Tool to fetch vectors by ID from a Pinecone index. Use when you need to retrieve vector data and metadata for specific vector IDs from a single namespace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ids` | array | Yes | The vector IDs to fetch. Does not accept values containing spaces. |
| `namespace` | string | No | The namespace to fetch vectors from. If not provided, the default namespace is used. |
| `index_host` | string | Yes | The host URL of the Pinecone index to fetch vectors from. Get this from the list indexes operation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Assistant Status

**Slug:** `PINECONE_GET_ASSISTANT`

Tool to retrieve the status and details of a Pinecone assistant. Use when you need to check assistant configuration, deployment status, or metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `api_version` | string | No | Required date-based version header for the Pinecone API. |
| `assistant_name` | string | Yes | The name of the assistant to get a status on. Resource name must be 1-63 characters long, start and end with an alphanumeric character, and consist only of lower case alphanumeric characters or '-'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Model Information

**Slug:** `PINECONE_GET_MODEL`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `model_name` | string | Yes | The name of the model to look up. |
| `api_version` | string | No | Required date-based version header for the Pinecone API. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Assistants

**Slug:** `PINECONE_LIST_ASSISTANTS`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Bulk Imports

**Slug:** `PINECONE_LIST_BULK_IMPORTS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Max number of operations to return per page. Range: 1-100, default: 100 |
| `index_host` | string | Yes | The host URL of the index to list bulk imports for (e.g., 'index-name-abc123.svc.region.pinecone.io'). Get the host using the List Indexes action. |
| `paginationToken` | string | No | Pagination token to continue a previous listing operation |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Collections

**Slug:** `PINECONE_LIST_COLLECTIONS`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Files

**Slug:** `PINECONE_LIST_FILES`

Tool to list all files in a Pinecone assistant with optional metadata filtering. Use when you need to retrieve files uploaded to a specific assistant or filter files by metadata properties.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filter` | string | No | Optional JSON-encoded metadata filter for files. Use to filter files based on their metadata properties. |
| `api_version` | string | No | Date-based version header for the Pinecone API. |
| `assistant_host` | string | No | The host URL of the assistant (e.g., 'https://prod-1-data.ke.pinecone.io'). If not provided, will fetch the assistant details to get the host URL. |
| `assistant_name` | string | Yes | The name of the assistant to list files for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Index Backups

**Slug:** `PINECONE_LIST_INDEX_BACKUPS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | The number of results to return per page. Must be between 1 and 100. |
| `index_name` | string | Yes | Name of the backed up index. |
| `paginationToken` | string | No | The token to use to retrieve the next page of results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Indexes

**Slug:** `PINECONE_LIST_INDEXES`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Available Models

**Slug:** `PINECONE_LIST_MODELS`

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).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("embed" | "rerank") | No | Filter models by type. Use 'embed' for embedding models or 'rerank' for reranking models. |
| `vector_type` | string ("dense" | "sparse") | No | Filter embedding models by vector type. Only relevant when type='embed'. Use 'dense' for dense vectors or 'sparse' for sparse vectors. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Namespaces

**Slug:** `PINECONE_LIST_NAMESPACES_OPERATION`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of namespaces to return per page. |
| `prefix` | string | No | Prefix filter to return only namespaces that start with this prefix. |
| `index_host` | string | Yes | The host URL of the index to list namespaces from. You can get this from the list indexes API. |
| `api_version` | string | No | Required date-based version header for the Pinecone API. |
| `pagination_token` | string | No | Token for continuing a previous listing operation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Project Backups

**Slug:** `PINECONE_LIST_PROJECT_BACKUPS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results per page. Must be between 1 and 100. Default: 10. |
| `paginationToken` | string | No | Token for retrieving subsequent result pages. Obtained from the previous response. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Restore Jobs

**Slug:** `PINECONE_LIST_RESTORE_JOBS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page. Range: 1-100, Default: 10. |
| `paginationToken` | string | No | Token for retrieving the next page of results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Vectors

**Slug:** `PINECONE_LIST_VECTORS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of vector IDs to return per page. Default is 100. |
| `prefix` | string | No | Filter vector IDs by prefix. Does not accept values containing spaces. |
| `namespace` | string | No | The namespace to list vectors from. If not provided, the default namespace is used. |
| `index_host` | string | Yes | The host URL of the Pinecone index to list vectors from. Get this from ListIndexes action. |
| `paginationToken` | string | No | Pagination token to continue a previous listing operation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Query Vectors

**Slug:** `PINECONE_QUERY_VECTORS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | No | Vector ID to use as query. Maximum length is 512 characters. Required if vector is not provided. |
| `topK` | integer | Yes | Number of results to return per query. Must be between 1 and 10,000. |
| `filter` | object | No | Metadata filtering criteria to constrain results. Example: {"genre": {"$in": ["comedy", "documentary"]}, "year": {"$eq": 2019}} |
| `vector` | array | No | Query vector values matching index dimensionality. Length must be between 1 and 20,000. Required if id is not provided. |
| `indexHost` | string | Yes | The host URL of the Pinecone index to query. Get this from the list indexes operation. |
| `namespace` | string | No | The namespace to search. If omitted, searches the default namespace. |
| `sparseVector` | object | No | Sparse vector representation. |
| `includeValues` | boolean | No | Whether to include vector data in the response. Default is false. |
| `includeMetadata` | boolean | No | Whether to include metadata in the response. Default is false. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Rerank Documents

**Slug:** `PINECONE_RERANK`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `model` | string | Yes | The reranking model to apply (e.g., 'bge-reranker-v2-m3'). |
| `query` | string | Yes | The search query against which documents are ranked. |
| `top_n` | integer | No | Number of ranked results to return. Defaults to the total number of input documents if not specified. |
| `documents` | array | Yes | Array of document objects requiring reranking. |
| `parameters` | object | No | Additional model-specific options. Refer to model documentation for supported parameters. |
| `rank_fields` | array | No | Fields to consider for reranking. Defaults to ['text']. Model-specific limits may apply. |
| `return_documents` | boolean | No | Include documents in response. Defaults to true. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve Assistant Context

**Slug:** `PINECONE_RETRIEVE_CONTEXT_ASSISTANT`

Tool to retrieve context snippets from a Pinecone assistant for RAG or agentic workflows. Use when you need to fetch relevant document snippets based on a query or conversation messages to provide context for language model responses.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | No | The query to generate context for. Exactly one of query or messages must be provided. |
| `top_k` | integer | No | Maximum number of context snippets to return. Default is 16. Maximum is 64. |
| `filter` | object | No | Metadata filter to constrain which documents can be retrieved. Example: {"genre": {"$ne": "documentary"}} |
| `messages` | array | No | The list of messages to use for generating context. Exactly one of query or messages must be provided. |
| `multimodal` | boolean | No | Whether to retrieve image-related context snippets. If false, only text snippets are returned. Default is true. |
| `snippet_size` | integer | No | Maximum context snippet size in tokens. Default is 2048. Minimum is 512. Maximum is 8192. |
| `assistant_host` | string | Yes | The host URL for the assistant (e.g., 'prod-1-data.ke.pinecone.io'). Get this from the assistant configuration. |
| `assistant_name` | string | Yes | The name of the assistant to retrieve context from. |
| `include_binary_content` | boolean | No | If image-related context snippets are returned, this determines whether to include base64 image data. If false, only image captions are returned. Only available when multimodal=true. Default is true. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Records in Namespace

**Slug:** `PINECONE_SEARCH_RECORDS_NAMESPACE`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | object | Yes | Query configuration including top_k and optional filters, vector, or ID |
| `fields` | array | No | Fields to include in results |
| `rerank` | object | No | Reranking configuration for search results. |
| `namespace` | string | Yes | The namespace to search within |
| `index_host` | string | Yes | The host URL for the Pinecone index (e.g., 'my-index-abc123.svc.pinecone.io'). Get this from listing indexes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Start Bulk Import

**Slug:** `PINECONE_START_BULK_IMPORT`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `uri` | string | Yes | The URI of the bucket/container and import directory containing data. Format: s3://BUCKET_NAME/IMPORT_DIR, gs://BUCKET_NAME/IMPORT_DIR, or Azure Blob Storage path. |
| `errorMode` | object | No | Error handling mode for bulk import operation. |
| `index_host` | string | Yes | The host URL of the Pinecone index to import into. Get this from the index details (e.g., 'my-index-abc123.svc.aped-4627-b74a.pinecone.io'). Use List Indexes to find available index hosts. |
| `integrationId` | string | No | The identifier of the storage integration used to access the data. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Assistant

**Slug:** `PINECONE_UPDATE_ASSISTANT`

Tool to update an assistant's instructions and configuration in Pinecone. Use when you need to modify an existing assistant's behavior by changing its instructions or metadata. Updates are applied immediately.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `metadata` | object | No | Optional metadata associated with the assistant. Metadata is a JSON object that can store custom organizational data, tags, and attributes. Maximum size is 16KB. |
| `api_version` | string | No | Required date-based version header for the Pinecone API. |
| `instructions` | string | No | Description or directive for the assistant to apply to all responses. Maximum 16 KB. |
| `assistant_name` | string | Yes | The name of the assistant to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Vector

**Slug:** `PINECONE_UPDATE_VECTOR`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Vector's unique identifier. Length: 1-512 characters. |
| `dryRun` | boolean | No | If true, return the number of records matching the filter without executing the update. Default: false. |
| `filter` | object | No | Metadata filter expression for bulk updates. Example: {"genre": {"$in": ["comedy", "documentary"]}, "year": {"$eq": 2019}} |
| `values` | array | No | Vector data to update. Length: 1-20,000 elements. If provided, overwrites previous values. |
| `namespace` | string | No | The namespace containing the vector to update. If not specified, uses the default namespace. |
| `index_host` | string | Yes | The host URL of the index to update vectors in. Get this from the list_indexes response (e.g., 'my-index-abc123.svc.region.pinecone.io'). |
| `setMetadata` | object | No | Metadata to set for the vector. Key-value pairs that will be added or overwrite previous metadata. |
| `sparseValues` | object | No | Sparse vector representation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload File to Assistant

**Slug:** `PINECONE_UPLOAD_FILE`

Tool to upload a file to a Pinecone assistant for processing. Use when you need to add documents, PDFs, or other files to an assistant for knowledge retrieval or multimodal processing.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | No | The file to upload. |
| `metadata` | string | No | Optional JSON-encoded metadata for the file. Use for filtering or categorization. |
| `multimodal` | string ("true" | "false") | No | Optional flag to opt in to multimodal file processing (PDFs only). Can be 'true' or 'false'. Default is 'false'. |
| `file_content` | object | No | Model representing a file with direct content. |
| `assistant_host` | string | No | The host URL of the assistant (e.g., 'https://prod-1-data.ke.pinecone.io'). If not provided, will use the base_url from metadata. |
| `assistant_name` | string | Yes | The name of the assistant to upload the file to. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upsert Records to Namespace

**Slug:** `PINECONE_UPSERT_RECORDS_NAMESPACE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `records` | array | Yes | List of records to upsert. Each record must have an '_id' field and can contain arbitrary additional fields like 'chunk_text' for text to be converted to vectors. |
| `namespace` | string | Yes | The namespace to upsert records into. |
| `index_host` | string | Yes | The host URL of the index to upsert records into. Get this from ListIndexes action (e.g., 'test-embed-idx-99999-epf46k1.svc.aped-4627-b74a.pinecone.io'). |
| `api_version` | string | No | Pinecone API version header. Version 2025-04 or later is required to use the '__default__' namespace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upsert Vectors

**Slug:** `PINECONE_UPSERT_VECTORS`

Tool to upsert vectors into a Pinecone namespace, overwriting existing vector IDs. Use when you need to add or update vectors with their dense and/or sparse values and metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `vectors` | array | Yes | Array of vectors to upsert. Recommended batch limit is up to 1000 vectors. |
| `namespace` | string | No | The namespace where you upsert vectors. If not specified, uses the default namespace. |
| `index_host` | string | Yes | The host URL of the index to upsert vectors into. Get this from ListIndexes action (e.g., 'test-embed-idx-01-epf46k1.svc.aped-4627-b74a.pinecone.io'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |