Set the Pinecone CLI target context with pc target to control which organization and project your commands run against, including in CI/CD and JSON mode.
The CLI’s target context determines which organization and project your commands operate on. You must authenticate before setting target context.
Via CLI command: After pc auth configure --client-id --client-secret, the CLI auto-targets the service account’s organization. For the project:
If one project exists, it’s auto-targeted
If multiple exist, you’re prompted (or use --project-id)
If none exist, create one and target it manually
Via environment variables: If using PINECONE_CLIENT_ID and PINECONE_CLIENT_SECRET without running pc auth configure, no target context is set automatically. Run pc target to set it.
# Change project (org is fixed to the service account's org)pc target -p "my-project"# Or select interactivelypc target
When using an API key, control plane and data plane operations use the key’s org/project scope, not the CLI’s stored target context. The pc target --show output does not reflect what these operations actually use.
API keys are scoped to a specific org and project and can’t access resources outside that scope.Admin API operations still use your user login or service account credentials (API keys can’t authenticate Admin API calls).
Running pc target --json with no targeting flags returns the current target context as a JSON object. This is a local-state read — no authentication is required:
pc target --json
In non-TTY environments (CI/CD pipelines, shell pipes, scripts), JSON output is automatic — the same as passing --json explicitly. You don’t need to add the flag in automation contexts.Use --organization-id and --project-id (instead of name flags) to set context reliably in scripts, since IDs are stable and unaffected by renames:
pc target --organization-id "org-abc123" --project-id "proj-xyz789" --json
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Pinecone Docs","description":"Official documentation for Pinecone's trusted AI knowledge platform, including Pinecone Database, Pinecone Assistant, and Pinecone Nexus.","colors":{"primary":"#002BFF","light":"#1E86EE","dark":"#002BFF"},"logo":{"light":"https://mintcdn.com/pinecone/HsZKO51bNmpAasdT/logo/Pinecone-Full-Logo-Black.svg?fit=max\u0026auto=format\u0026n=HsZKO51bNmpAasdT\u0026q=85\u0026s=211d0e7bbefc29ce3b8feee1a05d76ee","dark":"https://mintcdn.com/pinecone/HsZKO51bNmpAasdT/logo/Pinecone-Full-Logo-White.svg?fit=max\u0026auto=format\u0026n=HsZKO51bNmpAasdT\u0026q=85\u0026s=4839c7a50a8bee830e943705c648297c","href":"https://www.pinecone.io"},"favicon":"https://mintcdn.com/pinecone/9qvQp5nU6duJvusQ/favicon-512.png?fit=max\u0026auto=format\u0026n=9qvQp5nU6duJvusQ\u0026q=85\u0026s=a05db290834f742b6b4b5d30a8d74e90","api":{"openapi":["https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_control_2026-07.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_control_2026-07.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/inference_2026-07.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/assistant_control_2026-07.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/assistant_data_2026-07.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/assistant_evaluation_2026-07.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-01.alpha/db_control_2026-01.alpha.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-01.alpha/db_data_2026-01.alpha.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/assistant_control_2026-04.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/assistant_data_2026-04.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/assistant_evaluation_2026-04.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/oauth_2026-04.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_control_2026-04.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_data_2026-04.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/inference_2026-04.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/admin_2025-10.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/oauth_2025-10.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/assistant_control_2025-10.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/assistant_data_2025-10.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/assistant_evaluation_2025-10.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/db_control_2025-10.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/db_data_2025-10.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/inference_2025-10.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/admin_2025-04.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/oauth_2025-04.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/assistant_control_2025-04.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/assistant_data_2025-04.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/assistant_evaluation_2025-04.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/db_control_2025-04.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/db_data_2025-04.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/inference_2025-04.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-01/assistant_control_2025-01.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-01/assistant_data_2025-01.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-01/assistant_evaluation_2025-01.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-01/db_control_2025-01.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-01/db_data_2025-01.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-01/inference_2025-01.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-10/db_control_2024-10.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-10/db_data_2024-10.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-10/inference_2024-10.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-07/control_2024-07.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-07/data_2024-07.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-04/control_2024-04.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-04/data_2024-04.oas.yaml"],"playground":{"display":"simple"}},"appearance":{"default":"system","strict":false},"background":{"color":{"light":"#FBFBFC","dark":"#171717"}},"navbar":{"links":[{"href":"/guides/get-started/overview","label":"Docs"},{"href":"https://status.pinecone.io","label":"Status"},{"href":"https://app.pinecone.io/organizations/-/settings/support","label":"Support"},{"href":"https://app.pinecone.io/?sessionType=login","label":"Log in"}],"primary":{"type":"button","label":"Sign up free","href":"https://app.pinecone.io/?sessionType=signup"}},"footer":{"socials":{"x":"https://x.com/pinecone?ref_src=twsrc%5Egoogle%7Ctwcamp%5Eserp%7Ctwgr%5Eauthor","linkedin":"https://www.linkedin.com/company/pinecone-io","youtube":"https://www.youtube.com/@pinecone-io","github":"https://github.com/pinecone-io"}},"seo":{"metatags":{"og:image":"https://www.pinecone.io/images/docs_og_image_v2.png","twitter:title":"Documentation for the trusted AI knowledge platform | Pinecone","twitter:description":"Guides, API references, and examples for building with Pinecone Database, Pinecone Assistant, and Pinecone Nexus.","twitter:site":"@pinecone","twitter:image":"https://www.pinecone.io/images/docs_og_image_v2.png","google-site-verification":"woTBImNAcYO-gseVfFKIzQrDRUmLWzFjBWrYbYkOTlI"},"indexing":"all"},"integrations":{"gtm":{"tagId":"GTM-5RCSPVG"},"heap":{"appId":"3879495182"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"pinecone","hasAudioNarration":false,"actualSubdomain":"pinecone","customDomains":["docs.pinecone.io"],"gitSource":{"type":"github","owner":"pinecone-io","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae2801326492b16b5e5b7eb","collectionId":"0f967274-19ea-45fd-8f4d-24ce1910d633","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae2801326492b16b5e5b7eb"},"feedback":{"thumbs":true,"issues":false,"edits":false},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae39e9dfc2cadfaa690bd0f","clientVersion":"0.0.4021","searchFilterCounts":[{"language":"default","tag":"Pinecone Database","count":551},{"language":"default","tag":"Reference","count":541},{"language":"default","tag":"Database","count":240},{"language":"default","tag":"Admin","count":151},{"language":"default","tag":"Guides","count":133},{"language":"default","tag":"Pinecone Assistant","count":127},{"language":"default","tag":"Pinecone Nexus","count":78},{"language":"default","tag":"Backups","count":70},{"language":"default","tag":"Indexes","count":64},{"language":"default","tag":"Integrations","count":56}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"styles.css","content":"@keyframes shimmer{0%{transform:translateX(-100%)}to{transform:translateX(100%)}}:root{--brand-blue:#002BFF;--primary-main:#002BFF;--primary-dark:#222160;--text-contrast:#FFFFFF;--background:#FBFBFC;--paper:#FFFFFF;--surface:#F2F3F6;--divider:#D8DDDF;--secondary:#72788D;--text-primary:#1C1917;--text-body:#44403C;--text-secondary:#72788D;--border:#e7e5e4}.dark{--brand-blue:#1E86EE;--primary-main:#002BFF;--primary-dark:#222160;--text-contrast:#FFFFFF;--background:#171717;--paper:#1E1E1E;--surface:#252525;--divider:#2A2A2A;--secondary:#72788D;--text-primary:#FFFFFF;--text-body:#D4D4D4;--text-secondary:#A0A0A0;--border:#303030}.dark .dark-inverted{filter:invert(1)}#topbar-cta-button{margin-left:1rem}#topbar-cta-button>a{display:flex;align-items:center;padding:.375rem 1rem!important;gap:.5rem;background-color:var(--brand-blue);color:var(--text-contrast)!important;border-radius:.25rem;font-weight:500;letter-spacing:.4px}#topbar-cta-button a:hover{background-color:var(--primary-dark)!important}.documentation-link{color:var(--brand-blue);text-decoration:none}.documentation-link:hover{color:#000}#navbar{background:var(--background);position:fixed}#navbar-transition{border-bottom:1px solid var(--border)}#navbar .max-w-8xl{max-width:100%}#navbar>div>div>div>div>div>div.flex-1.flex.items-center>a:first-child{min-width:209px}[aria-haspopup=menu]{border-radius:.25rem;border:1px solid var(--border);background-color:transparent!important;color:var(--text-primary)}#navbar nav a{color:var(--text-primary);padding:.6rem 1rem;transition:background-color 250ms cubic-bezier(.4,0,.2,1)}#navbar nav ul li:not(:last-of-type){margin-left:0}#navbar a{margin:0;padding-left:.875rem;padding-right:.875rem}#navbar .nav-tabs{gap:0!important}#navbar div.absolute.bottom-0{display:none}#sidebar{left:0;padding-left:0;background:var(--background);border-right:1px solid var(--border)}#sidebar div.sticky{visibility:hidden}#sidebar-content{padding-left:.5rem}@media (min-width:1024px){:root{--sidebar-width:17.5rem}div:has(>#sidebar){max-width:none;margin-left:0;padding-left:0}#navbar .lg\\:px-12{padding-left:.625rem}#navbar div:has(>.nav-tabs){padding-left:1.5rem}#sidebar-content .sidebar-group a,#sidebar-content .sidebar-group button{padding-block:.3125rem;line-height:1.25rem}#sidebar-content .sidebar-group-header{margin-bottom:.5rem}#navigation-items>div:has(>.sidebar-group-header){margin-top:1.25rem}#content-container>div{justify-content:flex-end}#content-area{max-width:54rem;margin-inline:0;padding-left:3.125rem}div:has(>#sidebar[style*=\"display: none\"]) #content-area{max-width:none}}@media (min-width:1280px){#content-area:has(.sample-app-split){max-width:77.625rem}}#pc-sidebar-toggle{display:none}@media (min-width:1024px){#pc-sidebar-toggle:not([hidden]){position:absolute;z-index:30;top:.5625rem;right:-2rem;display:flex;align-items:center;justify-content:center;width:1.75rem;height:1.75rem;color:var(--text-secondary);cursor:pointer}#pc-sidebar-toggle:hover{color:var(--text-primary)}#pc-sidebar-toggle:focus-visible{outline:2px solid var(--brand-blue);outline-offset:2px;border-radius:.25rem}#sidebar #navigation-items{position:relative}#sidebar-content>[data-component-part=scroll-area-scrollbar][data-orientation=vertical]{margin-top:4.5rem}#sidebar .nav-dropdown-trigger{width:calc(100% - .75rem)}.pc-sidebar-collapsed #sidebar{width:3rem;overflow:hidden}.pc-sidebar-collapsed #sidebar>*{visibility:hidden}.pc-sidebar-collapsed #pc-sidebar-toggle:not([hidden]){position:fixed;left:1.1875rem;right:auto}}#header h1,#navbar a,#sidebar a,#sidebar li div,#sidebar-content h5,.prose h2,.prose h3,.prose h4{color:var(--text-primary)}#navigation-items .sidebar-group-header{color:var(--text-secondary);font-size:.75rem;font-weight:600;letter-spacing:1px;line-height:160%;text-transform:uppercase}#navigation-items>div+div>.sidebar-group-header{padding-top:1.25rem;border-top:1px solid var(--border)}#navigation-items .sidebar-group-header:has(+.sidebar-group li[data-active=true]){color:var(--text-primary)}#navigation-items .sidebar-group li>button{flex-direction:row-reverse;justify-content:flex-end;column-gap:.375rem;font-weight:500}#navigation-items .sidebar-group li>button>div:last-child{margin-left:-.75rem}#navigation-items .sidebar-group li>button svg{color:var(--text-secondary)}#navigation-items .sidebar-group li>ul,#table-of-contents .toc-item>ul{position:relative}#navigation-items .sidebar-group li>ul::before,#table-of-contents .toc-item>ul::before{content:\"\";position:absolute;top:0;bottom:0;left:1rem;border-left:1px solid var(--border)}#table-of-contents .toc-item>ul::before{left:.25rem}#navigation-items>div>ul>li{margin-left:.75rem}#navigation-items>div>ul>li a.font-semibold{font-weight:400;background-color:var(--surface)}#content-container>div{padding-top:10rem}#content-area>#content:first-child{margin-top:0}@media (min-width:1024px){#content-container>div{gap:3rem}#content-container #table-of-contents{padding-left:0}}#header .eyebrow,.sample-app-heading .eyebrow{text-transform:uppercase;color:var(--text-primary);font-size:.625rem;letter-spacing:1px;line-height:160%}#header .eyebrow:empty{display:none}#header>div:first-of-type>div:nth-of-type(2){margin-top:0}.prose [data-as=p],.prose li,.prose p{color:var(--text-body)}.prose table td,.prose table th{color:var(--text-body)!important}.prose a{color:var(--brand-blue)!important;font-weight:400}.card{box-shadow:none;border:1px solid var(--border)!important;border-radius:.25rem;transition:box-shadow .3s ease;background-color:var(--paper)!important}.card:hover,.example-card:hover,.model-card:hover{box-shadow:0 5px 5px -3px rgba(163,169,175,.2),0 8px 10px 1px rgba(163,169,175,.14),0 3px 14px 2px rgba(163,169,175,.12)!important}.dark .card:hover,.dark .example-card:hover,.dark .model-card:hover{box-shadow:none!important}.card>div{padding:1.5rem}.card .integration-title,.card h2,.example-card h2{font-size:1.25rem}.card .integration-title{font-weight:600;line-height:1.5rem;margin-bottom:.833rem;color:var(--text-primary)}.card p,.example-card p,.example-card span[data-as=p]{margin-top:.625rem;font-size:.875rem;color:var(--text-primary)}.card .integration-logo,.card .integration-logo-long{width:3.125rem;height:3.125rem;display:flex;justify-content:center;align-items:center}.card .integration-logo-long{width:5.125rem}.card-grid{display:grid;gap:1.5rem}@media (min-width:640px){.card-grid{grid-template-columns:1fr 1fr}}@media (min-width:1024px){.card-grid{grid-template-columns:1fr 1fr 1fr}}#related-articles,.example-card{display:flex;flex-direction:column}.example-card{box-shadow:none;border:1px solid var(--border);border-radius:.25rem;transition:box-shadow .3s ease;padding:1.5rem;flex-grow:1;background-color:var(--paper)}.example-card .arrow{margin-left:auto;margin-top:auto;opacity:0;transition:opacity .3s ease}.example-card:hover .arrow{opacity:1}.example-card:hover{border:1px solid var(--border)!important}.example-card .tags{display:flex;flex-wrap:wrap;gap:.75rem;margin-top:1.5rem}.example-card .card-tag{border-radius:1rem;background-color:var(--background);color:var(--text-primary);font-size:.8125rem;line-height:138%;letter-spacing:.16px;padding:.1875rem .375rem;display:flex;gap:.375rem;align-items:center}.examples-h2{font-size:1.25rem;margin-bottom:1.5rem}#related-articles{width:100%}#related-articles a,#related-articles h2{color:var(--text-primary);line-height:150%;letter-spacing:.15px}#related-articles h2{font-size:1.25rem;font-weight:600;margin-bottom:1rem}#related-articles a{padding:1.0625rem 0;display:flex;align-items:flex-start;justify-content:space-between;gap:1rem;font-size:.875rem}#related-articles a:not(:last-of-type){border-bottom:1px solid var(--border)}#back-button:hover,#related-articles a:hover{opacity:.7}#back-button>svg,#related-articles a>svg{flex-shrink:0}#back-button{display:flex;gap:.5rem;align-items:center;color:var(--text-primary)!important;font-size:.875rem;margin-bottom:1.5rem}.sample-app-heading{display:flex;flex-direction:column;align-items:center;text-align:center}.sample-app-heading h1,.sample-app-heading p{color:var(--text-primary);margin:.5rem 0 0;font-size:2.125rem;font-weight:600;line-height:123.5%;letter-spacing:.25px}#back-button,.sample-app-heading p{line-height:150%;letter-spacing:.15px}.sample-app-heading p{margin:.5rem 0 1.5rem;font-size:1.25rem}.sample-app-split{display:flex;flex-direction:column;gap:3rem}.sample-app-split .sidebar a:not(.connect-with-pinecone){font-size:.875rem;color:var(--text-primary)!important;border-bottom:none}.sample-app-split .toc-list{display:flex;flex-direction:column;gap:1rem}.sample-app-split .toc-list a.bold{font-weight:700;margin-top:.5rem}.sample-app-split .toc-list a:not(.bold,.connect-with-pinecone){position:relative;padding-left:1rem}.sample-app-split .toc-list a:not(.bold,.connect-with-pinecone)::before{content:\"\";position:absolute;top:0;bottom:0;left:.25rem;border-left:1px solid var(--border)}.sample-app-split .toc-list a:not(.bold,.connect-with-pinecone)+a:not(.bold)::before{top:-1rem}.connect-with-pinecone{border:1px solid var(--border);border-radius:.25rem;padding:.5rem 1rem;display:inline-flex;align-items:center;gap:.5rem;font-size:.875rem;font-weight:500;line-height:1.5rem;letter-spacing:.4px;color:var(--text-primary)!important;text-decoration:none;align-self:flex-start}@media (min-width:1280px){.sample-app-split{flex-direction:row}.sample-app-split :is(.content, .mint-content){overflow-x:auto}.sample-app-split .sidebar{width:20.625rem;flex-shrink:0}}p>code{font-size:.75rem;line-height:150%;letter-spacing:.5px;border-radius:.25rem;padding:.125rem .5rem;background-color:var(--paper)!important;border:0}code .api-key.set{color:orange}.pinecone-connect-connected{width:100%;max-width:31.25rem;background-color:var(--paper);transition:box-shadow 300ms cubic-bezier(.4,0,.2,1) 0ms;border-radius:.25rem;padding:1.5rem;margin:1.5rem 0;border:1px solid var(--border)}.pinecone-connect-connected img{height:1.875rem;margin:0}.pinecone-connect-connected p,p>code{color:var(--text-primary)!important}.pinecone-connect-connected p:last-of-type{margin-top:.75rem}.remove-api-key{display:flex;width:100%;max-width:31.25rem;margin-top:-1.25rem}.remove-api-key>button{font-size:.8125rem;font-weight:500;color:var(--brand-blue);margin-left:auto}.connect-widget-skeleton{margin-block:45px;width:100%;max-width:31.25rem;height:180px;background:var(--paper);border-radius:4px;overflow:hidden;position:relative;border:1px solid var(--border)}.skeleton-content{width:100%;max-width:450px;height:180px;background:linear-gradient(90deg,rgba(255,255,255,0) 0,rgba(255,255,255,.6) 50%,rgba(255,255,255,0) 100%);animation:shimmer 1.5s infinite;position:absolute;top:0;left:0}.not-prose:has(.outlined-button)>span{line-height:1.25}.not-prose:has(.outlined-button)>div{margin-top:.25rem;margin-bottom:0!important;padding-right:1rem}.model-card p{margin:0}.featured-card-container{padding:0 1rem;position:relative;width:100%;margin:1rem 0;overflow:visible;-webkit-overflow-scrolling:touch}.featured-model-cards{display:grid;grid-auto-flow:column;grid-auto-columns:calc(25% - .75rem);gap:1rem;overflow-x:auto;scroll-behavior:smooth;scroll-snap-type:x mandatory;-webkit-overflow-scrolling:touch;padding:1rem 0;margin:-1rem 0;scrollbar-width:none;-ms-overflow-style:none;cursor:grab}.featured-model-cards>*{scroll-snap-align:start}.carousel-button{position:absolute;top:50%;transform:translateY(-50%);width:2.5rem;height:2.5rem;border-radius:9999px;background:var(--paper);box-shadow:0 4px 6px -1px rgb(0 0 0/.1);display:flex;align-items:center;justify-content:center;z-index:10;cursor:pointer;border:1px solid var(--border);padding:0}.carousel-button:hover{background-color:var(--background);transform:translateY(-50%) scale(1.05);box-shadow:0 6px 8px -2px rgb(0 0 0/.15)}.carousel-button.prev{left:-1.25rem}.carousel-button.next{right:-1.25rem}#content-area,#content-container,main{overflow:visible!important}@media (max-width:1280px){.featured-model-cards{grid-auto-columns:calc(33.333% - .67rem)}}@media (max-width:1024px){.featured-model-cards{grid-auto-columns:calc(50% - .5rem)}}@media (max-width:768px){.featured-model-cards{grid-auto-columns:90%;padding-bottom:1rem;align-items:start}.carousel-button{display:none!important}.featured-card-container{padding:0}}.model-page-tabs>button,.outlined-button{display:flex;align-items:center;font-weight:500}.outlined-button{flex-direction:column;justify-content:center;width:176px;height:40px;padding:4px;border-radius:4px;border:1px solid var(--border);text-decoration:none;font-size:15px;text-align:center;color:var(--text-primary);transition:background-color .3s ease,border .3s ease,color .3s ease}.outlined-button:hover{background-color:var(--paper);border:1px solid var(--brand-blue);color:var(--text-primary)}.model-page-card{padding:1.5rem;border-radius:.25rem;border:1px solid var(--border);background:var(--paper);margin-bottom:2.5rem}.model-page-card-title{display:flex;flex-wrap:wrap;gap:1rem;align-items:center}.model-page-card-title>h1{font-size:1.5rem;color:var(--text-primary)}.model-page-card-logo{width:2.125rem;height:2.125rem;flex-shrink:0}.model-page-card-logo>img{width:100%;height:100%;object-fit:contain}.model-page-card-inference{border-radius:1rem;border:1px solid var(--border);padding:.25rem .375rem .25rem .25rem;display:flex;align-items:center;gap:.375rem;font-size:.8125rem}.model-page-card-stats{display:flex;gap:1.5rem;flex-wrap:wrap;margin-top:1rem}.model-page-card-stats>div>span{font-size:.625rem;color:var(--text-secondary);letter-spacing:.2px;font-weight:500}.model-page-card-stats>div>p,.model-page-card-stats>div>span[data-as=p]{display:block;font-size:.75rem;color:var(--text-primary);letter-spacing:.17px}.model-page-card-stats>div.price{margin-left:auto}.model-page-card-stats>div.price>p{margin-left:auto;font-weight:600}.model-page-tabs{display:flex;width:100%;border-bottom:1px solid var(--border);margin-bottom:2rem}.model-page-tabs>button{padding:.5625rem 1rem;border-bottom:1px solid transparent;color:var(--secondary);gap:.375rem;letter-spacing:.4px}.model-page-tabs>button>svg>path{fill:var(--secondary)}.model-page-tabs>button.active{border-bottom:2px solid var(--brand-blue);color:var(--brand-blue)}.model-page-tabs>button.active>svg>path{fill:var(--brand-blue)}.model-page-playground{display:none}.model-page-guides{display:flex;flex-direction:column;gap:3rem}.model-page-content{flex-shrink:1;width:auto;max-width:1050px}.model-page-content>:first-child{margin-top:0}.model-page-content pre{white-space:pre-wrap}.model-page-sidebar{width:100%;flex-shrink:1}.model-page-sidebar .iframe-placeholder{height:800px}@media (min-width:1280px){.model-search-container{padding-inline:0}}.model-search-container{container-type:inline-size}#model-search-iframe{min-height:1220px}@container (min-width: 960px){#model-search-iframe{min-height:920px}}@media (min-width:1080px){.model-page-guides{flex-direction:row}.model-page-sidebar{max-width:20.6875rem;flex-shrink:0}}.featured-model-cards::-webkit-scrollbar{display:none}.featured-model-cards:active{cursor:grabbing}.featured-model-cards .example-card button,.featured-model-cards .model-card button{min-width:200px;width:100%;max-width:400px;margin:0 auto}#pinecone-connect-widget iframe{width:100%!important;max-width:500px!important}@media (max-width:576px){#pinecone-connect-widget{scale:.95!important;transform-origin:top left}.connect-widget-skeleton{height:180px;margin-block:30px}.skeleton-content{height:180px}#pinecone-connect-widget,#pinecone-connect-widget iframe,#pinecone-connect-widget>div{width:100%!important;min-width:0!important;max-width:100%!important}div[style*=min-width]{min-width:0!important;width:100%!important}}#page-context-menu-button{border-start-start-radius:.25rem!important;border-end-start-radius:.25rem!important}#page-context-menu button:last-child{border-radius:0!important;border-start-end-radius:.25rem!important;border-end-end-radius:.25rem!important}.agent-tool{border-left:4px solid var(--brand-blue, #002BFF);padding:1rem 1.25rem;border-radius:.375rem;background-color:#f0f4ff;margin:.5rem 0 1rem}.agent-tool>p:first-child{margin-top:0;font-size:.875rem;letter-spacing:.025em}.dark .agent-tool{background-color:rgba(0,43,255,.08);border-left-color:#4d6fff}#changelog-filters{display:none!important}#pc-cl-filters{margin-top:1.5rem;padding-top:1.25rem;border-top:1px solid var(--divider);display:flex;flex-direction:column;gap:.5rem}.pc-cl-heading{margin:0 0 .25rem;font-size:.8125rem;font-weight:600;color:var(--text-primary)}.pc-cl-search{width:100%;padding:.375rem .625rem;font-size:.8125rem;line-height:1.5;color:inherit;background-color:transparent;border:1px solid var(--divider);border-radius:.5rem;appearance:none}.pc-cl-search::placeholder{color:var(--text-secondary)}.pc-cl-search:focus{outline:0;border-color:var(--brand-blue)}.pc-cl-dd-toggle{width:100%;display:flex;align-items:center;justify-content:space-between;gap:.5rem;padding:.375rem .625rem;font-size:.8125rem;line-height:1.5;text-align:left;color:inherit;cursor:pointer;background-color:transparent;border:1px solid var(--divider);border-radius:.5rem}.pc-cl-dd-menu button:hover,.pc-cl-dd-toggle:hover{background-color:var(--surface)}.pc-cl-dd.is-active .pc-cl-dd-toggle{border-color:var(--brand-blue);font-weight:500}.pc-cl-dd-caret{flex:none;width:.75rem;height:.75rem;opacity:.6}.pc-cl-dd-toggle[aria-expanded=true] .pc-cl-dd-caret{transform:rotate(180deg)}.pc-cl-dd-menu{position:fixed;z-index:50;margin:0;padding:.25rem;overflow-y:auto;list-style:none;background-color:var(--paper);border:1px solid var(--divider);border-radius:.5rem;box-shadow:0 8px 24px rgba(0,0,0,.08)}.dark .pc-cl-dd-menu{box-shadow:0 8px 24px rgba(0,0,0,.4)}.pc-cl-dd-menu li{margin:0;padding:0;list-style:none}.pc-cl-dd-menu li::before,.pc-cl-dd-menu li::marker{content:none;display:none}.pc-cl-clear,.pc-cl-dd-menu button{font-size:.8125rem;cursor:pointer;border:0}.pc-cl-dd-menu button{width:100%;padding:.3125rem .5rem;line-height:1.4;text-align:left;color:inherit;background-color:transparent;border-radius:.375rem}.pc-cl-clear{align-self:flex-start;padding:0;color:var(--brand-blue);background:0 0}.pc-cl-clear:hover{text-decoration:underline}.pc-cl-count{margin:0;font-size:.75rem}.pc-cl-count,.pc-cl-empty{color:var(--text-secondary)}[class*=flex-wrap][class*=gap-2][class*=text-secondary]>span[class*=rounded-lg][class*=font-medium]{padding:.1875rem .625rem;border-radius:9999px;border:1px solid var(--divider);background:0 0}"}],"page":{"pagePath":"reference/cli/target-context","slug":"/reference/cli/target-context","pageMetadata":{"title":"CLI target context","description":"Set the Pinecone CLI target context with pc target to control which organization and project your commands run against, including in CI/CD and JSON mode.","sidebarTitle":"Target context","href":"/reference/cli/target-context"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Set the Pinecone CLI target context with pc target to control which organization and project your commands run against, including in CI/CD and JSON mode.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Note,Table,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`The CLI’s `,_jsx(_components.strong,{children:`target context`}),` determines which organization and project your commands operate on. You must `,_jsx(_components.a,{href:`/reference/cli/authentication`,children:`authenticate`}),` before setting target context.`]}),`\n`,_jsx(Heading,{level:`2`,id:`flags`,children:`Flags`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Flag`}),_jsx(_components.th,{children:`Short`}),_jsx(_components.th,{children:`Default`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--org`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`-o`})}),_jsx(_components.td,{children:`—`}),_jsxs(_components.td,{children:[`Target organization by name. Mutually exclusive with `,_jsx(_components.code,{children:`--organization-id`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--organization-id`})}),_jsx(_components.td,{children:`—`}),_jsx(_components.td,{children:`—`}),_jsxs(_components.td,{children:[`Target organization by ID. Mutually exclusive with `,_jsx(_components.code,{children:`--org`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--project`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`-p`})}),_jsx(_components.td,{children:`—`}),_jsxs(_components.td,{children:[`Target project by name. Mutually exclusive with `,_jsx(_components.code,{children:`--project-id`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--project-id`})}),_jsx(_components.td,{children:`—`}),_jsx(_components.td,{children:`—`}),_jsxs(_components.td,{children:[`Target project by ID. Mutually exclusive with `,_jsx(_components.code,{children:`--project`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--show`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`-s`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`false`})}),_jsx(_components.td,{children:`Show the current target context.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--clear`})}),_jsx(_components.td,{children:`—`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`false`})}),_jsx(_components.td,{children:`Clear the stored target context.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--json`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`-j`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`false`})}),_jsx(_components.td,{children:`Output as JSON. In non-TTY environments (CI/CD, pipes), JSON output is automatic.`})]})]})]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`--org`}),` and `,_jsx(_components.code,{children:`--organization-id`}),` are mutually exclusive — use one or the other. The same applies to `,_jsx(_components.code,{children:`--project`}),` and `,_jsx(_components.code,{children:`--project-id`}),`.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`how-operations-use-target-context`,children:`How operations use target context`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Operation type`}),_jsx(_components.th,{children:`Scope`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Control plane (indexes, backups)`}),_jsx(_components.td,{children:`Target project`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Data plane (vectors, namespaces)`}),_jsx(_components.td,{children:`Target project + specified index`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Admin API (organizations)`}),_jsx(_components.td,{children:`No target context needed`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Admin API (projects)`}),_jsx(_components.td,{children:`Target organization`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Admin API (API keys)`}),_jsxs(_components.td,{children:[`Target project (unless `,_jsx(_components.code,{children:`--id`}),` specified)`]})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`target-context-by-auth-method`,children:`Target context by auth method`}),`\n`,_jsx(Heading,{level:`3`,id:`user-login`,children:`User login`}),`\n`,_jsxs(_components.p,{children:[`After `,_jsx(_components.code,{children:`pc auth login`}),`, the CLI auto-targets your default organization and its first project.`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Change target`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`pc`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` target`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -o`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"my-org\"`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -p`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"my-project\"`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`service-account`,children:`Service account`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Via CLI command:`}),` After `,_jsx(_components.code,{children:`pc auth configure --client-id --client-secret`}),`, the CLI auto-targets the service account’s organization. For the project:`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`If one project exists, it’s auto-targeted`}),`\n`,_jsxs(_components.li,{children:[`If multiple exist, you’re prompted (or use `,_jsx(_components.code,{children:`--project-id`}),`)`]}),`\n`,_jsx(_components.li,{children:`If none exist, create one and target it manually`}),`\n`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Via environment variables:`}),` If using `,_jsx(_components.code,{children:`PINECONE_CLIENT_ID`}),` and `,_jsx(_components.code,{children:`PINECONE_CLIENT_SECRET`}),` without running `,_jsx(_components.code,{children:`pc auth configure`}),`, no target context is set automatically. Run `,_jsx(_components.code,{children:`pc target`}),` to set it.`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`5`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`5`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Change project (org is fixed to the service account's org)`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`pc`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` target`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -p`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"my-project\"`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Or select interactively`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`pc`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` target`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`api-key`,children:`API key`}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`When using an API key, control plane and data plane operations use the `,_jsx(_components.strong,{children:`key’s org/project scope`}),`, not the CLI’s stored target context. The `,_jsx(_components.code,{children:`pc target --show`}),` output does not reflect what these operations actually use.`]})}),`\n`,_jsx(_components.p,{children:`API keys are scoped to a specific org and project and can’t access resources outside that scope.`}),`\n`,_jsx(_components.p,{children:`Admin API operations still use your user login or service account credentials (API keys can’t authenticate Admin API calls).`}),`\n`,_jsx(Heading,{level:`2`,id:`managing-target-context`,children:`Managing target context`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`pc`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` target`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --show`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` # View current target`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`pc`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` target`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --clear`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` # Clear target context`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`json-mode-and-non-tty-environments`,children:`JSON mode and non-TTY environments`}),`\n`,_jsxs(_components.p,{children:[`Running `,_jsx(_components.code,{children:`pc target --json`}),` with no targeting flags returns the current target context as a JSON object. This is a local-state read — `,_jsx(_components.strong,{children:`no authentication is required`}),`:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`pc`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` target`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --json`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`In non-TTY environments (CI/CD pipelines, shell pipes, scripts), JSON output is automatic — the same as passing `,_jsx(_components.code,{children:`--json`}),` explicitly. You don’t need to add the flag in automation contexts.`]}),`\n`,_jsxs(_components.p,{children:[`Use `,_jsx(_components.code,{children:`--organization-id`}),` and `,_jsx(_components.code,{children:`--project-id`}),` (instead of name flags) to set context reliably in scripts, since IDs are stable and unaffected by renames:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`pc`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` target`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --organization-id`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"org-abc123\"`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --project-id`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"proj-xyz789\"`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --json`})]}),`\n`]})})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"CLI target context","description":"Set the Pinecone CLI target context with pc target to control which organization and project your commands run against, including in CI/CD and JSON mode.","sidebarTitle":"Target context","href":"/reference/cli/target-context"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Flags","slug":"flags","depth":2,"children":[]},{"title":"How operations use target context","slug":"how-operations-use-target-context","depth":2,"children":[]},{"title":"Target context by auth method","slug":"target-context-by-auth-method","depth":2,"children":[{"title":"User login","slug":"user-login","depth":3,"children":[]},{"title":"Service account","slug":"service-account","depth":3,"children":[]},{"title":"API key","slug":"api-key","depth":3,"children":[]}]},{"title":"Managing target context","slug":"managing-target-context","depth":2,"children":[{"title":"JSON mode and non-TTY environments","slug":"json-mode-and-non-tty-environments","depth":3,"children":[]}]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/pinecone/345ae6b85c58f0d4/console-iframe.js","/_mintlify/custom/pinecone/a0c64b8457053743/script.js","/_mintlify/custom/pinecone/4d30bdf131035051/inkeep.js"],"subdomain":"pinecone","siteName":"Pinecone Docs","title":"CLI target context - Pinecone Docs","navMaps":{"firstHrefInVersion":{"2026-07 (latest)":{"href":"/reference/cli/target-context","matchLevel":0},"2026-04":{"href":"/reference/cli/target-context","matchLevel":0},"2025-10":{"href":"/reference/cli/target-context","matchLevel":0},"2025-04":{"href":"/reference/cli/target-context","matchLevel":0},"2025-01":{"href":"/reference/cli/target-context","matchLevel":0},"2024-10":{"href":"/reference/cli/target-context","matchLevel":0},"2024-07":{"href":"/reference/cli/target-context","matchLevel":0},"2024-04":{"href":"/reference/cli/target-context","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-09-15T01:09:32.087Z","originalFileLocation":"reference/cli/target-context.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Set the Pinecone CLI target context with pc target to control which organization and project your commands run against, including in CI/CD and JSON mode.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Pinecone Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/pinecone/JqxxUxUkDTnX7oN2/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/pinecone/JqxxUxUkDTnX7oN2/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/pinecone/JqxxUxUkDTnX7oN2/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/pinecone/JqxxUxUkDTnX7oN2/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/pinecone/JqxxUxUkDTnX7oN2/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/pinecone/JqxxUxUkDTnX7oN2/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/pinecone/JqxxUxUkDTnX7oN2/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/pinecone/JqxxUxUkDTnX7oN2/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/pinecone/JqxxUxUkDTnX7oN2/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"CLI target context - Pinecone Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Set the Pinecone CLI target context with pc target to control which organization and project your commands run against, including in CI/CD and JSON mode.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Pinecone Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.pinecone.io/reference/cli/target-context\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://www.pinecone.io/images/docs_og_image_v2.png\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Documentation for the trusted AI knowledge platform | Pinecone\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Guides, API references, and examples for building with Pinecone Database, Pinecone Assistant, and Pinecone Nexus.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://www.pinecone.io/images/docs_og_image_v2.png\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/pinecone/JqxxUxUkDTnX7oN2/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Pinecone Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#002BFF\">\u003cmeta data-mint-head name=\"google-site-verification\" content=\"woTBImNAcYO-gseVfFKIzQrDRUmLWzFjBWrYbYkOTlI\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.pinecone.io/reference/cli/target-context\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/reference/cli/target-context.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.pinecone.io/#organization\",\"name\":\"Pinecone Docs\",\"url\":\"https://docs.pinecone.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/pinecone/HsZKO51bNmpAasdT/logo/Pinecone-Full-Logo-Black.svg?fit=max\u0026auto=format\u0026n=HsZKO51bNmpAasdT\u0026q=85\u0026s=211d0e7bbefc29ce3b8feee1a05d76ee\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.pinecone.io#website\",\"name\":\"Pinecone Docs\",\"url\":\"https://docs.pinecone.io\",\"publisher\":{\"@id\":\"https://docs.pinecone.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.pinecone.io/reference/cli/target-context#webpage\",\"url\":\"https://docs.pinecone.io/reference/cli/target-context\",\"name\":\"CLI target context\",\"description\":\"Set the Pinecone CLI target context with pc target to control which organization and project your commands run against, including in CI/CD and JSON mode.\",\"dateModified\":\"2026-09-15T01:09:32.087Z\",\"isPartOf\":{\"@id\":\"https://docs.pinecone.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.pinecone.io/reference/cli/target-context#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.pinecone.io/reference/cli/target-context#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"CLI\",\"item\":\"https://docs.pinecone.io/reference/cli/quickstart\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"CLI target context\",\"item\":\"https://docs.pinecone.io/reference/cli/target-context\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.pinecone.io/reference/cli/target-context#article\",\"headline\":\"CLI target context\",\"name\":\"CLI target context\",\"description\":\"Set the Pinecone CLI target context with pc target to control which organization and project your commands run against, including in CI/CD and JSON mode.\",\"url\":\"https://docs.pinecone.io/reference/cli/target-context\",\"mainEntityOfPage\":{\"@id\":\"https://docs.pinecone.io/reference/cli/target-context#webpage\"},\"image\":\"https://www.pinecone.io/images/docs_og_image_v2.png\",\"dateModified\":\"2026-09-15T01:09:32.087Z\",\"publisher\":{\"@id\":\"https://docs.pinecone.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.pinecone.io#website\"}}]}\u003c/script>","siteName":"Pinecone Docs","nav":{"global":null,"dropdowns":[{"dropdown":"Pinecone Database","icon":"database","tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/guides/get-started/overview"}]},{"tab":"Reference","versions":[{"version":"2026-07 (latest)","default":true,"groups":[{"group":"APIs","pages":[{"title":"API reference","sidebarTitle":"Introduction","href":"/reference/api/introduction"},{"title":"Pinecone API authentication","sidebarTitle":"Authentication","href":"/reference/api/authentication"},{"title":"Pinecone API versioning","sidebarTitle":"Versioning","href":"/reference/api/versioning"},{"group":"Database limits","pages":[{"title":"Pinecone Database limits overview","sidebarTitle":"Overview","href":"/reference/api/database-limits"},{"title":"Rate limits","sidebarTitle":"Rate limits","href":"/reference/api/database-limits/rate-limits"},{"title":"Object limits","sidebarTitle":"Object limits","href":"/reference/api/database-limits/object-limits"},{"title":"Operation limits","sidebarTitle":"Operation limits","href":"/reference/api/database-limits/operation-limits"},{"title":"Identifier limits","sidebarTitle":"Identifier limits","href":"/reference/api/database-limits/identifier-limits"},{"title":"Known limitations","href":"/reference/api/known-limitations"}]},{"title":"Pinecone API errors","sidebarTitle":"Errors","href":"/reference/api/errors"}]},{"group":"Database","pages":[{"group":"Indexes","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_control_2026-07.oas.yaml get /indexes","title":"List indexes","href":"/reference/api/2026-07/control-plane/list_indexes"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_control_2026-07.oas.yaml post /indexes","title":"Create an index","href":"/reference/api/2026-07/control-plane/create_index"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_control_2026-07.oas.yaml post /indexes/create-for-model","title":"Create a legacy integrated index","href":"/reference/api/2026-07/control-plane/create_for_model"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_control_2026-07.oas.yaml get /indexes/{index_name}","title":"Describe an index","href":"/reference/api/2026-07/control-plane/describe_index"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_control_2026-07.oas.yaml delete /indexes/{index_name}","title":"Delete an index","href":"/reference/api/2026-07/control-plane/delete_index"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_control_2026-07.oas.yaml patch /indexes/{index_name}","title":"Configure an index","href":"/reference/api/2026-07/control-plane/configure_index"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml post /describe_index_stats","title":"Get index stats","href":"/reference/api/2026-07/data-plane/describeindexstats"}]},{"group":"Namespaces","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml get /namespaces","title":"List namespaces","href":"/reference/api/2026-07/data-plane/listnamespaces"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml post /namespaces","title":"Create a namespace","href":"/reference/api/2026-07/data-plane/createnamespace"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml get /namespaces/{namespace}","title":"Describe a namespace","href":"/reference/api/2026-07/data-plane/describenamespace"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml delete /namespaces/{namespace}","title":"Delete a namespace","href":"/reference/api/2026-07/data-plane/deletenamespace"}]},{"group":"Namespace aliases","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml get /namespace-aliases","title":"List namespace aliases","href":"/reference/api/2026-07/data-plane/list_namespace_aliases"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml post /namespace-aliases","title":"Create a namespace alias","href":"/reference/api/2026-07/data-plane/create_namespace_alias"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml get /namespace-aliases/{alias_name}","title":"Describe a namespace alias","href":"/reference/api/2026-07/data-plane/describe_namespace_alias"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml patch /namespace-aliases/{alias_name}","title":"Repoint a namespace alias","href":"/reference/api/2026-07/data-plane/repoint_namespace_alias"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml delete /namespace-aliases/{alias_name}","title":"Delete a namespace alias","href":"/reference/api/2026-07/data-plane/delete_namespace_alias"}]},{"group":"Vectors","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml post /vectors/upsert","title":"Upsert records","href":"/reference/api/2026-07/data-plane/upsert"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml post /records/namespaces/{namespace}/upsert","title":"Upsert text (legacy Records API)","href":"/reference/api/2026-07/data-plane/upsert_records"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml get /vectors/fetch","title":"Fetch records","href":"/reference/api/2026-07/data-plane/fetch"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml post /vectors/fetch_by_metadata","title":"Fetch records by metadata","href":"/reference/api/2026-07/data-plane/fetch_by_metadata"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml post /vectors/update","title":"Update a record","href":"/reference/api/2026-07/data-plane/update"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml post /vectors/delete","title":"Delete records","href":"/reference/api/2026-07/data-plane/delete"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml get /vectors/list","title":"List record IDs","href":"/reference/api/2026-07/data-plane/list"}]},{"group":"Search","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml post /query","title":"Search with a vector","href":"/reference/api/2026-07/data-plane/query"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml post /records/namespaces/{namespace}/search","title":"Search with text (legacy Records API)","href":"/reference/api/2026-07/data-plane/search_records"}]},{"group":"Documents","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml post /namespaces/{namespace}/documents/upsert","title":"Upsert documents","href":"/reference/api/2026-07/data-plane/upsert_documents"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml post /namespaces/{namespace}/documents/search","title":"Search documents","href":"/reference/api/2026-07/data-plane/search_documents"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml post /namespaces/{namespace}/documents/fetch","title":"Fetch documents","href":"/reference/api/2026-07/data-plane/fetch_documents"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml post /namespaces/{namespace}/documents/list","title":"List documents","href":"/reference/api/2026-07/data-plane/list_documents"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml post /namespaces/{namespace}/documents/update","title":"Update documents","href":"/reference/api/2026-07/data-plane/update_documents"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml post /namespaces/{namespace}/documents/delete","title":"Delete documents","href":"/reference/api/2026-07/data-plane/delete_documents"}]},{"group":"Imports","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml post /bulk/imports","title":"Start import","href":"/reference/api/2026-07/data-plane/start_import"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml get /bulk/imports","title":"List imports","href":"/reference/api/2026-07/data-plane/list_imports"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml get /bulk/imports/{id}","title":"Describe an import","href":"/reference/api/2026-07/data-plane/describe_import"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml delete /bulk/imports/{id}","title":"Cancel an import","href":"/reference/api/2026-07/data-plane/cancel_import"}]},{"group":"Backups","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_control_2026-07.oas.yaml post /indexes/{index_name}/backups","title":"Create a backup of an index","href":"/reference/api/2026-07/control-plane/create_backup"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_control_2026-07.oas.yaml get /backups","title":"List backups for all indexes in a project","href":"/reference/api/2026-07/control-plane/list_project_backups"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_control_2026-07.oas.yaml get /indexes/{index_name}/backups","title":"List backups for an index","href":"/reference/api/2026-07/control-plane/list_index_backups"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_control_2026-07.oas.yaml get /backups/{backup_id}","title":"Describe a backup","href":"/reference/api/2026-07/control-plane/describe_backup"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_control_2026-07.oas.yaml delete /backups/{backup_id}","title":"Delete a backup","href":"/reference/api/2026-07/control-plane/delete_backup"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_control_2026-07.oas.yaml post /backups/{backup_id}/create-index","title":"Create an index from a backup","href":"/reference/api/2026-07/control-plane/create_index_from_backup"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_control_2026-07.oas.yaml get /restore-jobs","title":"List restore jobs","href":"/reference/api/2026-07/control-plane/list_restore_jobs"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_control_2026-07.oas.yaml get /restore-jobs/{job_id}","title":"Describe a restore job","href":"/reference/api/2026-07/control-plane/describe_restore_job"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_control_2026-07.oas.yaml get /collections","title":"List collections","href":"/reference/api/2026-07/control-plane/list_collections"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_control_2026-07.oas.yaml post /collections","title":"Create a collection","href":"/reference/api/2026-07/control-plane/create_collection"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_control_2026-07.oas.yaml get /collections/{collection_name}","title":"Describe a collection","href":"/reference/api/2026-07/control-plane/describe_collection"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_control_2026-07.oas.yaml delete /collections/{collection_name}","title":"Delete a collection","href":"/reference/api/2026-07/control-plane/delete_collection"}]},{"group":"Backup schedules","pages":[{"title":"Create backup schedule","sidebarTitle":"Create backup schedule","api":"POST https://api.pinecone.io/indexes/{index_name}/backup-schedules","href":"/reference/api/2026-07/control-plane/create_backup_schedule"},{"title":"List backup schedules","sidebarTitle":"List backup schedules","api":"GET https://api.pinecone.io/indexes/{index_name}/backup-schedules","href":"/reference/api/2026-07/control-plane/list_backup_schedules"},{"title":"Describe backup schedule","sidebarTitle":"Describe backup schedule","api":"GET https://api.pinecone.io/backup-schedules/{schedule_id}","href":"/reference/api/2026-07/control-plane/describe_backup_schedule"},{"title":"Update backup schedule","sidebarTitle":"Update backup schedule","api":"PATCH https://api.pinecone.io/backup-schedules/{schedule_id}","href":"/reference/api/2026-07/control-plane/update_backup_schedule"},{"title":"Delete backup schedule","sidebarTitle":"Delete backup schedule","api":"DELETE https://api.pinecone.io/backup-schedules/{schedule_id}","href":"/reference/api/2026-07/control-plane/delete_backup_schedule"},{"title":"List backup schedule history","sidebarTitle":"List schedule history","api":"GET https://api.pinecone.io/backup-schedules/{schedule_id}/history","href":"/reference/api/2026-07/control-plane/list_backup_schedule_history"}]}]},{"group":"Inference","pages":[{"group":"Inference","pages":[{"title":"Generate vectors","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/inference_2026-07.oas.yaml post /embed","href":"/reference/api/2026-07/inference/generate-vectors"},{"title":"Rerank results","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/inference_2026-07.oas.yaml post /rerank","href":"/reference/api/2026-07/inference/rerank-results"},{"title":"List available models","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/inference_2026-07.oas.yaml get /models","href":"/reference/api/2026-07/inference/list-available-models"},{"title":"Describe a model","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/inference_2026-07.oas.yaml get /models/{model_name}","href":"/reference/api/2026-07/inference/describe-a-model"}]}]},{"group":"Admin","pages":[{"group":"Projects","pages":[{"title":"List projects","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml get /admin/projects","href":"/reference/api/2026-07/admin/projects/list-projects"},{"title":"Create a new project","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml post /admin/projects","href":"/reference/api/2026-07/admin/projects/create-a-new-project"},{"title":"Get project details","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml get /admin/projects/{project_id}","href":"/reference/api/2026-07/admin/projects/get-project-details"},{"title":"Delete a project","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml delete /admin/projects/{project_id}","href":"/reference/api/2026-07/admin/projects/delete-a-project"},{"title":"Update a project","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml patch /admin/projects/{project_id}","href":"/reference/api/2026-07/admin/projects/update-a-project"}]},{"group":"Organizations","pages":[{"title":"List organizations","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml get /admin/organizations","href":"/reference/api/2026-07/admin/organizations/list-organizations"},{"title":"Get organization details","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml get /admin/organizations/{organization_id}","href":"/reference/api/2026-07/admin/organizations/get-organization-details"},{"title":"Delete an organization","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml delete /admin/organizations/{organization_id}","href":"/reference/api/2026-07/admin/organizations/delete-an-organization"},{"title":"Update an organization","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml patch /admin/organizations/{organization_id}","href":"/reference/api/2026-07/admin/organizations/update-an-organization"}]},{"group":"API Keys","pages":[{"title":"List API keys","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml get /admin/projects/{project_id}/api-keys","href":"/reference/api/2026-07/admin/api-keys/list-api-keys"},{"title":"Create an API key","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml post /admin/projects/{project_id}/api-keys","href":"/reference/api/2026-07/admin/api-keys/create-an-api-key"},{"title":"Get API key details","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml get /admin/api-keys/{api_key_id}","href":"/reference/api/2026-07/admin/api-keys/get-api-key-details"},{"title":"Delete an API key","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml delete /admin/api-keys/{api_key_id}","href":"/reference/api/2026-07/admin/api-keys/delete-an-api-key"},{"title":"Update an API key","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml patch /admin/api-keys/{api_key_id}","href":"/reference/api/2026-07/admin/api-keys/update-an-api-key"}]},{"group":"Users","pages":[{"title":"List users in the organization","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml get /admin/users","href":"/reference/api/2026-07/admin/users/list-users-in-the-organization"},{"title":"Get user details","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml get /admin/users/{user_id}","href":"/reference/api/2026-07/admin/users/get-user-details"},{"title":"Remove a user from the organization","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml delete /admin/users/{user_id}","href":"/reference/api/2026-07/admin/users/remove-a-user-from-the-organization"}]},{"group":"Invites","pages":[{"title":"List invites","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml get /admin/invites","href":"/reference/api/2026-07/admin/invites/list-invites"},{"title":"Invite a user to the organization","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml post /admin/invites","href":"/reference/api/2026-07/admin/invites/invite-a-user-to-the-organization"},{"title":"Get invite details","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml get /admin/invites/{invite_id}","href":"/reference/api/2026-07/admin/invites/get-invite-details"},{"title":"Delete an invite","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml delete /admin/invites/{invite_id}","href":"/reference/api/2026-07/admin/invites/delete-an-invite"},{"title":"Resend an invite email","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml post /admin/invites/{invite_id}/resend","href":"/reference/api/2026-07/admin/invites/resend-an-invite-email"}]},{"group":"Service Accounts","pages":[{"title":"List service accounts","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml get /admin/service-accounts","href":"/reference/api/2026-07/admin/service-accounts/list-service-accounts"},{"title":"Create a service account","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml post /admin/service-accounts","href":"/reference/api/2026-07/admin/service-accounts/create-a-service-account"},{"title":"Get service account details","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml get /admin/service-accounts/{service_account_id}","href":"/reference/api/2026-07/admin/service-accounts/get-service-account-details"},{"title":"Delete a service account","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml delete /admin/service-accounts/{service_account_id}","href":"/reference/api/2026-07/admin/service-accounts/delete-a-service-account"},{"title":"Update a service account","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml patch /admin/service-accounts/{service_account_id}","href":"/reference/api/2026-07/admin/service-accounts/update-a-service-account"},{"title":"Rotate a service account's OAuth client secret","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml post /admin/service-accounts/{service_account_id}/rotate-secret","href":"/reference/api/2026-07/admin/service-accounts/rotate-a-service-accounts-oauth-client-secret"}]},{"group":"Role Bindings","pages":[{"title":"List role bindings","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml get /admin/role-bindings","href":"/reference/api/2026-07/admin/role-bindings/list-role-bindings"},{"title":"Create a role binding","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml post /admin/role-bindings","href":"/reference/api/2026-07/admin/role-bindings/create-a-role-binding"},{"title":"Get role binding details","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml get /admin/role-bindings/{role_binding_id}","href":"/reference/api/2026-07/admin/role-bindings/get-role-binding-details"},{"title":"Delete a role binding","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml delete /admin/role-bindings/{role_binding_id}","href":"/reference/api/2026-07/admin/role-bindings/delete-a-role-binding"}]},{"group":"Cost Usage Exports","pages":[{"title":"List cost usage exports","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml get /admin/cost-usage-exports","href":"/reference/api/2026-07/admin/cost-usage-exports/list-cost-usage-exports"},{"title":"Create a cost usage export","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml post /admin/cost-usage-exports","href":"/reference/api/2026-07/admin/cost-usage-exports/create-a-cost-usage-export"},{"title":"Get cost usage export details","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml get /admin/cost-usage-exports/{cost_usage_export_id}","href":"/reference/api/2026-07/admin/cost-usage-exports/get-cost-usage-export-details"}]}]},{"group":"SDKs","pages":[{"title":"Pinecone SDKs overview","href":"/reference/pinecone-sdks"},{"group":"Python","pages":[{"title":"Pinecone Python SDK","sidebarTitle":"Overview","href":"/reference/sdks/python/overview"},{"title":"Reference","url":"https://sdk.pinecone.io/python/","href":"/reference/sdks/python/reference"}]},{"group":"Node.js","pages":[{"title":"Pinecone Node.js SDK","sidebarTitle":"Overview","href":"/reference/sdks/node/overview"},{"title":"Reference","url":"https://sdk.pinecone.io/typescript/","href":"/reference/sdks/node/reference"}]},{"group":"Java","pages":[{"title":"Pinecone Java SDK","sidebarTitle":"Overview","href":"/reference/sdks/java/overview"},{"title":"Reference","url":"https://github.com/pinecone-io/pinecone-java-client","href":"/reference/sdks/java/reference"},{"title":"OpenTelemetry support","sidebarTitle":"OpenTelemetry","href":"/reference/sdks/java/open-telemetry"}]},{"group":"Go","pages":[{"title":"Pinecone Go SDK","sidebarTitle":"Overview","href":"/reference/sdks/go/overview"},{"title":"Reference","url":"https://github.com/pinecone-io/go-pinecone","href":"/reference/sdks/go/reference"}]}]},{"group":"CLI","pages":[{"title":"CLI quickstart","sidebarTitle":"Quickstart","href":"/reference/cli/quickstart"},{"title":"CLI command reference","sidebarTitle":"Command reference","href":"/reference/cli/command-reference"},{"title":"CLI authentication","description":"Authenticate the Pinecone CLI using user login, service accounts, or API keys, including auth priority and Admin API access rules.","sidebarTitle":"Authentication","href":"/reference/cli/authentication"},{"title":"CLI target context","sidebarTitle":"Target context","href":"/reference/cli/target-context"}]},{"group":"Tools","pages":[{"title":"Spark-Pinecone connector","description":"Pinecone data tools: Use the connector to efficiently create, ingest, and update vector embeddings at scale with Databricks and Pinecone.","href":"/reference/tools/pinecone-spark-connector"}]}]},{"version":"2026-04","groups":[{"group":"APIs","pages":[{"title":"API reference","sidebarTitle":"Introduction","href":"/reference/api/introduction"},{"title":"Pinecone API authentication","sidebarTitle":"Authentication","href":"/reference/api/authentication"},{"title":"Pinecone API versioning","sidebarTitle":"Versioning","href":"/reference/api/versioning"},{"group":"Database limits","pages":[{"title":"Pinecone Database limits overview","sidebarTitle":"Overview","href":"/reference/api/database-limits"},{"title":"Rate limits","sidebarTitle":"Rate limits","href":"/reference/api/database-limits/rate-limits"},{"title":"Object limits","sidebarTitle":"Object limits","href":"/reference/api/database-limits/object-limits"},{"title":"Operation limits","sidebarTitle":"Operation limits","href":"/reference/api/database-limits/operation-limits"},{"title":"Identifier limits","sidebarTitle":"Identifier limits","href":"/reference/api/database-limits/identifier-limits"},{"title":"Known limitations","href":"/reference/api/known-limitations"}]},{"title":"Pinecone API errors","sidebarTitle":"Errors","href":"/reference/api/errors"}]},{"group":"Database","pages":[{"group":"Indexes","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_control_2026-04.oas.yaml get /indexes","title":"List indexes","href":"/reference/api/2026-04/control-plane/list_indexes"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_control_2026-04.oas.yaml post /indexes","title":"Create an index","href":"/reference/api/2026-04/control-plane/create_index"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_control_2026-04.oas.yaml post /indexes/create-for-model","title":"Create an index with integrated embedding","href":"/reference/api/2026-04/control-plane/create_for_model"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_control_2026-04.oas.yaml get /indexes/{index_name}","title":"Describe an index","href":"/reference/api/2026-04/control-plane/describe_index"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_control_2026-04.oas.yaml delete /indexes/{index_name}","title":"Delete an index","href":"/reference/api/2026-04/control-plane/delete_index"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_control_2026-04.oas.yaml patch /indexes/{index_name}","title":"Configure an index","href":"/reference/api/2026-04/control-plane/configure_index"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_data_2026-04.oas.yaml post /describe_index_stats","title":"Get index stats","href":"/reference/api/2026-04/data-plane/describeindexstats"}]},{"group":"Namespaces","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_data_2026-04.oas.yaml get /namespaces","title":"List namespaces","href":"/reference/api/2026-04/data-plane/listnamespaces"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_data_2026-04.oas.yaml post /namespaces","title":"Create a namespace","href":"/reference/api/2026-04/data-plane/createnamespace"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_data_2026-04.oas.yaml get /namespaces/{namespace}","title":"Describe a namespace","href":"/reference/api/2026-04/data-plane/describenamespace"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_data_2026-04.oas.yaml delete /namespaces/{namespace}","title":"Delete a namespace","href":"/reference/api/2026-04/data-plane/deletenamespace"}]},{"group":"Vectors","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_data_2026-04.oas.yaml post /vectors/upsert","title":"Upsert records","href":"/reference/api/2026-04/data-plane/upsert"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_data_2026-04.oas.yaml post /records/namespaces/{namespace}/upsert","title":"Upsert text","href":"/reference/api/2026-04/data-plane/upsert_records"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_data_2026-04.oas.yaml get /vectors/fetch","title":"Fetch records","href":"/reference/api/2026-04/data-plane/fetch"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_data_2026-04.oas.yaml post /vectors/fetch_by_metadata","title":"Fetch records by metadata","href":"/reference/api/2026-04/data-plane/fetch_by_metadata"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_data_2026-04.oas.yaml post /vectors/update","title":"Update a record","href":"/reference/api/2026-04/data-plane/update"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_data_2026-04.oas.yaml post /vectors/delete","title":"Delete records","href":"/reference/api/2026-04/data-plane/delete"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_data_2026-04.oas.yaml get /vectors/list","title":"List record IDs","href":"/reference/api/2026-04/data-plane/list"}]},{"group":"Search","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_data_2026-04.oas.yaml post /query","title":"Search with a vector","href":"/reference/api/2026-04/data-plane/query"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_data_2026-04.oas.yaml post /records/namespaces/{namespace}/search","title":"Search with text","href":"/reference/api/2026-04/data-plane/search_records"}]},{"group":"Imports","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_data_2026-04.oas.yaml post /bulk/imports","title":"Start import","href":"/reference/api/2026-04/data-plane/start_import"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_data_2026-04.oas.yaml get /bulk/imports","title":"List imports","href":"/reference/api/2026-04/data-plane/list_imports"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_data_2026-04.oas.yaml get /bulk/imports/{id}","title":"Describe an import","href":"/reference/api/2026-04/data-plane/describe_import"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_data_2026-04.oas.yaml delete /bulk/imports/{id}","title":"Cancel an import","href":"/reference/api/2026-04/data-plane/cancel_import"}]},{"group":"Backups","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_control_2026-04.oas.yaml post /indexes/{index_name}/backups","title":"Create a backup of an index","href":"/reference/api/2026-04/control-plane/create_backup"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_control_2026-04.oas.yaml get /backups","title":"List backups for all indexes in a project","href":"/reference/api/2026-04/control-plane/list_project_backups"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_control_2026-04.oas.yaml get /indexes/{index_name}/backups","title":"List backups for an index","href":"/reference/api/2026-04/control-plane/list_index_backups"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_control_2026-04.oas.yaml get /backups/{backup_id}","title":"Describe a backup","href":"/reference/api/2026-04/control-plane/describe_backup"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_control_2026-04.oas.yaml delete /backups/{backup_id}","title":"Delete a backup","href":"/reference/api/2026-04/control-plane/delete_backup"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_control_2026-04.oas.yaml post /backups/{backup_id}/create-index","title":"Create an index from a backup","href":"/reference/api/2026-04/control-plane/create_index_from_backup"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_control_2026-04.oas.yaml get /restore-jobs","title":"List restore jobs","href":"/reference/api/2026-04/control-plane/list_restore_jobs"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_control_2026-04.oas.yaml get /restore-jobs/{job_id}","title":"Describe a restore job","href":"/reference/api/2026-04/control-plane/describe_restore_job"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_control_2026-04.oas.yaml get /collections","title":"List collections","href":"/reference/api/2026-04/control-plane/list_collections"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_control_2026-04.oas.yaml post /collections","title":"Create a collection","href":"/reference/api/2026-04/control-plane/create_collection"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_control_2026-04.oas.yaml get /collections/{collection_name}","title":"Describe a collection","href":"/reference/api/2026-04/control-plane/describe_collection"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_control_2026-04.oas.yaml delete /collections/{collection_name}","title":"Delete a collection","href":"/reference/api/2026-04/control-plane/delete_collection"}]},{"group":"Backup schedules","pages":[{"title":"Create backup schedule","sidebarTitle":"Create backup schedule","api":"POST https://api.pinecone.io/indexes/{index_name}/backup-schedules","href":"/reference/api/2026-04/control-plane/create_backup_schedule"},{"title":"List backup schedules","sidebarTitle":"List backup schedules","api":"GET https://api.pinecone.io/indexes/{index_name}/backup-schedules","href":"/reference/api/2026-04/control-plane/list_backup_schedules"},{"title":"Describe backup schedule","sidebarTitle":"Describe backup schedule","api":"GET https://api.pinecone.io/backup-schedules/{schedule_id}","href":"/reference/api/2026-04/control-plane/describe_backup_schedule"},{"title":"Update backup schedule","sidebarTitle":"Update backup schedule","api":"PATCH https://api.pinecone.io/backup-schedules/{schedule_id}","href":"/reference/api/2026-04/control-plane/update_backup_schedule"},{"title":"Delete backup schedule","sidebarTitle":"Delete backup schedule","api":"DELETE https://api.pinecone.io/backup-schedules/{schedule_id}","href":"/reference/api/2026-04/control-plane/delete_backup_schedule"},{"title":"List backup schedule history","sidebarTitle":"List schedule history","api":"GET https://api.pinecone.io/backup-schedules/{schedule_id}/history","href":"/reference/api/2026-04/control-plane/list_backup_schedule_history"}]}]},{"group":"Inference","pages":[{"group":"Embed","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/inference_2026-04.oas.yaml post /embed","title":"Generate vectors","href":"/reference/api/2026-04/inference/generate-embeddings"}]},{"group":"Rerank","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/inference_2026-04.oas.yaml post /rerank","title":"Rerank results","href":"/reference/api/2026-04/inference/rerank"}]},{"group":"Models","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/inference_2026-04.oas.yaml get /models","title":"List available models","href":"/reference/api/2026-04/inference/list_models"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/inference_2026-04.oas.yaml get /models/{model_name}","title":"Describe a model","href":"/reference/api/2026-04/inference/describe_model"}]}]},{"group":"Admin","pages":[{"group":"API keys","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml post /admin/projects/{project_id}/api-keys","title":"Create an API key","href":"/reference/api/2026-04/admin/create_api_key"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml get /admin/projects/{project_id}/api-keys","title":"List API keys","href":"/reference/api/2026-04/admin/list_api_keys"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml get /admin/api-keys/{api_key_id}","title":"Get API key details","href":"/reference/api/2026-04/admin/fetch_api_key"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml patch /admin/api-keys/{api_key_id}","title":"Update an API key","href":"/reference/api/2026-04/admin/update_api_key"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml delete /admin/api-keys/{api_key_id}","title":"Delete an API key","href":"/reference/api/2026-04/admin/delete_api_key"}]},{"group":"Projects","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml post /admin/projects","title":"Create a new project","href":"/reference/api/2026-04/admin/create_project"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml get /admin/projects","title":"List projects","href":"/reference/api/2026-04/admin/list_projects"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml get /admin/projects/{project_id}","title":"Get project details","href":"/reference/api/2026-04/admin/fetch_project"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml patch /admin/projects/{project_id}","title":"Update a project","href":"/reference/api/2026-04/admin/update_project"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml delete /admin/projects/{project_id}","title":"Delete a project","href":"/reference/api/2026-04/admin/delete_project"}]},{"group":"Service accounts","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml post /admin/service-accounts","title":"Create a service account","href":"/reference/api/2026-04/admin/create_service_account"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml get /admin/service-accounts","title":"List service accounts","href":"/reference/api/2026-04/admin/list_service_accounts"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml get /admin/service-accounts/{service_account_id}","title":"Get service account details","href":"/reference/api/2026-04/admin/fetch_service_account"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml patch /admin/service-accounts/{service_account_id}","title":"Update a service account","href":"/reference/api/2026-04/admin/update_service_account"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml delete /admin/service-accounts/{service_account_id}","title":"Delete a service account","href":"/reference/api/2026-04/admin/delete_service_account"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml post /admin/service-accounts/{service_account_id}/rotate-secret","title":"Rotate a service account's OAuth client secret","href":"/reference/api/2026-04/admin/rotate_service_account_secret"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/oauth_2026-04.oas.yaml post /oauth/token","title":"Create an access token","href":"/reference/api/2026-04/admin/get_token"}]},{"group":"Users","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml get /admin/users","title":"List users in the organization","href":"/reference/api/2026-04/admin/list_users"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml get /admin/users/{user_id}","title":"Get user details","href":"/reference/api/2026-04/admin/fetch_user"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml delete /admin/users/{user_id}","title":"Remove a user from the organization","href":"/reference/api/2026-04/admin/delete_user"}]},{"group":"Invites","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml post /admin/invites","title":"Invite a user to the organization","href":"/reference/api/2026-04/admin/create_invite"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml get /admin/invites","title":"List invites","href":"/reference/api/2026-04/admin/list_invites"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml get /admin/invites/{invite_id}","title":"Get invite details","href":"/reference/api/2026-04/admin/fetch_invite"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml delete /admin/invites/{invite_id}","title":"Delete an invite","href":"/reference/api/2026-04/admin/delete_invite"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml post /admin/invites/{invite_id}/resend","title":"Resend an invite email","href":"/reference/api/2026-04/admin/resend_invite"}]},{"group":"Role bindings","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml post /admin/role-bindings","title":"Create a role binding","href":"/reference/api/2026-04/admin/create_role_binding"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml get /admin/role-bindings","title":"List role bindings","href":"/reference/api/2026-04/admin/list_role_bindings"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml get /admin/role-bindings/{role_binding_id}","title":"Get role binding details","href":"/reference/api/2026-04/admin/fetch_role_binding"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml delete /admin/role-bindings/{role_binding_id}","title":"Delete a role binding","href":"/reference/api/2026-04/admin/delete_role_binding"}]}]},{"group":"SDKs","pages":[{"title":"Pinecone SDKs overview","href":"/reference/pinecone-sdks"},{"group":"Python","pages":[{"title":"Pinecone Python SDK","sidebarTitle":"Overview","href":"/reference/sdks/python/overview"},{"title":"Reference","url":"https://sdk.pinecone.io/python/","href":"/reference/sdks/python/reference"}]},{"group":"Node.js","pages":[{"title":"Pinecone Node.js SDK","sidebarTitle":"Overview","href":"/reference/sdks/node/overview"},{"title":"Reference","url":"https://sdk.pinecone.io/typescript/","href":"/reference/sdks/node/reference"}]},{"group":"Java","pages":[{"title":"Pinecone Java SDK","sidebarTitle":"Overview","href":"/reference/sdks/java/overview"},{"title":"Reference","url":"https://github.com/pinecone-io/pinecone-java-client","href":"/reference/sdks/java/reference"},{"title":"OpenTelemetry support","sidebarTitle":"OpenTelemetry","href":"/reference/sdks/java/open-telemetry"}]},{"group":"Go","pages":[{"title":"Pinecone Go SDK","sidebarTitle":"Overview","href":"/reference/sdks/go/overview"},{"title":"Reference","url":"https://github.com/pinecone-io/go-pinecone","href":"/reference/sdks/go/reference"}]}]},{"group":"CLI","pages":[{"title":"CLI quickstart","sidebarTitle":"Quickstart","href":"/reference/cli/quickstart"},{"title":"CLI command reference","sidebarTitle":"Command reference","href":"/reference/cli/command-reference"},{"title":"CLI authentication","description":"Authenticate the Pinecone CLI using user login, service accounts, or API keys, including auth priority and Admin API access rules.","sidebarTitle":"Authentication","href":"/reference/cli/authentication"},{"title":"CLI target context","sidebarTitle":"Target context","href":"/reference/cli/target-context"}]},{"group":"Tools","pages":[{"title":"Spark-Pinecone connector","description":"Pinecone data tools: Use the connector to efficiently create, ingest, and update vector embeddings at scale with Databricks and Pinecone.","href":"/reference/tools/pinecone-spark-connector"}]}]},{"version":"2025-10","groups":[{"group":"APIs","pages":[{"title":"API reference","sidebarTitle":"Introduction","href":"/reference/api/introduction"},{"title":"Pinecone API authentication","sidebarTitle":"Authentication","href":"/reference/api/authentication"},{"title":"Pinecone API versioning","sidebarTitle":"Versioning","href":"/reference/api/versioning"},{"group":"Database limits","pages":[{"title":"Pinecone Database limits overview","sidebarTitle":"Overview","href":"/reference/api/database-limits"},{"title":"Rate limits","sidebarTitle":"Rate limits","href":"/reference/api/database-limits/rate-limits"},{"title":"Object limits","sidebarTitle":"Object limits","href":"/reference/api/database-limits/object-limits"},{"title":"Operation limits","sidebarTitle":"Operation limits","href":"/reference/api/database-limits/operation-limits"},{"title":"Identifier limits","sidebarTitle":"Identifier limits","href":"/reference/api/database-limits/identifier-limits"},{"title":"Known limitations","href":"/reference/api/known-limitations"}]},{"title":"Pinecone API errors","sidebarTitle":"Errors","href":"/reference/api/errors"}]},{"group":"Database","pages":[{"group":"Indexes","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/db_control_2025-10.oas.yaml get /indexes","title":"List indexes","href":"/reference/api/2025-10/control-plane/list_indexes"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/db_control_2025-10.oas.yaml post /indexes","title":"Create an index","href":"/reference/api/2025-10/control-plane/create_index"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/db_control_2025-10.oas.yaml post /indexes/create-for-model","title":"Create an index with integrated embedding","href":"/reference/api/2025-10/control-plane/create_for_model"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/db_control_2025-10.oas.yaml get /indexes/{index_name}","title":"Describe an index","href":"/reference/api/2025-10/control-plane/describe_index"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/db_control_2025-10.oas.yaml delete /indexes/{index_name}","title":"Delete an index","href":"/reference/api/2025-10/control-plane/delete_index"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/db_control_2025-10.oas.yaml patch /indexes/{index_name}","title":"Configure an index","href":"/reference/api/2025-10/control-plane/configure_index"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/db_data_2025-10.oas.yaml post /describe_index_stats","title":"Get index stats","href":"/reference/api/2025-10/data-plane/describeindexstats"}]},{"group":"Namespaces","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/db_data_2025-10.oas.yaml get /namespaces","title":"List namespaces","href":"/reference/api/2025-10/data-plane/listnamespaces"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/db_data_2025-10.oas.yaml post /namespaces","title":"Create a namespace","href":"/reference/api/2025-10/data-plane/createnamespace"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/db_data_2025-10.oas.yaml get /namespaces/{namespace}","title":"Describe a namespace","href":"/reference/api/2025-10/data-plane/describenamespace"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/db_data_2025-10.oas.yaml delete /namespaces/{namespace}","title":"Delete a namespace","href":"/reference/api/2025-10/data-plane/deletenamespace"}]},{"group":"Vectors","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/db_data_2025-10.oas.yaml post /vectors/upsert","title":"Upsert vectors","href":"/reference/api/2025-10/data-plane/upsert"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/db_data_2025-10.oas.yaml post /records/namespaces/{namespace}/upsert","title":"Upsert text","href":"/reference/api/2025-10/data-plane/upsert_records"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/db_data_2025-10.oas.yaml get /vectors/fetch","title":"Fetch vectors","href":"/reference/api/2025-10/data-plane/fetch"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/db_data_2025-10.oas.yaml post /vectors/fetch_by_metadata","title":"Fetch vectors by metadata","href":"/reference/api/2025-10/data-plane/fetch_by_metadata"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/db_data_2025-10.oas.yaml post /vectors/update","title":"Update a vector","href":"/reference/api/2025-10/data-plane/update"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/db_data_2025-10.oas.yaml post /vectors/delete","title":"Delete vectors","href":"/reference/api/2025-10/data-plane/delete"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/db_data_2025-10.oas.yaml get /vectors/list","title":"List vector IDs","href":"/reference/api/2025-10/data-plane/list"}]},{"group":"Search","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/db_data_2025-10.oas.yaml post /query","title":"Search with a vector","href":"/reference/api/2025-10/data-plane/query"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/db_data_2025-10.oas.yaml post /records/namespaces/{namespace}/search","title":"Search with text","href":"/reference/api/2025-10/data-plane/search_records"}]},{"group":"Imports","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/db_data_2025-10.oas.yaml post /bulk/imports","title":"Start import","href":"/reference/api/2025-10/data-plane/start_import"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/db_data_2025-10.oas.yaml get /bulk/imports","title":"List imports","href":"/reference/api/2025-10/data-plane/list_imports"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/db_data_2025-10.oas.yaml get /bulk/imports/{id}","title":"Describe an import","href":"/reference/api/2025-10/data-plane/describe_import"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/db_data_2025-10.oas.yaml delete /bulk/imports/{id}","title":"Cancel an import","href":"/reference/api/2025-10/data-plane/cancel_import"}]},{"group":"Backups","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/db_control_2025-10.oas.yaml post /indexes/{index_name}/backups","title":"Create a backup of an index","href":"/reference/api/2025-10/control-plane/create_backup"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/db_control_2025-10.oas.yaml get /backups","title":"List backups for all indexes in a project","href":"/reference/api/2025-10/control-plane/list_project_backups"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/db_control_2025-10.oas.yaml get /indexes/{index_name}/backups","title":"List backups for an index","href":"/reference/api/2025-10/control-plane/list_index_backups"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/db_control_2025-10.oas.yaml get /backups/{backup_id}","title":"Describe a backup","href":"/reference/api/2025-10/control-plane/describe_backup"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/db_control_2025-10.oas.yaml delete /backups/{backup_id}","title":"Delete a backup","href":"/reference/api/2025-10/control-plane/delete_backup"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/db_control_2025-10.oas.yaml post /backups/{backup_id}/create-index","title":"Create an index from a backup","href":"/reference/api/2025-10/control-plane/create_index_from_backup"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/db_control_2025-10.oas.yaml get /restore-jobs","title":"List restore jobs","href":"/reference/api/2025-10/control-plane/list_restore_jobs"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/db_control_2025-10.oas.yaml get /restore-jobs/{job_id}","title":"Describe a restore job","href":"/reference/api/2025-10/control-plane/describe_restore_job"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/db_control_2025-10.oas.yaml get /collections","title":"List collections","href":"/reference/api/2025-10/control-plane/list_collections"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/db_control_2025-10.oas.yaml post /collections","title":"Create a collection","href":"/reference/api/2025-10/control-plane/create_collection"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/db_control_2025-10.oas.yaml get /collections/{collection_name}","title":"Describe a collection","href":"/reference/api/2025-10/control-plane/describe_collection"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/db_control_2025-10.oas.yaml delete /collections/{collection_name}","title":"Delete a collection","href":"/reference/api/2025-10/control-plane/delete_collection"}]}]},{"group":"Inference","pages":[{"group":"Embed","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/inference_2025-10.oas.yaml post /embed","title":"Generate vectors","href":"/reference/api/2025-10/inference/generate-embeddings"}]},{"group":"Rerank","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/inference_2025-10.oas.yaml post /rerank","title":"Rerank results","href":"/reference/api/2025-10/inference/rerank"}]},{"group":"Models","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/inference_2025-10.oas.yaml get /models","title":"List available models","href":"/reference/api/2025-10/inference/list_models"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/inference_2025-10.oas.yaml get /models/{model_name}","title":"Describe a model","href":"/reference/api/2025-10/inference/describe_model"}]}]},{"group":"Admin","pages":[{"group":"API keys","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/admin_2025-10.oas.yaml post /admin/projects/{project_id}/api-keys","title":"Create an API key","href":"/reference/api/2025-10/admin/create_api_key"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/admin_2025-10.oas.yaml get /admin/projects/{project_id}/api-keys","title":"List API keys","href":"/reference/api/2025-10/admin/list_api_keys"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/admin_2025-10.oas.yaml get /admin/api-keys/{api_key_id}","title":"Get API key details","href":"/reference/api/2025-10/admin/fetch_api_key"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/admin_2025-10.oas.yaml patch /admin/api-keys/{api_key_id}","title":"Update an API key","href":"/reference/api/2025-10/admin/update_api_key"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/admin_2025-10.oas.yaml delete /admin/api-keys/{api_key_id}","title":"Delete an API key","href":"/reference/api/2025-10/admin/delete_api_key"}]},{"group":"Projects","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/admin_2025-10.oas.yaml post /admin/projects","title":"Create a new project","href":"/reference/api/2025-10/admin/create_project"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/admin_2025-10.oas.yaml get /admin/projects","title":"List projects","href":"/reference/api/2025-10/admin/list_projects"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/admin_2025-10.oas.yaml get /admin/projects/{project_id}","title":"Get project details","href":"/reference/api/2025-10/admin/fetch_project"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/admin_2025-10.oas.yaml patch /admin/projects/{project_id}","title":"Update a project","href":"/reference/api/2025-10/admin/update_project"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/admin_2025-10.oas.yaml delete /admin/projects/{project_id}","title":"Delete a project","href":"/reference/api/2025-10/admin/delete_project"}]},{"group":"Service accounts","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/oauth_2025-10.oas.yaml post /oauth/token","title":"Create an access token","href":"/reference/api/2025-10/admin/get_token"}]}]},{"group":"SDKs","pages":[{"title":"Pinecone SDKs overview","href":"/reference/pinecone-sdks"},{"group":"Python","pages":[{"title":"Pinecone Python SDK","sidebarTitle":"Overview","href":"/reference/sdks/python/overview"},{"title":"Reference","url":"https://sdk.pinecone.io/python/","href":"/reference/sdks/python/reference"}]},{"group":"Node.js","pages":[{"title":"Pinecone Node.js SDK","sidebarTitle":"Overview","href":"/reference/sdks/node/overview"},{"title":"Reference","url":"https://sdk.pinecone.io/typescript/","href":"/reference/sdks/node/reference"}]},{"group":"Java","pages":[{"title":"Pinecone Java SDK","sidebarTitle":"Overview","href":"/reference/sdks/java/overview"},{"title":"Reference","url":"https://github.com/pinecone-io/pinecone-java-client","href":"/reference/sdks/java/reference"},{"title":"OpenTelemetry support","sidebarTitle":"OpenTelemetry","href":"/reference/sdks/java/open-telemetry"}]},{"group":"Go","pages":[{"title":"Pinecone Go SDK","sidebarTitle":"Overview","href":"/reference/sdks/go/overview"},{"title":"Reference","url":"https://github.com/pinecone-io/go-pinecone","href":"/reference/sdks/go/reference"}]}]},{"group":"CLI","pages":[{"title":"CLI quickstart","sidebarTitle":"Quickstart","href":"/reference/cli/quickstart"},{"title":"CLI command reference","sidebarTitle":"Command reference","href":"/reference/cli/command-reference"},{"title":"CLI authentication","description":"Authenticate the Pinecone CLI using user login, service accounts, or API keys, including auth priority and Admin API access rules.","sidebarTitle":"Authentication","href":"/reference/cli/authentication"},{"title":"CLI target context","sidebarTitle":"Target context","href":"/reference/cli/target-context"}]},{"group":"Tools","pages":[{"title":"Spark-Pinecone connector","description":"Pinecone data tools: Use the connector to efficiently create, ingest, and update vector embeddings at scale with Databricks and Pinecone.","href":"/reference/tools/pinecone-spark-connector"}]}]},{"version":"2025-04","groups":[{"group":"APIs","pages":[{"title":"API reference","sidebarTitle":"Introduction","href":"/reference/api/introduction"},{"title":"Pinecone API authentication","sidebarTitle":"Authentication","href":"/reference/api/authentication"},{"title":"Pinecone API versioning","sidebarTitle":"Versioning","href":"/reference/api/versioning"},{"group":"Database limits","pages":[{"title":"Pinecone Database limits overview","sidebarTitle":"Overview","href":"/reference/api/database-limits"},{"title":"Rate limits","sidebarTitle":"Rate limits","href":"/reference/api/database-limits/rate-limits"},{"title":"Object limits","sidebarTitle":"Object limits","href":"/reference/api/database-limits/object-limits"},{"title":"Operation limits","sidebarTitle":"Operation limits","href":"/reference/api/database-limits/operation-limits"},{"title":"Identifier limits","sidebarTitle":"Identifier limits","href":"/reference/api/database-limits/identifier-limits"},{"title":"Known limitations","href":"/reference/api/known-limitations"}]},{"title":"Pinecone API errors","sidebarTitle":"Errors","href":"/reference/api/errors"}]},{"group":"Database","pages":[{"group":"Indexes","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/db_control_2025-04.oas.yaml get /indexes","title":"List indexes","href":"/reference/api/2025-04/control-plane/list_indexes"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/db_control_2025-04.oas.yaml post /indexes","title":"Create an index","href":"/reference/api/2025-04/control-plane/create_index"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/db_control_2025-04.oas.yaml post /indexes/create-for-model","title":"Create an index with integrated embedding","href":"/reference/api/2025-04/control-plane/create_for_model"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/db_control_2025-04.oas.yaml get /indexes/{index_name}","title":"Describe an index","href":"/reference/api/2025-04/control-plane/describe_index"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/db_control_2025-04.oas.yaml delete /indexes/{index_name}","title":"Delete an index","href":"/reference/api/2025-04/control-plane/delete_index"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/db_control_2025-04.oas.yaml patch /indexes/{index_name}","title":"Configure an index","href":"/reference/api/2025-04/control-plane/configure_index"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/db_data_2025-04.oas.yaml post /describe_index_stats","title":"Get index stats","href":"/reference/api/2025-04/data-plane/describeindexstats"}]},{"group":"Namespaces","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/db_data_2025-04.oas.yaml get /namespaces","title":"List namespaces","href":"/reference/api/2025-04/data-plane/listnamespaces"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/db_data_2025-04.oas.yaml get /namespaces/{namespace}","title":"Describe a namespace","href":"/reference/api/2025-04/data-plane/describenamespace"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/db_data_2025-04.oas.yaml delete /namespaces/{namespace}","title":"Delete a namespace","href":"/reference/api/2025-04/data-plane/deletenamespace"}]},{"group":"Vectors","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/db_data_2025-04.oas.yaml post /vectors/upsert","title":"Upsert vectors","href":"/reference/api/2025-04/data-plane/upsert"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/db_data_2025-04.oas.yaml post /records/namespaces/{namespace}/upsert","title":"Upsert text","href":"/reference/api/2025-04/data-plane/upsert_records"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/db_data_2025-04.oas.yaml get /vectors/fetch","title":"Fetch vectors","href":"/reference/api/2025-04/data-plane/fetch"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/db_data_2025-04.oas.yaml post /vectors/update","title":"Update a vector","href":"/reference/api/2025-04/data-plane/update"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/db_data_2025-04.oas.yaml post /vectors/delete","title":"Delete vectors","href":"/reference/api/2025-04/data-plane/delete"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/db_data_2025-04.oas.yaml get /vectors/list","title":"List vector IDs","href":"/reference/api/2025-04/data-plane/list"}]},{"group":"Search","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/db_data_2025-04.oas.yaml post /query","title":"Search with a vector","href":"/reference/api/2025-04/data-plane/query"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/db_data_2025-04.oas.yaml post /records/namespaces/{namespace}/search","title":"Search with text","href":"/reference/api/2025-04/data-plane/search_records"}]},{"group":"Imports","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/db_data_2025-04.oas.yaml post /bulk/imports","title":"Start import","href":"/reference/api/2025-04/data-plane/start_import"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/db_data_2025-04.oas.yaml get /bulk/imports","title":"List imports","href":"/reference/api/2025-04/data-plane/list_imports"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/db_data_2025-04.oas.yaml get /bulk/imports/{id}","title":"Describe an import","href":"/reference/api/2025-04/data-plane/describe_import"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/db_data_2025-04.oas.yaml delete /bulk/imports/{id}","title":"Cancel an import","href":"/reference/api/2025-04/data-plane/cancel_import"}]},{"group":"Backups","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/db_control_2025-04.oas.yaml post /indexes/{index_name}/backups","title":"Create a backup of an index","href":"/reference/api/2025-04/control-plane/create_backup"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/db_control_2025-04.oas.yaml get /backups","title":"List backups for all indexes in a project","href":"/reference/api/2025-04/control-plane/list_project_backups"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/db_control_2025-04.oas.yaml get /indexes/{index_name}/backups","title":"List backups for an index","href":"/reference/api/2025-04/control-plane/list_index_backups"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/db_control_2025-04.oas.yaml get /backups/{backup_id}","title":"Describe a backup","href":"/reference/api/2025-04/control-plane/describe_backup"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/db_control_2025-04.oas.yaml delete /backups/{backup_id}","title":"Delete a backup","href":"/reference/api/2025-04/control-plane/delete_backup"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/db_control_2025-04.oas.yaml post /backups/{backup_id}/create-index","title":"Create an index from a backup","href":"/reference/api/2025-04/control-plane/create_index_from_backup"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/db_control_2025-04.oas.yaml get /restore-jobs","title":"List restore jobs","href":"/reference/api/2025-04/control-plane/list_restore_jobs"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/db_control_2025-04.oas.yaml get /restore-jobs/{job_id}","title":"Describe a restore job","href":"/reference/api/2025-04/control-plane/describe_restore_job"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/db_control_2025-04.oas.yaml get /collections","title":"List collections","href":"/reference/api/2025-04/control-plane/list_collections"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/db_control_2025-04.oas.yaml post /collections","title":"Create a collection","href":"/reference/api/2025-04/control-plane/create_collection"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/db_control_2025-04.oas.yaml get /collections/{collection_name}","title":"Describe a collection","href":"/reference/api/2025-04/control-plane/describe_collection"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/db_control_2025-04.oas.yaml delete /collections/{collection_name}","title":"Delete a collection","href":"/reference/api/2025-04/control-plane/delete_collection"}]}]},{"group":"Inference","pages":[{"group":"Embed","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/inference_2025-04.oas.yaml post /embed","title":"Generate vectors","href":"/reference/api/2025-04/inference/generate-embeddings"}]},{"group":"Rerank","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/inference_2025-04.oas.yaml post /rerank","title":"Rerank documents","href":"/reference/api/2025-04/inference/rerank"}]},{"group":"Models","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/inference_2025-04.oas.yaml get /models","title":"List available models","href":"/reference/api/2025-04/inference/list_models"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/inference_2025-04.oas.yaml get /models/{model_name}","title":"Describe a model","href":"/reference/api/2025-04/inference/describe_model"}]}]},{"group":"Admin","pages":[{"group":"API keys","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/admin_2025-04.oas.yaml post /admin/projects/{project_id}/api-keys","title":"Create an API key","href":"/reference/api/2025-04/admin/create_api_key"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/admin_2025-04.oas.yaml get /admin/projects/{project_id}/api-keys","title":"List API keys","href":"/reference/api/2025-04/admin/list_api_keys"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/admin_2025-04.oas.yaml get /admin/api-keys/{api_key_id}","title":"Get API key details","href":"/reference/api/2025-04/admin/fetch_api_key"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/admin_2025-04.oas.yaml patch /admin/api-keys/{api_key_id}","title":"Update an API key","href":"/reference/api/2025-04/admin/update_api_key"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/admin_2025-04.oas.yaml delete /admin/api-keys/{api_key_id}","title":"Delete an API key","href":"/reference/api/2025-04/admin/delete_api_key"}]},{"group":"Projects","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/admin_2025-04.oas.yaml post /admin/projects","title":"Create a new project","href":"/reference/api/2025-04/admin/create_project"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/admin_2025-04.oas.yaml get /admin/projects","title":"List projects","href":"/reference/api/2025-04/admin/list_projects"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/admin_2025-04.oas.yaml get /admin/projects/{project_id}","title":"Get project details","href":"/reference/api/2025-04/admin/fetch_project"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/admin_2025-04.oas.yaml patch /admin/projects/{project_id}","title":"Update a project","href":"/reference/api/2025-04/admin/update_project"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/admin_2025-04.oas.yaml delete /admin/projects/{project_id}","title":"Delete a project","href":"/reference/api/2025-04/admin/delete_project"}]},{"group":"Service accounts","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/oauth_2025-04.oas.yaml post /oauth/token","title":"Get an access token","href":"/reference/api/2025-04/admin/get_token"}]}]},{"group":"SDKs","pages":[{"title":"Pinecone SDKs overview","href":"/reference/pinecone-sdks"},{"group":"Python","pages":[{"title":"Pinecone Python SDK","sidebarTitle":"Overview","href":"/reference/sdks/python/overview"},{"title":"Reference","url":"https://sdk.pinecone.io/python/","href":"/reference/sdks/python/reference"}]},{"group":"Node.js","pages":[{"title":"Pinecone Node.js SDK","sidebarTitle":"Overview","href":"/reference/sdks/node/overview"},{"title":"Reference","url":"https://sdk.pinecone.io/typescript/","href":"/reference/sdks/node/reference"}]},{"group":"Java","pages":[{"title":"Pinecone Java SDK","sidebarTitle":"Overview","href":"/reference/sdks/java/overview"},{"title":"Reference","url":"https://github.com/pinecone-io/pinecone-java-client","href":"/reference/sdks/java/reference"},{"title":"OpenTelemetry support","sidebarTitle":"OpenTelemetry","href":"/reference/sdks/java/open-telemetry"}]},{"group":"Go","pages":[{"title":"Pinecone Go SDK","sidebarTitle":"Overview","href":"/reference/sdks/go/overview"},{"title":"Reference","url":"https://github.com/pinecone-io/go-pinecone","href":"/reference/sdks/go/reference"}]}]},{"group":"CLI","pages":[{"title":"CLI quickstart","sidebarTitle":"Quickstart","href":"/reference/cli/quickstart"},{"title":"CLI command reference","sidebarTitle":"Command reference","href":"/reference/cli/command-reference"},{"title":"CLI authentication","description":"Authenticate the Pinecone CLI using user login, service accounts, or API keys, including auth priority and Admin API access rules.","sidebarTitle":"Authentication","href":"/reference/cli/authentication"},{"title":"CLI target context","sidebarTitle":"Target context","href":"/reference/cli/target-context"}]},{"group":"Tools","pages":[{"title":"Spark-Pinecone connector","description":"Pinecone data tools: Use the connector to efficiently create, ingest, and update vector embeddings at scale with Databricks and Pinecone.","href":"/reference/tools/pinecone-spark-connector"}]}]},{"version":"2025-01","groups":[{"group":"APIs","pages":[{"title":"API reference","sidebarTitle":"Introduction","href":"/reference/api/introduction"},{"title":"Pinecone API authentication","sidebarTitle":"Authentication","href":"/reference/api/authentication"},{"title":"Pinecone API versioning","sidebarTitle":"Versioning","href":"/reference/api/versioning"},{"group":"Database limits","pages":[{"title":"Pinecone Database limits overview","sidebarTitle":"Overview","href":"/reference/api/database-limits"},{"title":"Rate limits","sidebarTitle":"Rate limits","href":"/reference/api/database-limits/rate-limits"},{"title":"Object limits","sidebarTitle":"Object limits","href":"/reference/api/database-limits/object-limits"},{"title":"Operation limits","sidebarTitle":"Operation limits","href":"/reference/api/database-limits/operation-limits"},{"title":"Identifier limits","sidebarTitle":"Identifier limits","href":"/reference/api/database-limits/identifier-limits"},{"title":"Known limitations","href":"/reference/api/known-limitations"}]},{"title":"Pinecone API errors","sidebarTitle":"Errors","href":"/reference/api/errors"}]},{"group":"Database","pages":[{"group":"Indexes","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-01/db_control_2025-01.oas.yaml get /indexes","title":"List indexes","href":"/reference/api/2025-01/control-plane/list_indexes"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-01/db_control_2025-01.oas.yaml post /indexes","title":"Create an index","href":"/reference/api/2025-01/control-plane/create_index"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-01/db_control_2025-01.oas.yaml post /indexes/create-for-model","title":"Create an index with integrated embedding","href":"/reference/api/2025-01/control-plane/create_for_model"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-01/db_control_2025-01.oas.yaml get /indexes/{index_name}","title":"Describe an index","href":"/reference/api/2025-01/control-plane/describe_index"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-01/db_control_2025-01.oas.yaml delete /indexes/{index_name}","title":"Delete an index","href":"/reference/api/2025-01/control-plane/delete_index"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-01/db_control_2025-01.oas.yaml patch /indexes/{index_name}","title":"Configure an index","href":"/reference/api/2025-01/control-plane/configure_index"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-01/db_data_2025-01.oas.yaml post /describe_index_stats","title":"Get index stats","href":"/reference/api/2025-01/data-plane/describeindexstats"}]},{"group":"Vectors","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-01/db_data_2025-01.oas.yaml post /vectors/upsert","title":"Upsert vectors","href":"/reference/api/2025-01/data-plane/upsert"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-01/db_data_2025-01.oas.yaml post /records/namespaces/{namespace}/upsert","title":"Upsert text","href":"/reference/api/2025-01/data-plane/upsert_records"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-01/db_data_2025-01.oas.yaml get /vectors/fetch","title":"Fetch vectors","href":"/reference/api/2025-01/data-plane/fetch"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-01/db_data_2025-01.oas.yaml post /vectors/update","title":"Update a vector","href":"/reference/api/2025-01/data-plane/update"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-01/db_data_2025-01.oas.yaml post /vectors/delete","title":"Delete vectors","href":"/reference/api/2025-01/data-plane/delete"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-01/db_data_2025-01.oas.yaml get /vectors/list","title":"List vector IDs","href":"/reference/api/2025-01/data-plane/list"}]},{"group":"Search","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-01/db_data_2025-01.oas.yaml post /query","title":"Search with a vector","href":"/reference/api/2025-01/data-plane/query"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-01/db_data_2025-01.oas.yaml post /records/namespaces/{namespace}/search","title":"Search with text","href":"/reference/api/2025-01/data-plane/search_records"}]},{"group":"Imports","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-01/db_data_2025-01.oas.yaml post /bulk/imports","title":"Start import","href":"/reference/api/2025-01/data-plane/start_import"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-01/db_data_2025-01.oas.yaml get /bulk/imports","title":"List imports","href":"/reference/api/2025-01/data-plane/list_imports"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-01/db_data_2025-01.oas.yaml get /bulk/imports/{id}","title":"Describe an import","href":"/reference/api/2025-01/data-plane/describe_import"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-01/db_data_2025-01.oas.yaml delete /bulk/imports/{id}","title":"Cancel an import","href":"/reference/api/2025-01/data-plane/cancel_import"}]},{"group":"Backups","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-01/db_control_2025-01.oas.yaml get /collections","title":"List collections","href":"/reference/api/2025-01/control-plane/list_collections"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-01/db_control_2025-01.oas.yaml post /collections","title":"Create a collection","href":"/reference/api/2025-01/control-plane/create_collection"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-01/db_control_2025-01.oas.yaml get /collections/{collection_name}","title":"Describe a collection","href":"/reference/api/2025-01/control-plane/describe_collection"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-01/db_control_2025-01.oas.yaml delete /collections/{collection_name}","title":"Delete a collection","href":"/reference/api/2025-01/control-plane/delete_collection"}]}]},{"group":"Inference","pages":[{"group":"Embed","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-01/inference_2025-01.oas.yaml post /embed","title":"Generate vectors","href":"/reference/api/2025-01/inference/generate-embeddings"}]},{"group":"Rerank","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-01/inference_2025-01.oas.yaml post /rerank","title":"Rerank results","href":"/reference/api/2025-01/inference/rerank"}]}]},{"group":"SDKs","pages":[{"title":"Pinecone SDKs overview","href":"/reference/pinecone-sdks"},{"group":"Python","pages":[{"title":"Pinecone Python SDK","sidebarTitle":"Overview","href":"/reference/sdks/python/overview"},{"title":"Reference","url":"https://sdk.pinecone.io/python/","href":"/reference/sdks/python/reference"}]},{"group":"Node.js","pages":[{"title":"Pinecone Node.js SDK","sidebarTitle":"Overview","href":"/reference/sdks/node/overview"},{"title":"Reference","url":"https://sdk.pinecone.io/typescript/","href":"/reference/sdks/node/reference"}]},{"group":"Java","pages":[{"title":"Pinecone Java SDK","sidebarTitle":"Overview","href":"/reference/sdks/java/overview"},{"title":"Reference","url":"https://github.com/pinecone-io/pinecone-java-client","href":"/reference/sdks/java/reference"},{"title":"OpenTelemetry support","sidebarTitle":"OpenTelemetry","href":"/reference/sdks/java/open-telemetry"}]},{"group":"Go","pages":[{"title":"Pinecone Go SDK","sidebarTitle":"Overview","href":"/reference/sdks/go/overview"},{"title":"Reference","url":"https://github.com/pinecone-io/go-pinecone","href":"/reference/sdks/go/reference"}]}]},{"group":"CLI","pages":[{"title":"CLI quickstart","sidebarTitle":"Quickstart","href":"/reference/cli/quickstart"},{"title":"CLI command reference","sidebarTitle":"Command reference","href":"/reference/cli/command-reference"},{"title":"CLI authentication","description":"Authenticate the Pinecone CLI using user login, service accounts, or API keys, including auth priority and Admin API access rules.","sidebarTitle":"Authentication","href":"/reference/cli/authentication"},{"title":"CLI target context","sidebarTitle":"Target context","href":"/reference/cli/target-context"}]},{"group":"Tools","pages":[{"title":"Spark-Pinecone connector","description":"Pinecone data tools: Use the connector to efficiently create, ingest, and update vector embeddings at scale with Databricks and Pinecone.","href":"/reference/tools/pinecone-spark-connector"}]}]},{"version":"2024-10","groups":[{"group":"APIs","pages":[{"title":"API reference","sidebarTitle":"Introduction","href":"/reference/api/introduction"},{"title":"Pinecone API authentication","sidebarTitle":"Authentication","href":"/reference/api/authentication"},{"title":"Pinecone API versioning","sidebarTitle":"Versioning","href":"/reference/api/versioning"},{"group":"Database limits","pages":[{"title":"Pinecone Database limits overview","sidebarTitle":"Overview","href":"/reference/api/database-limits"},{"title":"Rate limits","sidebarTitle":"Rate limits","href":"/reference/api/database-limits/rate-limits"},{"title":"Object limits","sidebarTitle":"Object limits","href":"/reference/api/database-limits/object-limits"},{"title":"Operation limits","sidebarTitle":"Operation limits","href":"/reference/api/database-limits/operation-limits"},{"title":"Identifier limits","sidebarTitle":"Identifier limits","href":"/reference/api/database-limits/identifier-limits"},{"title":"Known limitations","href":"/reference/api/known-limitations"}]},{"title":"Pinecone API errors","sidebarTitle":"Errors","href":"/reference/api/errors"}]},{"group":"Database","pages":[{"group":"Indexes","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-10/db_control_2024-10.oas.yaml get /indexes","title":"List indexes","href":"/reference/api/2024-10/control-plane/list_indexes"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-10/db_control_2024-10.oas.yaml post /indexes","title":"Create an index","href":"/reference/api/2024-10/control-plane/create_index"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-10/db_control_2024-10.oas.yaml get /indexes/{index_name}","title":"Describe an index","href":"/reference/api/2024-10/control-plane/describe_index"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-10/db_control_2024-10.oas.yaml delete /indexes/{index_name}","title":"Delete an index","href":"/reference/api/2024-10/control-plane/delete_index"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-10/db_control_2024-10.oas.yaml patch /indexes/{index_name}","title":"Configure an index","href":"/reference/api/2024-10/control-plane/configure_index"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-10/db_data_2024-10.oas.yaml post /describe_index_stats","title":"Get index stats","href":"/reference/api/2024-10/data-plane/describeindexstats"}]},{"group":"Vectors","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-10/db_data_2024-10.oas.yaml post /vectors/upsert","title":"Upsert vectors","href":"/reference/api/2024-10/data-plane/upsert"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-10/db_data_2024-10.oas.yaml post /query","title":"Search with a vector","href":"/reference/api/2024-10/data-plane/query"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-10/db_data_2024-10.oas.yaml get /vectors/fetch","title":"Fetch vectors","href":"/reference/api/2024-10/data-plane/fetch"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-10/db_data_2024-10.oas.yaml post /vectors/update","title":"Update a vector","href":"/reference/api/2024-10/data-plane/update"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-10/db_data_2024-10.oas.yaml post /vectors/delete","title":"Delete vectors","href":"/reference/api/2024-10/data-plane/delete"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-10/db_data_2024-10.oas.yaml get /vectors/list","title":"List vector IDs","href":"/reference/api/2024-10/data-plane/list"}]},{"group":"Imports","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-10/db_data_2024-10.oas.yaml post /bulk/imports","title":"Start import","href":"/reference/api/2024-10/data-plane/start_import"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-10/db_data_2024-10.oas.yaml get /bulk/imports","title":"List imports","href":"/reference/api/2024-10/data-plane/list_imports"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-10/db_data_2024-10.oas.yaml get /bulk/imports/{id}","title":"Describe an import","href":"/reference/api/2024-10/data-plane/describe_import"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-10/db_data_2024-10.oas.yaml delete /bulk/imports/{id}","title":"Cancel an import","href":"/reference/api/2024-10/data-plane/cancel_import"}]},{"group":"Backups","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-10/db_control_2024-10.oas.yaml get /collections","title":"List collections","href":"/reference/api/2024-10/control-plane/list_collections"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-10/db_control_2024-10.oas.yaml post /collections","title":"Create a collection","href":"/reference/api/2024-10/control-plane/create_collection"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-10/db_control_2024-10.oas.yaml get /collections/{collection_name}","title":"Describe a collection","href":"/reference/api/2024-10/control-plane/describe_collection"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-10/db_control_2024-10.oas.yaml delete /collections/{collection_name}","title":"Delete a collection","href":"/reference/api/2024-10/control-plane/delete_collection"}]}]},{"group":"Inference","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-10/inference_2024-10.oas.yaml post /embed","title":"Generate vectors","href":"/reference/api/2024-10/inference/generate-embeddings"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-10/inference_2024-10.oas.yaml post /rerank","title":"Rerank results","href":"/reference/api/2024-10/inference/rerank"}]},{"group":"SDKs","pages":[{"title":"Pinecone SDKs overview","href":"/reference/pinecone-sdks"},{"group":"Python","pages":[{"title":"Pinecone Python SDK","sidebarTitle":"Overview","href":"/reference/sdks/python/overview"},{"title":"Reference","url":"https://sdk.pinecone.io/python/","href":"/reference/sdks/python/reference"}]},{"group":"Node.js","pages":[{"title":"Pinecone Node.js SDK","sidebarTitle":"Overview","href":"/reference/sdks/node/overview"},{"title":"Reference","url":"https://sdk.pinecone.io/typescript/","href":"/reference/sdks/node/reference"}]},{"group":"Java","pages":[{"title":"Pinecone Java SDK","sidebarTitle":"Overview","href":"/reference/sdks/java/overview"},{"title":"Reference","url":"https://github.com/pinecone-io/pinecone-java-client","href":"/reference/sdks/java/reference"},{"title":"OpenTelemetry support","sidebarTitle":"OpenTelemetry","href":"/reference/sdks/java/open-telemetry"}]},{"group":"Go","pages":[{"title":"Pinecone Go SDK","sidebarTitle":"Overview","href":"/reference/sdks/go/overview"},{"title":"Reference","url":"https://github.com/pinecone-io/go-pinecone","href":"/reference/sdks/go/reference"}]}]},{"group":"CLI","pages":[{"title":"CLI quickstart","sidebarTitle":"Quickstart","href":"/reference/cli/quickstart"},{"title":"CLI command reference","sidebarTitle":"Command reference","href":"/reference/cli/command-reference"},{"title":"CLI authentication","description":"Authenticate the Pinecone CLI using user login, service accounts, or API keys, including auth priority and Admin API access rules.","sidebarTitle":"Authentication","href":"/reference/cli/authentication"},{"title":"CLI target context","sidebarTitle":"Target context","href":"/reference/cli/target-context"}]},{"group":"Tools","pages":[{"title":"Spark-Pinecone connector","description":"Pinecone data tools: Use the connector to efficiently create, ingest, and update vector embeddings at scale with Databricks and Pinecone.","href":"/reference/tools/pinecone-spark-connector"}]}]},{"version":"2024-07","groups":[{"group":"APIs","pages":[{"title":"API reference","sidebarTitle":"Introduction","href":"/reference/api/introduction"},{"title":"Pinecone API authentication","sidebarTitle":"Authentication","href":"/reference/api/authentication"},{"title":"Pinecone API versioning","sidebarTitle":"Versioning","href":"/reference/api/versioning"},{"group":"Database limits","pages":[{"title":"Pinecone Database limits overview","sidebarTitle":"Overview","href":"/reference/api/database-limits"},{"title":"Rate limits","sidebarTitle":"Rate limits","href":"/reference/api/database-limits/rate-limits"},{"title":"Object limits","sidebarTitle":"Object limits","href":"/reference/api/database-limits/object-limits"},{"title":"Operation limits","sidebarTitle":"Operation limits","href":"/reference/api/database-limits/operation-limits"},{"title":"Identifier limits","sidebarTitle":"Identifier limits","href":"/reference/api/database-limits/identifier-limits"},{"title":"Known limitations","href":"/reference/api/known-limitations"}]},{"title":"Pinecone API errors","sidebarTitle":"Errors","href":"/reference/api/errors"}]},{"group":"Database","pages":[{"group":"Indexes","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-07/control_2024-07.oas.yaml get /indexes","title":"List indexes","href":"/reference/api/2024-07/control-plane/list_indexes"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-07/control_2024-07.oas.yaml post /indexes","title":"Create an index","href":"/reference/api/2024-07/control-plane/create_index"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-07/control_2024-07.oas.yaml get /indexes/{index_name}","title":"Describe an index","href":"/reference/api/2024-07/control-plane/describe_index"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-07/control_2024-07.oas.yaml delete /indexes/{index_name}","title":"Delete an index","href":"/reference/api/2024-07/control-plane/delete_index"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-07/control_2024-07.oas.yaml patch /indexes/{index_name}","title":"Configure an index","href":"/reference/api/2024-07/control-plane/configure_index"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-07/data_2024-07.oas.yaml post /describe_index_stats","title":"Get index stats","href":"/reference/api/2024-07/data-plane/describeindexstats"}]},{"group":"Vectors","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-07/data_2024-07.oas.yaml post /vectors/upsert","title":"Upsert vectors","href":"/reference/api/2024-07/data-plane/upsert"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-07/data_2024-07.oas.yaml post /query","title":"Search with a vector","href":"/reference/api/2024-07/data-plane/query"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-07/data_2024-07.oas.yaml get /vectors/fetch","title":"Fetch vectors","href":"/reference/api/2024-07/data-plane/fetch"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-07/data_2024-07.oas.yaml post /vectors/update","title":"Update a vector","href":"/reference/api/2024-07/data-plane/update"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-07/data_2024-07.oas.yaml post /vectors/delete","title":"Delete vectors","href":"/reference/api/2024-07/data-plane/delete"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-07/data_2024-07.oas.yaml get /vectors/list","title":"List vector IDs","href":"/reference/api/2024-07/data-plane/list"}]},{"group":"Backups","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-07/control_2024-07.oas.yaml get /collections","title":"List collections","href":"/reference/api/2024-07/control-plane/list_collections"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-07/control_2024-07.oas.yaml post /collections","title":"Create a collection","href":"/reference/api/2024-07/control-plane/create_collection"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-07/control_2024-07.oas.yaml get /collections/{collection_name}","title":"Describe a collection","href":"/reference/api/2024-07/control-plane/describe_collection"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-07/control_2024-07.oas.yaml delete /collections/{collection_name}","title":"Delete a collection","href":"/reference/api/2024-07/control-plane/delete_collection"}]}]},{"group":"SDKs","pages":[{"title":"Pinecone SDKs overview","href":"/reference/pinecone-sdks"},{"group":"Python","pages":[{"title":"Pinecone Python SDK","sidebarTitle":"Overview","href":"/reference/sdks/python/overview"},{"title":"Reference","url":"https://sdk.pinecone.io/python/","href":"/reference/sdks/python/reference"}]},{"group":"Node.js","pages":[{"title":"Pinecone Node.js SDK","sidebarTitle":"Overview","href":"/reference/sdks/node/overview"},{"title":"Reference","url":"https://sdk.pinecone.io/typescript/","href":"/reference/sdks/node/reference"}]},{"group":"Java","pages":[{"title":"Pinecone Java SDK","sidebarTitle":"Overview","href":"/reference/sdks/java/overview"},{"title":"Reference","url":"https://github.com/pinecone-io/pinecone-java-client","href":"/reference/sdks/java/reference"},{"title":"OpenTelemetry support","sidebarTitle":"OpenTelemetry","href":"/reference/sdks/java/open-telemetry"}]},{"group":"Go","pages":[{"title":"Pinecone Go SDK","sidebarTitle":"Overview","href":"/reference/sdks/go/overview"},{"title":"Reference","url":"https://github.com/pinecone-io/go-pinecone","href":"/reference/sdks/go/reference"}]}]},{"group":"CLI","pages":[{"title":"CLI quickstart","sidebarTitle":"Quickstart","href":"/reference/cli/quickstart"},{"title":"CLI command reference","sidebarTitle":"Command reference","href":"/reference/cli/command-reference"},{"title":"CLI authentication","description":"Authenticate the Pinecone CLI using user login, service accounts, or API keys, including auth priority and Admin API access rules.","sidebarTitle":"Authentication","href":"/reference/cli/authentication"},{"title":"CLI target context","sidebarTitle":"Target context","href":"/reference/cli/target-context"}]},{"group":"Tools","pages":[{"title":"Spark-Pinecone connector","description":"Pinecone data tools: Use the connector to efficiently create, ingest, and update vector embeddings at scale with Databricks and Pinecone.","href":"/reference/tools/pinecone-spark-connector"}]}]},{"version":"2024-04","groups":[{"group":"APIs","pages":[{"title":"API reference","sidebarTitle":"Introduction","href":"/reference/api/introduction"},{"title":"Pinecone API authentication","sidebarTitle":"Authentication","href":"/reference/api/authentication"},{"title":"Pinecone API versioning","sidebarTitle":"Versioning","href":"/reference/api/versioning"},{"group":"Database limits","pages":[{"title":"Pinecone Database limits overview","sidebarTitle":"Overview","href":"/reference/api/database-limits"},{"title":"Rate limits","sidebarTitle":"Rate limits","href":"/reference/api/database-limits/rate-limits"},{"title":"Object limits","sidebarTitle":"Object limits","href":"/reference/api/database-limits/object-limits"},{"title":"Operation limits","sidebarTitle":"Operation limits","href":"/reference/api/database-limits/operation-limits"},{"title":"Identifier limits","sidebarTitle":"Identifier limits","href":"/reference/api/database-limits/identifier-limits"},{"title":"Known limitations","href":"/reference/api/known-limitations"}]},{"title":"Pinecone API errors","sidebarTitle":"Errors","href":"/reference/api/errors"}]},{"group":"Database","pages":[{"group":"Indexes","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-04/control_2024-04.oas.yaml get /indexes","title":"List indexes","href":"/reference/api/2024-04/control-plane/list_indexes"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-04/control_2024-04.oas.yaml post /indexes","title":"Create an index","href":"/reference/api/2024-04/control-plane/create_index"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-04/control_2024-04.oas.yaml get /indexes/{index_name}","title":"Describe an index","href":"/reference/api/2024-04/control-plane/describe_index"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-04/control_2024-04.oas.yaml delete /indexes/{index_name}","title":"Delete an index","href":"/reference/api/2024-04/control-plane/delete_index"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-04/control_2024-04.oas.yaml patch /indexes/{index_name}","title":"Configure an index","href":"/reference/api/2024-04/control-plane/configure_index"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-04/data_2024-04.oas.yaml post /describe_index_stats","title":"Get index stats","href":"/reference/api/2024-04/data-plane/describeindexstats"}]},{"group":"Vectors","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-04/data_2024-04.oas.yaml post /vectors/upsert","title":"Upsert vectors","href":"/reference/api/2024-04/data-plane/upsert"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-04/data_2024-04.oas.yaml post /query","title":"Search with a vector","href":"/reference/api/2024-04/data-plane/query"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-04/data_2024-04.oas.yaml get /vectors/fetch","title":"Fetch vectors","href":"/reference/api/2024-04/data-plane/fetch"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-04/data_2024-04.oas.yaml post /vectors/update","title":"Update a vector","href":"/reference/api/2024-04/data-plane/update"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-04/data_2024-04.oas.yaml post /vectors/delete","title":"Delete vectors","href":"/reference/api/2024-04/data-plane/delete"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-10/db_data_2024-10.oas.yaml get /vectors/list","title":"List vector IDs","href":"/reference/api/2024-04/data-plane/list"}]},{"group":"Backups","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-04/control_2024-04.oas.yaml get /collections","title":"List collections","href":"/reference/api/2024-04/control-plane/list_collections"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-04/control_2024-04.oas.yaml post /collections","title":"Create a collection","href":"/reference/api/2024-04/control-plane/create_collection"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-04/control_2024-04.oas.yaml get /collections/{collection_name}","title":"Describe a collection","href":"/reference/api/2024-04/control-plane/describe_collection"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-04/control_2024-04.oas.yaml delete /collections/{collection_name}","title":"Delete a collection","href":"/reference/api/2024-04/control-plane/delete_collection"}]}]},{"group":"SDKs","pages":[{"title":"Pinecone SDKs overview","href":"/reference/pinecone-sdks"},{"group":"Python","pages":[{"title":"Pinecone Python SDK","sidebarTitle":"Overview","href":"/reference/sdks/python/overview"},{"title":"Reference","url":"https://sdk.pinecone.io/python/","href":"/reference/sdks/python/reference"}]},{"group":"Node.js","pages":[{"title":"Pinecone Node.js SDK","sidebarTitle":"Overview","href":"/reference/sdks/node/overview"},{"title":"Reference","url":"https://sdk.pinecone.io/typescript/","href":"/reference/sdks/node/reference"}]},{"group":"Java","pages":[{"title":"Pinecone Java SDK","sidebarTitle":"Overview","href":"/reference/sdks/java/overview"},{"title":"Reference","url":"https://github.com/pinecone-io/pinecone-java-client","href":"/reference/sdks/java/reference"},{"title":"OpenTelemetry support","sidebarTitle":"OpenTelemetry","href":"/reference/sdks/java/open-telemetry"}]},{"group":"Go","pages":[{"title":"Pinecone Go SDK","sidebarTitle":"Overview","href":"/reference/sdks/go/overview"},{"title":"Reference","url":"https://github.com/pinecone-io/go-pinecone","href":"/reference/sdks/go/reference"}]}]},{"group":"CLI","pages":[{"title":"CLI quickstart","sidebarTitle":"Quickstart","href":"/reference/cli/quickstart"},{"title":"CLI command reference","sidebarTitle":"Command reference","href":"/reference/cli/command-reference"},{"title":"CLI authentication","description":"Authenticate the Pinecone CLI using user login, service accounts, or API keys, including auth priority and Admin API access rules.","sidebarTitle":"Authentication","href":"/reference/cli/authentication"},{"title":"CLI target context","sidebarTitle":"Target context","href":"/reference/cli/target-context"}]},{"group":"Tools","pages":[{"title":"Spark-Pinecone connector","description":"Pinecone data tools: Use the connector to efficiently create, ingest, and update vector embeddings at scale with Databricks and Pinecone.","href":"/reference/tools/pinecone-spark-connector"}]}]}]},{"tab":"Examples","pages":[{"title":"Examples","href":"/examples/notebooks"}]},{"tab":"Models","pages":[{"title":"Models","href":"/models/overview"}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/integrations/overview"}]},{"tab":"Admin","pages":[{"title":"Admin","href":"/admin/organizations/understanding-organizations"}]}]},{"dropdown":"Pinecone Assistant","icon":"comments","tabs":[{"tab":"Guides","groups":[{"group":"Get started","pages":[{"title":"Pinecone Assistant","sidebarTitle":"Overview","mode":"wide","href":"/guides/assistant/overview"},{"group":"Quickstart","pages":[{"title":"Pinecone Assistant: SDK quickstart","sidebarTitle":"SDK quickstart","href":"/guides/assistant/quickstart/sdk-quickstart"},{"title":"Pinecone Assistant: n8n quickstart","sidebarTitle":"n8n quickstart","href":"/guides/assistant/quickstart/n8n-quickstart"}]}]},{"group":"Build an assistant","pages":[{"title":"Create an assistant","mode":"wide","href":"/guides/assistant/create-assistant"},{"title":"Manage assistants","href":"/guides/assistant/manage-assistants"}]},{"group":"Upload your data","pages":[{"title":"Files in Pinecone Assistant","sidebarTitle":"Overview","href":"/guides/assistant/files-overview"},{"title":"Upload files","href":"/guides/assistant/upload-files"},{"title":"Multimodal context for assistants","sidebarTitle":"Multimodal context","href":"/guides/assistant/multimodal"},{"title":"Manage files","href":"/guides/assistant/manage-files"}]},{"group":"Chat with an assistant","pages":[{"title":"Chat through the standard interface","sidebarTitle":"Standard interface","href":"/guides/assistant/chat-with-assistant"},{"title":"Chat through the OpenAI-compatible interface","sidebarTitle":"OpenAI-compatible interface","href":"/guides/assistant/chat-through-the-openai-compatible-interface"}]},{"group":"Evaluate answers","pages":[{"title":"Evaluation overview","sidebarTitle":"Overview","href":"/guides/assistant/evaluation-overview"},{"title":"Evaluate answers","mode":"wide","href":"/guides/assistant/evaluate-answers"}]},{"group":"Retrieve context snippets","pages":[{"title":"Context snippets overview","sidebarTitle":"Overview","href":"/guides/assistant/context-snippets-overview"},{"title":"Retrieve context snippets","href":"/guides/assistant/retrieve-context-snippets"}]},{"group":"Integrate with AI agents","pages":[{"title":"Use an Assistant MCP server","sidebarTitle":"Use an MCP server","href":"/guides/assistant/mcp-server"}]},{"group":"Admin","pages":[{"title":"Pinecone Assistant pricing and limits","sidebarTitle":"Pricing and limits","href":"/guides/assistant/pricing-and-limits"},{"title":"Monitor usage and cost","href":"/guides/assistant/admin/monitor-spend-and-usage"},{"title":"Billing and access","url":"/admin/organizations/understanding-organizations","href":"/guides/assistant/admin-link"}]}]},{"tab":"Reference","versions":[{"version":"2026-07 (latest)","default":true,"groups":[{"group":"APIs","pages":[{"title":"Assistant API reference","sidebarTitle":"Introduction","href":"/reference/api/assistant/introduction"},{"title":"Pinecone Assistant API authentication","sidebarTitle":"Authentication","href":"/reference/api/assistant/authentication"},{"title":"Pinecone Assistant limits","sidebarTitle":"Limits","href":"/reference/api/assistant/assistant-limits"}]},{"group":"Assistants","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/assistant_control_2026-07.oas.yaml GET /assistants","title":"List assistants","href":"/reference/api/2026-07/assistant/list_assistants"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/assistant_control_2026-07.oas.yaml POST /assistants","title":"Create an assistant","href":"/reference/api/2026-07/assistant/create_assistant"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/assistant_control_2026-07.oas.yaml GET /assistants/{assistant_name}","title":"Check assistant status","href":"/reference/api/2026-07/assistant/describe_assistant"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/assistant_control_2026-07.oas.yaml PATCH /assistants/{assistant_name}","title":"Update an assistant","href":"/reference/api/2026-07/assistant/update_assistant"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/assistant_control_2026-07.oas.yaml DELETE /assistants/{assistant_name}","title":"Delete an assistant","href":"/reference/api/2026-07/assistant/delete_assistant"}]},{"group":"Files","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/assistant_data_2026-07.oas.yaml GET /files/{assistant_name}","title":"List Files","href":"/reference/api/2026-07/assistant/list_files"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/assistant_data_2026-07.oas.yaml POST /files/{assistant_name}","title":"Upload a file","href":"/reference/api/2026-07/assistant/upload_file"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/assistant_data_2026-07.oas.yaml PUT /files/{assistant_name}/{assistant_file_id}","title":"Upsert a file","href":"/reference/api/2026-07/assistant/upsert_file"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/assistant_data_2026-07.oas.yaml GET /files/{assistant_name}/{assistant_file_id}","title":"Describe a file","href":"/reference/api/2026-07/assistant/describe_file"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/assistant_data_2026-07.oas.yaml DELETE /files/{assistant_name}/{assistant_file_id}","title":"Delete a file","href":"/reference/api/2026-07/assistant/delete_file"}]},{"group":"Operations","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/assistant_data_2026-07.oas.yaml GET /operations/{assistant_name}","title":"List operations","href":"/reference/api/2026-07/assistant/list_operations"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/assistant_data_2026-07.oas.yaml GET /operations/{assistant_name}/{operation_id}","title":"Describe an operation","href":"/reference/api/2026-07/assistant/describe_operation"}]},{"group":"Chat","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/assistant_data_2026-07.oas.yaml POST /chat/{assistant_name}","title":"Chat with an assistant","href":"/reference/api/2026-07/assistant/chat_assistant"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/assistant_data_2026-07.oas.yaml POST /chat/{assistant_name}/chat/completions","title":"Chat through an OpenAI-compatible interface","href":"/reference/api/2026-07/assistant/chat_completion_assistant"}]},{"group":"Evaluation","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/assistant_evaluation_2026-07.oas.yaml POST /evaluation/metrics/alignment","title":"Evaluate an answer","href":"/reference/api/2026-07/assistant/metrics_alignment"}]},{"group":"Context snippets","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/assistant_data_2026-07.oas.yaml POST /chat/{assistant_name}/context","title":"Retrieve context from an assistant","href":"/reference/api/2026-07/assistant/context_assistant"}]},{"group":"Admin","pages":[{"group":"API keys","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml post /admin/projects/{project_id}/api-keys","title":"Create an API key","href":"/reference/api/2026-04/admin-assistant/create_api_key"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml get /admin/projects/{project_id}/api-keys","title":"List API keys","href":"/reference/api/2026-04/admin-assistant/list_api_keys"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml get /admin/api-keys/{api_key_id}","title":"Get API key details","href":"/reference/api/2026-04/admin-assistant/fetch_api_key"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml patch /admin/api-keys/{api_key_id}","title":"Update an API key","href":"/reference/api/2026-04/admin-assistant/update_api_key"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml delete /admin/api-keys/{api_key_id}","title":"Delete an API key","href":"/reference/api/2026-04/admin-assistant/delete_api_key"}]},{"group":"Projects","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml post /admin/projects","title":"Create a new project","href":"/reference/api/2026-04/admin-assistant/create_project"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml get /admin/projects","title":"List projects","href":"/reference/api/2026-04/admin-assistant/list_projects"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml get /admin/projects/{project_id}","title":"Get project details","href":"/reference/api/2026-04/admin-assistant/fetch_project"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml patch /admin/projects/{project_id}","title":"Update a project","href":"/reference/api/2026-04/admin-assistant/update_project"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml delete /admin/projects/{project_id}","title":"Delete a project","href":"/reference/api/2026-04/admin-assistant/delete_project"}]},{"group":"Service accounts","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/oauth_2026-04.oas.yaml post /oauth/token","title":"Create an access token","href":"/reference/api/2026-04/admin-assistant/get_token"}]}]},{"group":"Architecture","pages":[{"title":"Pinecone Assistant architecture","sidebarTitle":"Assistant architecture","href":"/reference/architecture/assistant-architecture"}]}]},{"version":"2026-04","pages":[{"title":"2026-04","href":"/reference/api/assistant/introduction"}]},{"version":"2025-10","pages":[{"title":"2025-10","href":"/reference/api/assistant/introduction"}]},{"version":"2025-04","pages":[{"title":"2025-04","href":"/reference/api/assistant/introduction"}]},{"version":"2025-01","pages":[{"title":"2025-01","href":"/reference/api/assistant/introduction"}]}]},{"tab":"Examples","pages":[{"title":"Assistant examples","href":"/examples/assistant"}]}]},{"dropdown":"Pinecone Nexus","icon":"brain-circuit","tabs":[{"tab":"Guides","groups":[{"group":"Get started","pages":[{"title":"Pinecone Nexus","sidebarTitle":"Overview","mode":"wide","href":"/guides/nexus/overview"},{"title":"Nexus quickstart","sidebarTitle":"Quickstart","href":"/guides/nexus/quickstart"},{"title":"Nexus key concepts","sidebarTitle":"Key concepts","href":"/guides/nexus/concepts"}]},{"group":"The knowledge engine","pages":[{"title":"How Nexus works","sidebarTitle":"How Nexus works","href":"/guides/nexus/how-it-works"},{"group":"Context design","pages":[{"title":"Context design overview","sidebarTitle":"Overview","href":"/guides/nexus/context-design"},{"title":"Design your own manifest","sidebarTitle":"Design your own manifest","href":"/guides/nexus/design-your-own-manifest"},{"title":"Configure artifact formats","sidebarTitle":"Configure artifact formats","href":"/guides/nexus/configure-artifact-formats"}]},{"title":"Nexus curation","sidebarTitle":"Curation","href":"/guides/nexus/how-curation-works"},{"title":"Nexus model guidance","href":"/guides/nexus/models"},{"group":"Queries and sessions","pages":[{"title":"Nexus queries","sidebarTitle":"Queries","href":"/guides/nexus/queries"},{"title":"Set session instructions","sidebarTitle":"Set session instructions","href":"/guides/nexus/set-session-instructions"},{"title":"Query tracing","sidebarTitle":"Query tracing","href":"/guides/nexus/query-tracing"}]}]},{"group":"Tools","pages":[{"title":"Pinecone Nexus MCP server","sidebarTitle":"MCP server","href":"/guides/nexus/mcp-server"}]},{"group":"Bring Your Own Cloud","pages":[{"title":"Nexus BYOC overview","sidebarTitle":"Overview","href":"/guides/nexus/byoc/overview"},{"title":"Nexus BYOC data residency and limits","sidebarTitle":"Residency and limits","href":"/guides/nexus/byoc/reference"},{"title":"Deploy Nexus BYOC","sidebarTitle":"Deploy","href":"/guides/nexus/byoc/deploy"}]}]},{"tab":"Reference","groups":[{"group":"APIs","pages":[{"title":"Pinecone Nexus API","sidebarTitle":"Introduction","href":"/reference/api/nexus/introduction"},{"title":"Pinecone Nexus API authentication","sidebarTitle":"Authentication","href":"/reference/api/nexus/authentication"}]},{"group":"Control plane","pages":[{"group":"Manage Workspaces","pages":[{"title":"List workspaces","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_control_2026-07.oas.yaml get /workspaces","href":"/api-reference/manage-workspaces/list-workspaces"},{"title":"Create a workspace","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_control_2026-07.oas.yaml post /workspaces","href":"/api-reference/manage-workspaces/create-a-workspace"},{"title":"Describe a workspace","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_control_2026-07.oas.yaml get /workspaces/{workspace_name}","href":"/api-reference/manage-workspaces/describe-a-workspace"},{"title":"Delete a workspace","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_control_2026-07.oas.yaml delete /workspaces/{workspace_name}","href":"/api-reference/manage-workspaces/delete-a-workspace"}]}]},{"group":"Data plane","pages":[{"group":"Auth","pages":[{"title":"Exchange a Pinecone API key for a session token","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml post /auth/login","href":"/api-reference/auth/exchange-a-pinecone-api-key-for-a-session-token"},{"title":"Current identity (whoami)","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /auth","href":"/api-reference/auth/current-identity-whoami"}]},{"group":"Project","pages":[{"title":"Get the active project","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /project","href":"/api-reference/project/get-the-active-project"},{"title":"Project-wide task stats","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /stats","href":"/api-reference/project/project-wide-task-stats"}]},{"group":"Connectors","pages":[{"title":"List the project's linked connectors","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /connectors","href":"/api-reference/connectors/list-the-projects-linked-connectors"},{"title":"Get a connector","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /connectors/{id}","href":"/api-reference/connectors/get-a-connector"},{"title":"Unlink a connector","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml delete /connectors/{id}","href":"/api-reference/connectors/unlink-a-connector"},{"title":"Start the OAuth link flow for a provider","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /connectors/oauth/{provider}/start","href":"/api-reference/connectors/start-the-oauth-link-flow-for-a-provider"},{"title":"Link a connector with an API key","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml post /connectors/keys/{provider}","href":"/api-reference/connectors/link-a-connector-with-an-api-key"},{"title":"Browse a connector's folders/files","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /connectors/{id}/items","href":"/api-reference/connectors/browse-a-connectors-foldersfiles"},{"title":"List a context's connectors (with per-context enabled flag)","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /contexts/{slug}/connectors","href":"/api-reference/connectors/list-a-contexts-connectors-with-per-context-enabled-flag"},{"title":"Enable or disable a connector for a context","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml put /contexts/{slug}/connectors/{connector_id}","href":"/api-reference/connectors/enable-or-disable-a-connector-for-a-context"}]},{"group":"Contexts","pages":[{"title":"List contexts (newest first, with stats)","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /contexts","href":"/api-reference/contexts/list-contexts-newest-first-with-stats"},{"title":"Create a context","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml post /contexts","href":"/api-reference/contexts/create-a-context"},{"title":"Get a context","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /contexts/{slug}","href":"/api-reference/contexts/get-a-context"},{"title":"Update a context","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml put /contexts/{slug}","href":"/api-reference/contexts/update-a-context"},{"title":"Delete a context (and its Pinecone indexes)","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml delete /contexts/{slug}","href":"/api-reference/contexts/delete-a-context-and-its-pinecone-indexes"},{"title":"Per-context task statistics","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /contexts/{slug}/tasks/stats","href":"/api-reference/contexts/per-context-task-statistics"},{"title":"Trigger an on-demand self-tuning optimize","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml post /contexts/{slug}/optimize","href":"/api-reference/contexts/trigger-an-on-demand-self-tuning-optimize"},{"title":"Run the Design-flow explore agent (propose a manifest)","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml post /contexts/{slug}/explore","href":"/api-reference/contexts/run-the-design-flow-explore-agent-propose-a-manifest"},{"title":"Estimate the token + time cost of curating the in-progress manifest","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml post /contexts/{slug}/profile","href":"/api-reference/contexts/estimate-the-token-+-time-cost-of-curating-the-in-progress-manifest"}]},{"group":"Manifest","pages":[{"title":"Get the context's manifest","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /contexts/{slug}/manifest","href":"/api-reference/manifest/get-the-contexts-manifest"},{"title":"List the built-in manifest templates","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /manifest/templates","href":"/api-reference/manifest/list-the-built-in-manifest-templates"}]},{"group":"Curation","pages":[{"title":"Get the curation ledger","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /contexts/{slug}/curate","href":"/api-reference/curation/get-the-curation-ledger"},{"title":"Build or rebuild the context's index from its sources","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml post /contexts/{slug}/curate","href":"/api-reference/curation/build-or-rebuild-the-contexts-index-from-its-sources"},{"title":"Drop named sources from the index + ledger","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml post /contexts/{slug}/curate/delete-sources","href":"/api-reference/curation/drop-named-sources-from-the-index-+-ledger"}]},{"group":"Source Files","pages":[{"title":"Import source documents from a project connector","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml post /contexts/{slug}/import","href":"/api-reference/source-files/import-source-documents-from-a-project-connector"},{"title":"Upload a source file or archive","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml post /contexts/{slug}/import/upload","href":"/api-reference/source-files/upload-a-source-file-or-archive"},{"title":"List the source file tree (root)","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /contexts/{slug}/source/list","href":"/api-reference/source-files/list-the-source-file-tree-root"},{"title":"Source file/dir/size counts","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /contexts/{slug}/source/stats","href":"/api-reference/source-files/source-filedirsize-counts"},{"title":"Flat manifest of source files (path, size, last_modified)","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /contexts/{slug}/source/manifest","href":"/api-reference/source-files/flat-manifest-of-source-files-path-size-last_modified"},{"title":"List the source file tree under a path","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /contexts/{slug}/source/list/{path}","href":"/api-reference/source-files/list-the-source-file-tree-under-a-path"},{"title":"Read a source file (raw bytes)","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /contexts/{slug}/source/read/{path}","href":"/api-reference/source-files/read-a-source-file-raw-bytes"},{"title":"Delete a source file","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml delete /contexts/{slug}/source/delete/{path}","href":"/api-reference/source-files/delete-a-source-file"}]},{"group":"Knowledge","pages":[{"title":"List curated knowledge (root)","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /contexts/{slug}/knowledge/list","href":"/api-reference/knowledge/list-curated-knowledge-root"},{"title":"Knowledge file/dir/size counts","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /contexts/{slug}/knowledge/stats","href":"/api-reference/knowledge/knowledge-filedirsize-counts"},{"title":"List curated knowledge under a path","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /contexts/{slug}/knowledge/list/{path}","href":"/api-reference/knowledge/list-curated-knowledge-under-a-path"},{"title":"Read a curated knowledge file (raw bytes)","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /contexts/{slug}/knowledge/read/{path}","href":"/api-reference/knowledge/read-a-curated-knowledge-file-raw-bytes"}]},{"group":"Query","pages":[{"title":"Run one KnowQL query turn","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml post /query","href":"/api-reference/query/run-one-knowql-query-turn"},{"title":"Fetch one query (turn)","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /queries/{id}","href":"/api-reference/query/fetch-one-query-turn"},{"title":"Cancel an in-progress query turn","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml post /queries/{id}/cancel","href":"/api-reference/query/cancel-an-in-progress-query-turn"},{"title":"Fetch the recorded trace for a query turn","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /queries/{id}/trace","href":"/api-reference/query/fetch-the-recorded-trace-for-a-query-turn"},{"title":"Stream a query turn's events (SSE)","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /queries/{id}/events","href":"/api-reference/query/stream-a-query-turns-events-sse"},{"title":"Record thumbs-up/down feedback on a query turn","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml post /queries/{id}/feedback","href":"/api-reference/query/record-thumbs-updown-feedback-on-a-query-turn"},{"title":"List the selectable query models","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /models","href":"/api-reference/query/list-the-selectable-query-models"},{"title":"List project-wide query sessions (newest first)","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /sessions","href":"/api-reference/query/list-project-wide-query-sessions-newest-first"},{"title":"Get a session with its queries (conversation order)","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /sessions/{id}","href":"/api-reference/query/get-a-session-with-its-queries-conversation-order"},{"title":"Delete a session and its queries","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml delete /sessions/{id}","href":"/api-reference/query/delete-a-session-and-its-queries"}]},{"group":"Tasks","pages":[{"title":"List tasks (project-wide, paginated)","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /tasks","href":"/api-reference/tasks/list-tasks-project-wide-paginated"},{"title":"Get a task (with steps)","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /tasks/{id}","href":"/api-reference/tasks/get-a-task-with-steps"},{"title":"Cancel/terminate a task","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml delete /tasks/{id}","href":"/api-reference/tasks/cancelterminate-a-task"}]},{"group":"Task Files","pages":[{"title":"Read a task file (raw bytes)","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /tasks/{id}/files/read/{path}","href":"/api-reference/task-files/read-a-task-file-raw-bytes"},{"title":"Stat a task file","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /tasks/{id}/files/metadata/{path}","href":"/api-reference/task-files/stat-a-task-file"},{"title":"List a task's files under a path","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /tasks/{id}/files/list/{path}","href":"/api-reference/task-files/list-a-tasks-files-under-a-path"},{"title":"List a task's working-directory files","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /tasks/{id}/files/list","href":"/api-reference/task-files/list-a-tasks-working-directory-files"},{"title":"Delete a task file","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml delete /tasks/{id}/files/delete/{path}","href":"/api-reference/task-files/delete-a-task-file"}]}]}]}]},{"dropdown":"pg_pinecone","icon":"elephant","tabs":[{"tab":"Guides","groups":[{"group":"Get started","pages":[{"title":"pg_pinecone","sidebarTitle":"Overview","href":"/guides/pg-pinecone/overview"},{"title":"pg_pinecone quickstart","sidebarTitle":"Quickstart","href":"/guides/pg-pinecone/quickstart"}]},{"group":"Build","pages":[{"title":"pg_pinecone storage engines","sidebarTitle":"Storage engines","href":"/guides/pg-pinecone/storage-engines"},{"title":"Switch from pgvector to native","href":"/guides/pg-pinecone/switch-from-pgvector"},{"title":"Switch from native to remote","href":"/guides/pg-pinecone/switch-to-remote"},{"title":"Search a table with full-text search","href":"/guides/pg-pinecone/full-text-search"},{"title":"Migrate from pgvector","url":"https://docs.pinecone.io/guides/index-data/migrate-from-pgvector","href":"/guides/pg-pinecone/migrate-from-pgvector"}]},{"group":"Resources","pages":[{"title":"pg_pinecone SQL reference","sidebarTitle":"SQL reference","url":"https://github.com/pinecone-io/pg_pinecone/blob/main/docs/reference.md","href":"/reference/pg-pinecone/sql-reference"},{"title":"pg_pinecone operator runbook","sidebarTitle":"Operator runbook","url":"https://github.com/pinecone-io/pg_pinecone/blob/main/docs/runbook.md","href":"/reference/pg-pinecone/operator-runbook"},{"title":"pg_pinecone support","sidebarTitle":"Support","href":"/guides/pg-pinecone/support"}]}]}]},{"dropdown":"Changelog","icon":"list","pages":[{"title":"Pinecone 2026 changelog","sidebarTitle":"2026","mode":"wide","href":"/release-notes/2026"},{"title":"Pinecone 2025 changelog","sidebarTitle":"2025","mode":"wide","href":"/release-notes/2025"},{"title":"Pinecone 2024 changelog","sidebarTitle":"2024","mode":"wide","href":"/release-notes/2024"},{"title":"Pinecone 2023 changelog","sidebarTitle":"2023","mode":"wide","href":"/release-notes/2023"},{"title":"Pinecone 2022 changelog","sidebarTitle":"2022","mode":"wide","href":"/release-notes/2022"},{"title":"Pinecone feature availability","sidebarTitle":"Feature availability","mode":"wide","href":"/release-notes/feature-availability"}]}]},"title":"CLI target context - Pinecone Docs","buildId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","deploymentId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","dynamics":[],"chunks":[]}