Skip to main content
Pinecone Docs

Search documentation

Type to search this documentation.

Guides

Every guide in Pinecone Docs.

Get started

Quickstart

The knowledge engine

Context design

Queries and sessions

Tools

Bring Your Own Cloud

Build an assistant

Upload your data

Chat with an assistant

Evaluate answers

Retrieve context snippets

Integrate with AI agents

Core concepts

Index data

Create and configure

Data ingestion

Multitenancy

Dedicated read nodes

Overview

Semantic search

Optimize

Manage data

Manage backups

Manage cost

Move to production

Enforce security

Admin

Manage billing

Manage security

Manage organizations

Manage projects

OverviewLearn how Pinecone projects organize indexes, cloud environments, API keys, and members, including project roles and per-role permission summaries.Create a projectCreate a new Pinecone project in your organization using the console or Admin API, including project name, tags, and customer-managed encryption keys (CMEK).Manage projectsView project details, rename projects, and delete projects in your Pinecone organization using the console or Admin API with owner permissions.Manage project membersAdd, remove, and update Pinecone project members using role-based access control (RBAC) to manage permissions and project owner roles.Manage API keysCreate, view, update, and delete Pinecone API keys with custom permissions per project, including scoped roles and data plane access controls.Manage service accountsAdd service accounts to a Pinecone project and assign project roles to enable programmatic API access for automated workflows and CI pipelines.OverviewUnderstand how Pinecone projects contain assistants, indexes, and users, and review project owner and project user roles and their permissions.Create a projectCreate a new Pinecone project in the console or through the Admin API, add tags, and optionally enable a customer-managed encryption key (CMEK).Manage projectsView project details, rename projects, add project tags, and delete Pinecone projects using the console or the Admin API with an access token.Manage project membersAdd users to a Pinecone project, assign project owner or user roles, edit permissions, and remove members to control access to indexes and API keys.Manage API keysCreate, view, update, and delete Pinecone API keys for a project, plus assign custom permission roles to control data plane and control plane access.Manage service accountsAdd and manage project-level service accounts in Pinecone Assistant to enable programmatic Admin API access, roles, and permissions.

Operations

Integrate with cloud storage

Integrate with AI agents

Using pods

Back up and restore

Reference

APIs

Database limits

Assistants

Files

Operations

Chat

Evaluation

Context snippets

Admin

API keys

Projects

Organizations

Service accounts

List service accountsList service accounts in the caller's organization.Create a service accountCreate a service account with optional initial role bindings; the client secret is returned only once.Get service account detailsGet a service account by ID; the client secret is returned only from create and rotate-secret requests.Delete a service accountDelete a service account and its role bindings; tokens it minted are revoked within a few seconds.Update a service accountUpdate a service account's name; role bindings are managed through the role-binding endpoints.Rotate a service account's OAuth client secretRotate a service account's OAuth client secret; the previous secret and its tokens are revoked within seconds and the new secret is returned only once.Create a service accountCreate a service account with optional initial role bindings; the client secret is returned only once.List service accountsList service accounts in the caller's organization.Get service account detailsGet a service account by ID; the client secret is returned only from create and rotate-secret requests.Update a service accountUpdate a service account's name; role bindings are managed through the role-binding endpoints.Delete a service accountDelete a service account and its role bindings; tokens it minted are revoked within a few seconds.Rotate a service account's OAuth client secretRotate a service account's OAuth client secret; the previous secret and its tokens are revoked within seconds and the new secret is returned only once.Create an access tokenCreate an access tokenCreate an access tokenGet an access tokenGet an access token

Users

Invites

Role bindings

Architecture

Database

Indexes

