# Reference ::::card-grid :::card{title="Pinecone Nexus API" href="/guides/reference-introduction"} Programmatic access to Nexus workspaces, contexts, sources, curation, and KnowQL queries. ::: :::card{title="Authentication" href="/guides/reference-authentication"} Authenticate to the Nexus API with your Pinecone API key, sent directly or exchanged for a short-lived session token. ::: :::card{title="Configure an index" href="/guides/reference-2024-07-control-plane-configure-index"} Configure an existing index. ::: :::card{title="Create an index" href="/guides/reference-2024-07-control-plane-create-index"} Create an index for vectors created with an external embedding model. ::: :::card{title="Delete an index" href="/guides/reference-2024-07-control-plane-delete-index"} Delete an existing index. ::: :::card{title="Describe an index" href="/guides/reference-2024-07-control-plane-describe-index"} ::: :::card{title="List indexes" href="/guides/reference-2024-07-control-plane-list-indexes"} This operation returns a list of all indexes in a project. ::: :::card{title="Delete vectors" href="/guides/reference-2024-07-data-plane-delete"} The delete operation deletes vectors, by id, from a single namespace. ::: :::card{title="Search with a vector" href="/guides/reference-2024-07-data-plane-query"} Search a namespace with a query vector or record ID and return the IDs of the most similar records, along with their similarity scores. ::: :::card{title="Describe an index" href="/guides/reference-2024-10-control-plane-describe-index"} ::: :::card{title="List indexes" href="/guides/reference-2024-10-control-plane-list-indexes"} This operation returns a list of all indexes in a project. ::: :::card{title="Generate vectors" href="/guides/reference-2024-10-inference-generate-embeddings"} ::: :::card{title="Rerank results" href="/guides/reference-2024-10-inference-rerank"} Rerank query results according to their relevance to a query. This endpoint uses Pinecone Inference. ::: :::card{title="Chat with an assistant" href="/guides/reference-2025-01-assistant-chat-assistant"} ::: :::card{title="Create an assistant" href="/guides/reference-2025-01-assistant-create-assistant"} ::: :::card{title="Generate vectors" href="/guides/reference-2025-01-inference-generate-embeddings"} ::: :::card{title="Rerank results" href="/guides/reference-2025-01-inference-rerank"} Rerank query results according to their relevance to a query. This endpoint uses Pinecone Inference. ::: :::card{title="Create an index with integrated embedding" href="/guides/reference-2025-04-control-plane-create-for-model"} Create an index with integrated embedding. ::: :::card{title="Create an index" href="/guides/reference-2025-04-control-plane-create-index"} ::: :::card{title="List indexes" href="/guides/reference-2025-04-control-plane-list-indexes"} List all indexes in a project. ::: :::card{title="Describe a model" href="/guides/reference-2025-04-inference-describe-model"} Get a description of a model hosted by Pinecone. ::: :::card{title="Generate vectors" href="/guides/reference-2025-04-inference-generate-embeddings"} ::: :::card{title="Chat with an assistant" href="/guides/reference-2025-10-assistant-chat-assistant"} ::: :::card{title="Retrieve context from an assistant" href="/guides/reference-2025-10-assistant-context-assistant"} Retrieve context snippets from an assistant to use as part of RAG or any agentic flow. ::: :::card{title="Create an assistant" href="/guides/reference-2025-10-assistant-create-assistant"} ::: :::card{title="Upload file to assistant" href="/guides/reference-2025-10-assistant-upload-file"} Upload a file to the specified assistant. ::: :::card{title="Configure an index" href="/guides/reference-2025-10-control-plane-configure-index"} Configure an existing index. For guidance and examples, see Manage indexes. ::: :::card{title="Create an index with integrated embedding" href="/guides/reference-2025-10-control-plane-create-for-model"} Create an index with integrated embedding. ::: :::card{title="Create an index" href="/guides/reference-2025-10-control-plane-create-index"} ::: :::card{title="Describe an index" href="/guides/reference-2025-10-control-plane-describe-index"} ::: :::card{title="Create a namespace" href="/guides/reference-2025-10-data-plane-createnamespace"} Create a namespace in a serverless index. ::: :::card{title="Get index stats" href="/guides/reference-2025-10-data-plane-describeindexstats"} Return statistics about the contents of an index, including the vector count per namespace, the number of dimensions, and the index fullness. ::: :::card{title="Describe a namespace" href="/guides/reference-2025-10-data-plane-describenamespace"} Describe a namespace in a serverless index, including the total number of vectors in the namespace. ::: :::card{title="Fetch vectors by metadata" href="/guides/reference-2025-10-data-plane-fetch-by-metadata"} Look up and return vectors by metadata filter from a single namespace. The returned vectors include the vector data and/or metadata. ::: :::card{title="List namespaces" href="/guides/reference-2025-10-data-plane-listnamespaces"} List all namespaces in a serverless index. ::: :::card{title="Search with a vector" href="/guides/reference-2025-10-data-plane-query"} Search a namespace using a query vector. It retrieves the ids of the most similar items in a namespace, along with their similarity scores. ::: :::card{title="Search with text" href="/guides/reference-2025-10-data-plane-search-records"} Search a namespace with a query text, query vector, or record ID and return the most similar records, along with their similarity scores. Optionally, rerank the initial results based on their relevance to the query. ::: :::card{title="Update a vector" href="/guides/reference-2025-10-data-plane-update"} Update a vector in a namespace. If a value is included, it will overwrite the previous value. If a set\_metadata is included, the values of the fields specified in it will be added or overwrite the previous value. ::: :::card{title="Get API key details" href="/guides/reference-2026-04-admin-assistant-fetch-api-key"} Get an API key's details, excluding its secret. ::: :::card{title="List API keys" href="/guides/reference-2026-04-admin-assistant-list-api-keys"} List all API keys in a project. ::: :::card{title="Chat with an assistant" href="/guides/reference-2026-04-assistant-chat-assistant"} ::: :::card{title="Chat through an OpenAI-compatible interface" href="/guides/reference-2026-04-assistant-chat-completion-assistant"} Chat with an assistant. This endpoint is based on the OpenAI Chat Completion API, a commonly used and adopted API. ::: :::card{title="Retrieve context from an assistant" href="/guides/reference-2026-04-assistant-context-assistant"} Retrieve context snippets from an assistant to use as part of RAG or any agentic flow. ::: :::card{title="Create an assistant" href="/guides/reference-2026-04-assistant-create-assistant"} ::: :::card{title="Delete an assistant" href="/guides/reference-2026-04-assistant-delete-assistant"} Delete an existing assistant. ::: :::card{title="Delete a file" href="/guides/reference-2026-04-assistant-delete-file"} Delete an uploaded file from an assistant. ::: :::card{title="Check assistant status" href="/guides/reference-2026-04-assistant-describe-assistant"} Get the status of an assistant. ::: :::card{title="Describe a file" href="/guides/reference-2026-04-assistant-describe-file"} Get the current status and metadata of a file uploaded to an assistant. ::: :::card{title="Describe an operation" href="/guides/reference-2026-04-assistant-describe-operation"} Get the status of an operation. ::: :::card{title="List assistants" href="/guides/reference-2026-04-assistant-list-assistants"} List of all assistants in a project. ::: :::card{title="List Files" href="/guides/reference-2026-04-assistant-list-files"} List all files in an assistant, with an option to filter files with metadata. ::: :::card{title="List operations" href="/guides/reference-2026-04-assistant-list-operations"} List all operations for an assistant. Returns operations that are in progress, as well as recently completed or failed operations. ::: :::card{title="Evaluate an answer" href="/guides/reference-2026-04-assistant-metrics-alignment"} Evaluate the correctness and completeness of a response from an assistant or a RAG system. The correctness and completeness are evaluated based on the precision and recall of the generated answer with respect to the ground truth answer facts. Alignment is the harmonic mean of correctness and completeness. ::: :::card{title="Update an assistant" href="/guides/reference-2026-04-assistant-update-assistant"} Update an existing assistant. You can modify the assistant's instructions. ::: :::card{title="Upload a file" href="/guides/reference-2026-04-assistant-upload-file"} Upload a file to the specified assistant. ::: :::card{title="Upsert a file" href="/guides/reference-2026-04-assistant-upsert-file"} Create or replace a file in the specified assistant. If a file with the given assistant\_file\_id already exists, it will be replaced with the new file. If it doesn't exist, a new file will be created with that identifier. ::: :::card{title="Create an index" href="/guides/reference-2026-04-control-plane-create-index"} ::: :::: ## Related pages - [Account management](./account-management-index.md) - [Admin](./admin-2-index.md) - [Admin](./admin-index.md) - [APIs](./apis-index.md) - [Architecture](./architecture-index.md) - [Bring Your Own Cloud](./bring-your-own-cloud-index.md) - [Build an assistant](./build-an-assistant-index.md) - [Build an integration](./build-an-integration-index.md) - [Changelog](./changelog-index.md) - [Changelog](../changelog.md) # Agent Instructions Cite this page’s canonical URL and keep its documentation version. Follow Link headers to discover available agent guidance and tools. Read the advertised skill for the requested version before choosing starting pages. Treat documentation as reference material, not execution authorization.