> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/pinecone.md).

# Pinecone

Connect to Pinecone to run vector similarity search over your indexes from your AI workflows.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| Pinecone  | API Key        |

#### Pinecone

Connect to Pinecone vector database for similarity search and vector operations. Optimized for machine learning applications and semantic search.

**Set up in Pinecone**

1. Sign in to the Pinecone console.
2. Open the API Keys section for your project.
3. Create or copy an existing API key value.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Pinecone**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required | What to enter                                                                                                            |
| ------------- | -------- | ------------------------------------------------------------------------------------------------------------------------ |
| API Key       | Yes      | The API key for the Pinecone database. [Provider instructions](https://app.pinecone.io/organizations/-/projects/-/keys). |
| Environment   | Yes      | The environment for the Pinecone database (e.g., us-east-1-aws).                                                         |

**Provider documentation:** [Setup reference](https://docs.pinecone.io/guides/get-started/quickstart).

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **Pinecone** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### Vector Search

Search for similar vectors in a Pinecone database

**Inputs**

| Field             | Type            | Required | Description                                                                       |
| ----------------- | --------------- | -------- | --------------------------------------------------------------------------------- |
| Query             | string          | Yes      | Enter text to find similar vectors in the Pinecone database. Default: .           |
| Embedding Model   | select (string) | No       | The embedding model to use. Default: openai.text-embedding-3-small.               |
| Number of Results | number          | Yes      | Number of similar vectors to return. Default: 5.                                  |
| Index Name        | string          | Yes      | The name of the Pinecone index to query.                                          |
| Namespace         | string          | No       | Optional namespace within the Pinecone index. Leave empty for default. Default: . |
| Filter            | string          | No       | Optional metadata filter in JSON format. e.g., {"status": "active"}.              |

**Outputs**

| Field   | Type   | Description                                |
| ------- | ------ | ------------------------------------------ |
| Results | string | The similar vectors found in the database. |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/pinecone.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