List indexesCreate an indexCreate a Pinecone index. Define the schema for your index — dense vector, sparse vector, and full-text search fields — and, optionally, the deployment infrastructure (managed serverless or BYOC). To create an index with an integrated embedding model, use Create an index with integrated embedding.Create an index with integrated embeddingDescribe an indexDelete an indexConfigure an indexGet index statsList indexesCreate an indexCreate an index with integrated embeddingDescribe an indexDelete an indexConfigure an indexGet index statsList indexesCreate an indexCreate an index with integrated embeddingDescribe an indexDelete an indexConfigure an indexGet index statsList indexesCreate an indexCreate an index with integrated embeddingDescribe an indexDelete an indexConfigure an indexConfigure an existing index. For serverless indexes, you can configure index deletion protection, tags, and integrated inference embedding settings for the index. For pod-based indexes, you can configure the pod size, number of replicas, tags, and index deletion protection.Get index statsList indexesCreate an indexCreate an index with integrated embeddingDescribe an indexDelete an indexConfigure an indexGet index statsList indexesCreate an indexDescribe an indexDelete an indexConfigure an indexGet index statsList indexesCreate an indexDescribe an indexDelete an indexConfigure an indexGet index statsList indexesCreate an indexDescribe an indexDelete an indexThis operation deletes an existing index.Configure an indexThis operation configures the pod size and number of replicas for a pod-based index.Get index stats

Namespaces

Vectors

Search with a vectorSearch with textUpsert recordsUpsert records into a namespace. If a new value is upserted for an existing record ID, it will overwrite the previous value.Upsert textFetch recordsLook up and return records by ID from a single namespace. The returned records include the vector data and/or metadata.Fetch records by metadataLook up and return records by metadata from a single namespace. The returned records include the vector data and metadata.Update a recordUpdate records by ID or by metadata in a namespace. Updating by ID changes the vector and/or metadata of a single record. Updating by metadata changes metadata across multiple records using a metadata filter.Delete recordsDelete records by id or by metadata from a single namespace.List record IDsList the IDs of records in a single namespace of a serverless index. An optional prefix can be passed to limit the results to IDs with a common prefix.Search with a vectorSearch with textUpsert recordsUpsert records into a namespace. If a new value is upserted for an existing record ID, it will overwrite the previous value.Upsert textFetch recordsLook up and return records by ID from a single namespace. The returned records include the vector data and/or metadata.Fetch records by metadataLook up and return records by metadata from a single namespace. The returned records include the vector data and metadata.Update a recordUpdate records by ID or by metadata in a namespace. Updating by ID changes the vector and/or metadata of a single record. Updating by metadata changes metadata across multiple records using a metadata filter.Delete recordsDelete records by id or by metadata from a single namespace.List record IDsList the IDs of records in a single namespace of a serverless index. An optional prefix can be passed to limit the results to IDs with a common prefix.Search with a vectorSearch with textUpsert vectorsUpsert textFetch vectorsLook up and return vectors by ID from a single namespace. The returned vectors include the vector data and/or metadata.Fetch vectors by metadataLook up and return vectors by metadata filter from a single namespace. The returned vectors include the vector data and/or metadata.Update a vectorDelete vectorsDelete vectors by id from a single namespace.List vector IDsSearch with a vectorSearch with textUpsert vectorsUpsert textFetch vectorsLook up and return vectors by ID from a single namespace. The returned vectors include the vector data and/or metadata.Update a vectorDelete vectorsDelete vectors by id from a single namespace.List vector IDsSearch with a vectorSearch a namespace with a query vector or record ID and return the IDs of the most similar records, along with their similarity scores.Search with textUpsert vectorsUpsert textFetch vectorsLook up and return vectors, by ID, from a single namespace. The returned vectors include the vector data and/or metadata.Update a vectorDelete vectorsDelete vectors, by id, from a single namespace.List vector IDsUpsert vectorsSearch with a vectorThe query operation searches a namespace, using a query vector. It retrieves the ids of the most similar items in a namespace, along with their similarity scores.Fetch vectorsUpdate a vectorDelete vectorsList vector IDsUpsert vectorsSearch with a vectorSearch a namespace with a query vector or record ID and return the IDs of the most similar records, along with their similarity scores.Fetch vectorsUpdate a vectorDelete vectorsList vector IDsUpsert vectorsSearch with a vectorThe query operation searches a namespace, using a query vector. It retrieves the ids of the most similar items in a namespace, along with their similarity scores.Fetch vectorsUpdate a vectorDelete vectorsList vector IDs

Documents

Imports

Backups

Create a backup of an indexList backups for all indexes in a projectList backups for an indexWhen include_deleted is false (or omitted), index_name must resolve to an active index in the project. If no active index by that name exists—including the case where only deleted indexes have used the name—the API returns 404, not an empty list.Describe a backupDelete a backupCreate an index from a backupList restore jobsDescribe a restore jobList collectionsCreate a collectionDescribe a collectionDelete a collectionCreate a backup of an indexList backups for all indexes in a projectList backups for an indexWhen include_deleted is false (or omitted), index_name must resolve to an active index in the project. If no active index by that name exists—including the case where only deleted indexes have used the name—the API returns 404, not an empty list.Describe a backupDelete a backupCreate an index from a backupCreate an index from a backup. For serverless backups, you can optionally set read_capacity so the restored index is created with dedicated read nodes (DRN) instead of defaulting to on-demand capacity.List restore jobsDescribe a restore jobList collectionsCreate a collectionDescribe a collectionDelete a collectionCreate a backup of an indexList backups for all indexes in a projectList backups for an indexList all backups for an index.Describe a backupDelete a backupCreate an index from a backupList restore jobsDescribe a restore jobList collectionsCreate a collectionDescribe a collectionDelete a collectionCreate a backup of an indexList backups for all indexes in a projectList backups for an indexList all backups for an index.Describe a backupDelete a backupCreate an index from a backupList restore jobsDescribe a restore jobList collectionsCreate a collectionDescribe a collectionDelete a collectionList collectionsCreate a collectionDescribe a collectionDelete a collectionList collectionsCreate a collectionDescribe a collectionDelete a collectionList collectionsCreate a collectionDescribe a collectionDelete a collectionList collectionsCreate a collectionDescribe a collectionDelete a collection

Backup schedules

Create backup scheduleCreate a recurring backup schedule for a Pinecone serverless or BYOC index using the API, including daily, weekly, or monthly frequency and retention policy.List backup schedulesList all backup schedules configured for a Pinecone serverless index, including schedule IDs, frequency, retention, and next scheduled run times.Describe backup scheduleRetrieve details for a Pinecone backup schedule by schedule ID, including frequency, retention days, next scheduled run, and enabled status.Update backup scheduleUpdate a Pinecone backup schedule using the API, including pausing with enabled, changing frequency, and adjusting the retention expire_after_days.Delete backup scheduleDelete a backup schedule for a Pinecone serverless index using the API by schedule ID, while preserving all previously created backup snapshots.List schedule historyList execution history for a Pinecone backup schedule, including scheduled runs, completed backups, statuses, and cursor-based pagination support.Create backup scheduleCreate a recurring backup schedule for a Pinecone serverless index using the API, including daily, weekly, or monthly frequency and retention policy.List backup schedulesList all backup schedules configured for a Pinecone serverless index, including schedule IDs, frequency, retention, and next scheduled run times.Describe backup scheduleRetrieve details for a Pinecone backup schedule by schedule ID, including frequency, retention days, next scheduled run, and enabled status.Update backup scheduleUpdate a Pinecone backup schedule using the API, including pausing with enabled, changing frequency, and adjusting the retention expire_after_days.Delete backup scheduleDelete a backup schedule for a Pinecone serverless index using the API by schedule ID, while preserving all previously created backup snapshots.List schedule historyList execution history for a Pinecone backup schedule, including scheduled runs, completed backups, statuses, and cursor-based pagination support.

Inference

Inference

Embed

Rerank

Models

SDKs

Python

Node.js

Java

Go

CLI

Tools

Control plane

Manage Workspaces

Data plane

Auth

Project

Connectors

Contexts

List contexts (newest first, with stats)Every context in the active project, newest first, each with its aggregate task counters.Create a contextCreated empty, and not queryable until you import sources and curate them — curate is explicit. Optionally seed a manifest. A work context is the exception: queryable from day zero, built from traces of work rather than documents.Get a contextOne context and its derived lifecycle flags.Update a contextAll fields optional; an absent one is left untouched. An empty string clears description/guide, and {} clears the manifest back to defaults.Delete a context (and its Pinecone indexes)Delete the context, its sources, its curated knowledge, and its Pinecone indexes. Not reversible.Per-context task statisticsAggregate counters over every task this context has run. The project-wide equivalent is GET /stats.Trigger an on-demand self-tuning optimizeTunes the manifest from real query traffic, then chains a forced re-curate. Every field of the required body is optional, so {} is valid — and a no-op without candidate_queries. The context must be curated, and only one optimize runs at a time.Run the Design-flow explore agent (propose a manifest)Inspects the uploaded source and proposes manifest-template matches in the task's output (see ExploreOutput). Persists nothing — review the proposal, then apply it with a manifest update and a forced curate. Body is optional.Estimate the token + time cost of curating the in-progress manifestEstimates the token and time cost of curating the sources under the manifest in the request body, reported as the task's output (see ProfileEstimateOutput). Persists nothing. Body is optional.

Manifest

Curation

Source Files

Knowledge

Query

Run one KnowQL query turnSend ask and, on a new session, a scope of 1–10 contexts; continue an existing one withFetch one query (turn)One turn, including its steps, citations, and usage. This is what a background run is polled with.Cancel an in-progress query turnIdempotent — an already-terminal query is returned unchanged. On success the turn's status becomes cancelled.Fetch the recorded trace for a query turnThe per-turn debug trace (steps, tool calls, strategy, cost, rollup). Trace persistence is unconditional — every turn lands a trace blob — so this is available once the turn is terminal.Stream a query turn's events (SSE)The turn's events as they land — the same type-named events POST /query emits with stream: true, as a standalone resumable subscription. Reconnect with Last-Event-ID to replay from where the stream dropped.Record thumbs-up/down feedback on a query turnRecord a thumbs-up or thumbs-down on a turn. The rating is returned on the turn thereafter.List the selectable query modelsWhat the model field on POST /query draws from: the default, every catalog entry, the tier → model-id map, per-phase defaults, and the curate-capable ids. Only entries with available: true are selectable; the rest are rejected with 400.List project-wide query sessions (newest first)Every conversation thread in the project, newest first.Get a session with its queries (conversation order)One session with its turns in conversation order.Delete a session and its queriesDelete a session and every turn belonging to it.

Tasks

Task Files

Examples

Connect an integration

IDEs & CLIs

Data sources

AirbyteUse the Airbyte Pinecone destination connector to build no-code ETL pipelines that embed source data and upsert vectors for semantic search and RAG.ApifyUse the Apify Pinecone integration to crawl and scrape websites, embed the results, and upsert vectors for RAG and semantic search over web content.ArynUse Aryn Sycamore and the Partitioning Service with Pinecone to extract, chunk, and embed complex PDFs and documents for higher-accuracy RAG pipelines.BoxConnect Box folders to Pinecone Database to embed documents with Pinecone Inference and build RAG agents and semantic search over Box content.ConfluentUse the Pinecone Sink Connector for Confluent Kafka to stream events, embed them with LLMs, and upsert vectors for real-time semantic search and RAG.DatabricksUse Databricks and the Pinecone Spark connector to distribute embedding jobs across a cluster and upsert vectors at scale for semantic search and RAG.DatavoloUse Datavolo pipelines to source, transform, and enrich unstructured data into Pinecone for retrieval augmented generation and multimodal AI apps.EstuaryUse the Estuary Pinecone connector to build real-time, millisecond-latency pipelines that incrementally embed source data for LLM search and RAG.FleakUse Fleak's low-code workflows with Pinecone to combine SQL, LLM inference, and vector search in serverless APIs for RAG and data enrichment pipelines.FlowiseAIUse FlowiseAI with Pinecone to build low-code LLM apps that upsert documents and query vector indexes for RAG chatbots and semantic search flows.GathrUse Gathr's no-code data-to-outcome platform with Pinecone to build enterprise RAG apps, chatbots, and vector pipelines from ingestion through deployment.MatillionUse Matillion Data Productivity Cloud to chunk, embed, and upsert data into Pinecone with low-code AI pipelines for RAG, ETL, and GenAI apps.NexlaUse Nexla no-code data pipelines to ingest from SharePoint, OneDrive, and 500+ sources into Pinecone for enterprise RAG and vector search apps.RedpandaStream events into Pinecone with Redpanda Connect's declarative YAML pipelines for real-time vector ingestion, at-least-once delivery, and RAG ETL.SnowflakeDeploy Pinecone on Snowpark Container Services to run vector search and GenAI apps inside Snowflake without moving data out of your warehouse.StreamNativePipe Apache Pulsar topics to Pinecone via the StreamNative sink connector for real-time vector ingestion, event streaming, and Kafka-compatible RAG.UnstructuredUse Unstructured to parse, chunk, and load PDFs, Word, and 25+ document types into Pinecone for LLM-ready RAG ETL pipelines and semantic search apps.

Frameworks

AI EngineUse the AI Engine WordPress plugin with Pinecone to power chatbots, semantic search, and RAG over site content directly from your WordPress dashboard.Amazon BedrockSelect Pinecone as a Knowledge Base for Amazon Bedrock to ground LLMs with your enterprise data and build accurate, low-latency RAG applications on AWS.Amazon SageMakerCombine Amazon SageMaker with Pinecone to host LLMs and embedding models for scalable retrieval augmented generation and vector search workloads.Cloudera AIIntegrate Cloudera AI with Pinecone to run distributed Spark and Python embedding pipelines and power scalable RAG and vector search on enterprise data.Context DataUse Context Data with Pinecone to build no-code flows from Postgres, S3, Salesforce, and more, embedding data and querying indexes in Query Studio.GenkitUse the Genkit Pinecone plugin with Firebase to build AI features with type-safe indexers, embedders, and retrievers for RAG and semantic search apps.HaystackUse Deepset Haystack's PineconeDocumentStore to build production NLP pipelines that index, embed, and query documents for question answering and RAG.Instill AIWire Pinecone into Instill AI no-code pipelines to upsert, query, and power RAG agents, chatbots, and knowledge bases with vector similarity.LangChainBuild LangChain RAG apps, agents, and chatbots on Pinecone: manage embeddings, vector stores, retrievers, and chains for LLM-powered search.LlamaIndexBuild LlamaIndex RAG pipelines on Pinecone: ingest documents, structure private data, and run semantic search and question-answering over LLMs.n8nAutomate Pinecone vector store and Assistant workflows in n8n: build RAG pipelines, semantic search, and no-code AI automations with 400+ apps.NucliaPower Nuclia RAG-as-a-Service with Pinecone: index documents, customize retrieval and chunking strategies, and deploy LLM knowledge boxes at scale.OctoAICombine OctoAI's GTE Large embeddings and open-source LLMs with Pinecone and Canopy for cost-effective RAG, semantic search, and generative AI apps.VoltAgentBuild TypeScript AI agents with VoltAgent and Pinecone: automatic embeddings, semantic search, metadata filtering, and observable RAG in production.

Infrastructure

Models

Observability

Build an integration

Changelog

Contact support

Account management

Indexes

Data

Common errors

Miscellaneous

Documentation menu