Session token from POST /auth/login, sent as Authorization: Bearer <token>.
Headers
X-Pinecone-Api-Version
string
default:2026-07
Date-based contract version, echoed back on the same header. Omit for the default (2026-07); send unstable for the in-development surface. An unrecognized value is rejected with 400 unsupported_api_version.
Path Parameters
slug
string
required
Context slug or UUID.
Body
application/json
All fields optional. Empty string for description/guide clears it; {} for manifest clears it back to defaults. Absent leaves untouched. kind is immutable and cannot be updated.
slug
string
Renames the context. Must stay unique within the project.
name
string
New display name.
description
string
New summary. Empty string clears it.
guide
string
New standing instructions. Empty string clears them.
manifest
object
The document that drives curate and search. Sparse: every field is optional and an omitted one falls back to its default, so absent fields are omitted rather than nulled. A change reaches the index on the next curate; rebuilding what is already indexed needs a forced one.
Show child attributes
Response
The updated context
What context endpoints return — the stored context plus the lifecycle flags derived from its in-flight tasks.
id
string
required
Stable UUID. Accepted anywhere {slug} is.
slug
string
required
URL-safe name, unique within the project. Mutable via PUT.
name
string
required
Human-readable display name.
kind
string
default:search
required
How the context is built. search — built from source documents, and must be curated before it can be queried. work — built from traces of work done, queryable immediately, consolidated by groom rather than curate.
created_by
string
required
Principal that created the context.
description
string | null
required
Free-text summary of what the context holds.
is_optimizing
boolean
required
An optimize task is in flight.
has_sources
boolean
required
The source tree holds at least one file. False blocks curate.
is_curating
boolean
required
A curate task is in flight.
is_importing
boolean
required
An import task is in flight.
is_exploring
boolean
required
An explore task is in flight.
is_restoring
boolean
required
A restore task is in flight.
is_grooming
boolean
required
A groom task is in flight. Work contexts only.
created_at
string<date-time>
required
When the context was created.
updated_at
string<date-time>
required
When the context last changed.
workspace
string
Owning workspace. Absent off a workspace-enabled cluster.
guide
string
High-level standing instructions the query runtime reads on every turn.
manifest
object
Pinned manifest document. Absent when the context runs on validator defaults.
Show child attributes
semantic_index
string | null
Host of the index backing this context's vector retrieval. Null until a curate resolves one.
keyword_index
string | null
Host of the index backing keyword retrieval. The same host as semantic_index today — the two names are separate seams over one index.
optimize_task_id
string | null
The optimize task — the running one, or the last to finish.
optimize_score
number<double> | null
Eval pass rate the last optimize's best iteration scored.
optimize_iterations
integer | null
How many candidate manifests the last run tried.
last_optimized_at
string<date-time> | null
When an optimize last persisted a tuned manifest.
last_curated_at
string<date-time> | null
When a curate last flipped a new index version live.
last_source_import_at
string<date-time> | null
When sources were last staged by an upload or import.
curate_task_id
string | null
The curate task — the running one, or the last to finish.
import_task_id
string | null
The import task — the running one, or the last to finish.
explore_task_id
string | null
The explore task — the running one, or the last to finish.
restore_task_id
string | null
The restore task — the running one, or the last to finish.
manifest_suggestion
object
Outcome of the last explore run, pinned to the context row. A proposal only — apply it by writing the manifest and forcing a curate.
Show child attributes
sample_queries
string[]
Example questions the curated corpus can answer, written by the last curate.
One example question.
groom_task_id
string
The groom task — the running one, or the last to finish.
groom_artifact_count
integer<int64>
Artifacts the last groom left in the work context.
last_groomed_at
string<date-time>
When a groom last consolidated the work context.
stats
object
Aggregate task counters. Populated only on the list endpoint.
Show child attributes
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"}},"banner":{"content":"🎉 Limited-time promotion: Double the embedding tokens on every model for Starter and Builder plans through December 31. [See your new limits](/reference/api/database-limits/rate-limits#monthly-usage-limits)","dismissible":true,"color":{"light":"#002BFF","dark":"#002BFF"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":true},"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":""},"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":"6b0224febe68a65cfd3ef5ed","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"Pinecone Database","count":567},{"language":"default","tag":"Reference","count":545},{"language":"default","tag":"Database","count":244},{"language":"default","tag":"Admin","count":151},{"language":"default","tag":"Guides","count":151},{"language":"default","tag":"Pinecone Assistant","count":128},{"language":"default","tag":"Pinecone Nexus","count":81},{"language":"default","tag":"Backups","count":70},{"language":"default","tag":"Indexes","count":65},{"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":"custom-rbac-roles","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":"rbac-expansion","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":"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":"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":"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":"site-roles","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":"full-page-search","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":"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":"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":"turbopuffer-dual-write","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},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"styles.css","content":":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:0.375rem 1rem!important;gap:0.5rem;background-color:var(--brand-blue);color:var(--text-contrast)!important;border-radius:0.25rem;font-weight:500;letter-spacing:0.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:#000000}#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:0.25rem;border:1px solid var(--border);background-color:transparent!important;color:var(--text-primary)}#navbar nav a{color:var(--text-primary);padding:0.6rem 1rem;transition:background-color 250ms cubic-bezier(0.4, 0, 0.2, 1)}#navbar nav ul li:not(:last-of-type){margin-left:0}#navbar a{color:var(--text-primary);margin:0;padding-left:0.875rem;padding-right:0.875rem}#navbar .nav-tabs{gap:0!important}#navbar div.absolute.bottom-0{display:none}#sidebar{left:0rem;padding-left:0;background:var(--background);border-right:1px solid var(--border)}#sidebar div.sticky{visibility:hidden}#sidebar-content{padding-left:0.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:0.625rem}#navbar div:has(>.nav-tabs){padding-left:1.5rem}#sidebar-content .sidebar-group a,#sidebar-content .sidebar-group button{padding-block:0.3125rem;line-height:1.25rem}#sidebar-content .sidebar-group-header{margin-bottom:0.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\"]){padding-inline:1.5rem}div:has(>#sidebar[style*=\"display: none\"]) #content-area{max-width:none;padding-inline:0}}@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:0.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:0.25rem}#sidebar #navigation-items{position:relative}#sidebar-content div.sticky.pointer-events-none{height:1.25rem}#sidebar-content>[data-component-part=\"scroll-area-scrollbar\"][data-orientation=\"vertical\"]{margin-top:3.75rem}#sidebar .nav-dropdown-trigger{width:calc(100% - 0.75rem)}#sidebar .nav-dropdown-trigger .nav-dropdown-item-description{display:none}body:has(#sidebar .nav-dropdown-trigger[aria-expanded=\"true\"]) .nav-dropdown-content{min-width:18rem}.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}}#sidebar-content h5,#sidebar a,#sidebar li div{color:var(--text-primary)}#navigation-items .sidebar-group-header{color:var(--text-secondary);font-size:0.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:0.375rem;font-weight:500}#navigation-items .sidebar-group li>button>div:last-child{margin-left:-0.75rem}#navigation-items .sidebar-group li>button svg{color:var(--text-secondary)}#navigation-items .sidebar-group li>ul{position:relative}#navigation-items .sidebar-group li>ul::before{content:\"\";position:absolute;top:0;bottom:0;left:1rem;border-left:1px solid var(--border)}#table-of-contents .toc-item>ul{position:relative}#table-of-contents .toc-item>ul::before{content:\"\";position:absolute;top:0;bottom:0;left:0.25rem;border-left:1px solid var(--border)}#navigation-items>div>ul>li{margin-left:0.75rem}#navigation-items>div>ul>li a.font-semibold{font-weight:400;background-color:var(--surface)}#content-container>div{padding-top:calc(8.125rem + var(--banner-height, 0px))}#content-area>#content:first-child{margin-top:0}@media (min-width: 1024px){#content-container>div{gap:3rem}body:not(:has(.nav-tabs)) #content-container>div{padding-top:calc(5.25rem + var(--banner-height, 0px))}#content-container #table-of-contents{padding-left:0}}#header .eyebrow,.sample-app-heading .eyebrow{text-transform:uppercase;color:var(--text-primary);font-size:0.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}#header h1{color:var(--text-primary)}.prose h2,.prose h3,.prose h4{color:var(--text-primary)}.prose p,.prose [data-as=\"p\"],.prose li{color:var(--text-body)}.prose table th,.prose table td{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:0.25rem;transition:box-shadow 0.3s ease;background-color:var(--paper)!important}.card:hover,.example-card:hover{box-shadow:0px 5px 5px -3px rgba(163, 169, 175, 0.20), 0px 8px 10px 1px rgba(163, 169, 175, 0.14), 0px 3px 14px 2px rgba(163, 169, 175, 0.12)!important}.dark .card:hover,.dark .example-card:hover{box-shadow:none!important}.card>div{padding:1.5rem}.card h2,.card .integration-title,.example-card h2{font-size:1.25rem}.card .integration-title{font-weight:600;line-height:1.5rem;margin-bottom:0.833rem;color:var(--text-primary)}.card p,.example-card p,.example-card span[data-as=\"p\"]{margin-top:0.625rem;font-size:0.875rem;color:var(--text-primary)}.card .integration-logo{width:3.125rem;height:3.125rem;display:flex;justify-content:center;align-items:center}.card .integration-logo-long{width:5.125rem;height:3.125rem;display:flex;justify-content:center;align-items:center}.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}}.example-card{box-shadow:none;border:1px solid var(--border);border-radius:0.25rem;transition:box-shadow 0.3s ease;padding:1.5rem;display:flex;flex-direction:column;flex-grow:1;background-color:var(--paper)}.example-card .arrow{margin-left:auto;margin-top:auto;opacity:0;transition:opacity 0.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:0.75rem;margin-top:1.5rem}.example-card .card-tag{border-radius:1rem;background-color:var(--background);color:var(--text-primary);font-size:0.8125rem;line-height:138%;letter-spacing:0.16px;padding:0.1875rem 0.375rem;display:flex;gap:0.375rem;align-items:center}.examples-h2{font-size:1.25rem;margin-bottom:1.5rem}#related-articles{display:flex;flex-direction:column;width:100%}#related-articles h2{color:var(--text-primary);font-size:1.25rem;font-weight:600;letter-spacing:0.15px;line-height:150%;margin-bottom:1rem}#related-articles a{padding:1.0625rem 0;display:flex;align-items:flex-start;justify-content:space-between;gap:1rem;color:var(--text-primary);font-size:0.875rem;line-height:150%;letter-spacing:0.15px}#related-articles a:not(:last-of-type){border-bottom:1px solid var(--border)}#related-articles a:hover{opacity:0.7}#related-articles a>svg{flex-shrink:0}#back-button{display:flex;gap:0.5rem;align-items:center;color:var(--text-primary)!important;font-size:0.875rem;line-height:150%;letter-spacing:0.15px;margin-bottom:1.5rem}#back-button:hover{opacity:0.7}#back-button>svg{flex-shrink:0}.sample-app-heading{display:flex;flex-direction:column;align-items:center;text-align:center}.sample-app-heading h1{color:var(--text-primary);margin:0.5rem 0 0 0;font-size:2.125rem;font-weight:600;line-height:123.5%;letter-spacing:0.25px}.sample-app-heading p{color:var(--text-primary);margin:0.5rem 0 1.5rem 0;font-size:1.25rem;font-weight:600;line-height:150%;letter-spacing:0.15px}.sample-app-split{display:flex;flex-direction:column;gap:3rem}.sample-app-split .sidebar a:not(.connect-with-pinecone){font-size:0.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:0.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:0.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:0.25rem;padding:0.5rem 1rem;display:inline-flex;align-items:center;gap:0.5rem;font-size:0.875rem;font-weight:500;line-height:1.5rem;letter-spacing:0.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:0.75rem;line-height:150%;letter-spacing:0.5px;border-radius:0.25rem;padding:0.125rem 0.5rem;background-color:var(--paper)!important;color:var(--text-primary)!important;border:none}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(0.4, 0, 0.2, 1) 0ms;border-radius:0.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{color:var(--text-primary)!important}.pinecone-connect-connected p:last-of-type{margin-top:0.75rem}.remove-api-key{display:flex;width:100%;max-width:31.25rem;margin-top:-1.25rem}.remove-api-key>button{font-size:0.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,\n rgba(255, 255, 255, 0) 0%,\n rgba(255, 255, 255, 0.6) 50%,\n rgba(255, 255, 255, 0) 100%);animation:shimmer 1.5s infinite;position:absolute;top:0;left:0}@keyframes shimmer{0%{transform:translateX(-100%)}100%{transform:translateX(100%)}}.model-gallery-header{display:flex;flex-wrap:wrap;align-items:flex-end;justify-content:space-between;gap:1rem;margin-bottom:1.5rem}.model-gallery-header h1{margin:0;color:var(--text-primary);font-size:2.125rem;font-weight:700;line-height:1.25}.model-gallery-header p{margin:0.5rem 0 0;color:var(--text-secondary);font-size:1rem;line-height:1.5}.tabs:has(.model-table){position:relative}.tabs:has(.model-table)>[role=\"tablist\"]{padding-right:22rem}.model-table~[data-table-wrapper]{margin-top:0!important;padding-top:0!important}.model-tab-count{font-weight:400}.model-table-controls{position:absolute;top:0;right:0;display:flex;align-items:center;justify-content:flex-end;gap:1rem;height:2.75rem}@media (max-width: 767px){.tabs:has(.model-table)>[role=\"tablist\"]{column-gap:1rem;padding-right:0}.tabs:has(.model-table) [data-component-part=\"tab-button\"]{font-size:0.8125rem}.model-table-controls{position:static;height:auto;margin-bottom:0.75rem}.model-table-controls{flex-wrap:wrap;justify-content:flex-start;gap:0.5rem 1rem}.model-search-wrap{order:-1;flex:1 1 100%;width:auto}}.model-filter-chips{display:none}@media (max-width: 767px){.model-filter-chips{display:flex;flex-wrap:wrap;gap:0.5rem}}.model-filter-chip{display:inline-flex;align-items:center;gap:0.25rem;height:2rem;padding:0 0.625rem;border:1px solid var(--border);border-radius:4px;background:var(--paper);color:var(--text-primary);font-size:0.8125rem;white-space:nowrap;cursor:pointer}.model-filter-chip svg{color:var(--text-secondary)}.model-filter-chip.active{border-color:var(--brand-blue);color:var(--brand-blue)}.model-filter-chip:focus-visible{outline:2px solid var(--brand-blue);outline-offset:1px}.model-clear{color:var(--brand-blue);font-size:0.8125rem;white-space:nowrap;cursor:pointer}.model-clear:hover{text-decoration:underline;text-underline-offset:2px}.model-search-wrap{position:relative;display:flex;align-items:center;width:16.25rem}.model-search-wrap svg{position:absolute;left:0.625rem;color:var(--text-secondary);pointer-events:none}.model-search{width:100%;height:2rem;padding:0 0.625rem 0 2rem;border:1px solid var(--border);border-radius:4px;background:var(--paper);color:var(--text-primary);font-size:0.8125rem}.model-search::placeholder{color:var(--text-secondary)}.model-search:focus{outline:none;border-color:var(--brand-blue);box-shadow:inset 0 0 0 1px var(--brand-blue)}.model-filter-button{display:inline-flex;align-items:center;justify-content:center;width:1.5rem;height:1.5rem;margin-left:0.125rem;border-radius:4px;color:var(--text-secondary);opacity:0.7;vertical-align:middle;cursor:pointer}.model-filter-button:hover,.model-filter-button[aria-expanded=\"true\"]{background:rgb(115 143 171 / 0.12);opacity:1}.model-filter-button.active{color:var(--brand-blue);opacity:1}.model-filter-button:focus-visible,.model-clear:focus-visible,.model-filter-menu input:focus-visible{outline:2px solid var(--brand-blue);outline-offset:1px}.model-filter-count{display:inline-block;min-width:0.5rem;color:var(--brand-blue);font-size:0.6875rem;font-weight:500}.model-filter-menu{position:fixed;z-index:50;min-width:12.5rem;padding:0.375rem 0;border:1px solid var(--border);border-radius:4px;background:var(--paper);box-shadow:0 8px 10px -5px rgb(18 17 66 / 0.12), 0 16px 24px 2px rgb(18 17 66 / 0.09), 0 6px 30px 5px rgb(18 17 66 / 0.07)}.model-filter-menu label{display:flex;align-items:center;gap:0.625rem;padding:0.5rem 0.875rem;color:var(--text-primary);font-size:0.875rem;white-space:nowrap;cursor:pointer}.model-filter-menu label:hover{background:rgb(60 114 255 / 0.06)}.model-filter-menu input{width:1rem;height:1rem;margin:0;accent-color:var(--brand-blue)}.model-filter-menu svg{color:var(--text-secondary)}table.model-table-ready{border:1px solid var(--border);border-radius:6px;border-collapse:separate;border-spacing:0;overflow:clip;background:var(--paper);font-size:0.875rem}.model-table-ready th,.model-table-ready td{min-width:0!important}.model-table-ready .model-col-folded{display:none}.model-table-ready thead th{height:3rem;padding:0 0.75rem!important;background:var(--paper);color:var(--text-secondary);font-size:0.875rem;font-weight:400;text-align:left;vertical-align:middle;white-space:nowrap}.model-table-ready thead th a{border-bottom:none!important;color:inherit!important;font-weight:inherit;text-decoration:none}.model-table-ready thead th a::after{content:\"\";display:inline-block;width:0.75em;height:0.75em;margin-left:0.25em;background-color:currentColor;mask:url(\"data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 12 12' fill='none' stroke='black' stroke-width='1.5' stroke-linecap='round' stroke-linejoin='round'%3E%3Cpath d='M4 3h5v5M9 3L3 9'/%3E%3C/svg%3E\") no-repeat center / contain;vertical-align:-0.05em}.model-table-ready thead th a:hover{color:var(--brand-blue)!important}.model-table-ready tbody td{padding:0.75rem!important;border-top:1px solid var(--border);color:var(--text-secondary);vertical-align:middle}.model-table-ready tbody td code{padding:0;border:0;background:none;color:inherit;font-size:0.75rem;white-space:nowrap}.model-table-ready tbody tr:hover td{background:rgb(60 114 255 / 0.04)}.model-cell{display:flex;align-items:center;gap:0.625rem;white-space:nowrap}.model-table-ready tbody td:first-child a{border-bottom:none!important;color:var(--brand-blue)!important;font-family:paperMono, ui-monospace, SFMono-Regular, Menlo, monospace;font-size:0.8125rem;font-weight:500;text-decoration:none}.model-table-ready tbody td:first-child a:hover{text-decoration:underline;text-underline-offset:2px}.model-table-ready tbody td:last-child{text-align:right;white-space:nowrap}.model-table-ready tbody td:last-child a{border-bottom:none!important;color:var(--brand-blue);font-size:0.8125rem;font-weight:500;text-decoration:none}.model-table-ready tbody td:last-child a:hover{text-decoration:underline;text-underline-offset:2px}.model-table-ready tbody td:nth-child(3){white-space:nowrap}.model-table-ready tbody tr.model-table-empty td{padding:2rem 1rem!important;color:var(--text-secondary);text-align:center}.model-table-ready tbody tr.model-table-empty:hover td{background:none}.model-logo{display:flex;flex:0 0 auto;align-items:center;justify-content:center;width:1.5rem;height:1.5rem}.model-logo img{width:1.375rem;height:1.375rem;margin:0!important;border-radius:4px;object-fit:contain}.model-name{display:flex;flex-direction:column}.model-name-line{display:flex;align-items:center;gap:0.5rem}.model-company-name{color:var(--text-secondary);font-size:0.75rem;line-height:1.125rem}.model-plan-badge{padding:0 0.375rem;border:1px solid var(--border);border-radius:4px;color:var(--text-secondary);font-size:0.625rem;line-height:1rem;white-space:nowrap}.model-deprecated-badge{border-color:rgb(217 119 6 / 0.5);color:rgb(180 83 9)}.dark .model-deprecated-badge{color:rgb(251 191 36)}.model-input-icons{display:inline-flex;gap:0.375rem;color:var(--text-primary);vertical-align:middle}.model-cell-muted{color:var(--text-secondary);opacity:0.7}.model-input-text{display:none}@media (min-width: 768px) and (max-width: 1279px){.model-table-ready thead th:first-child,.model-table-ready tbody td:first-child{position:sticky;left:0;z-index:1;background:var(--paper);box-shadow:inset -1px 0 0 var(--border)}.model-table-ready tbody tr:hover td:first-child{background:linear-gradient(rgb(60 114 255 / 0.04), rgb(60 114 255 / 0.04)), var(--paper)}}@media (max-width: 767px){table.model-table-ready{display:block;width:100%!important;border:0;background:none}.model-table-ready thead{display:none}.model-table-ready tbody{display:flex;flex-direction:column;gap:0.75rem}.model-table-ready tbody tr{display:block;padding:0.75rem 1rem;border:1px solid var(--border);border-radius:6px;background:var(--paper)}.model-table-ready tbody td{display:grid;grid-template-columns:8.5rem minmax(0, 1fr);gap:0.75rem;padding:0.25rem 0!important;border-top:0;text-align:left!important;white-space:normal!important}.model-table-ready tbody td::before{content:attr(data-label);color:var(--text-secondary);font-size:0.75rem}.model-table-ready tbody td:first-child,.model-table-ready tbody td:last-child{display:block}.model-table-ready tbody td:first-child::before,.model-table-ready tbody td:last-child::before,.model-table-ready tbody tr.model-table-empty td::before{content:none}.model-table-ready tbody td:first-child{margin-bottom:0.375rem;padding-bottom:0.75rem!important;border-bottom:1px solid var(--border)}.model-table-ready tbody td:last-child{padding-top:0.5rem!important}.model-table-ready tbody td.model-cell-muted,.model-table-ready tbody td.model-cell-empty{display:none}.model-table-ready tbody tr:hover td{background:none}.model-table-ready tbody tr.model-table-empty{padding:0}.model-table-ready tbody tr.model-table-empty td{display:block;border-bottom:0}.model-input-icons{display:none}.model-input-text{display:inline}}html:has(.model-table){overflow-y:scroll}#content-area:has(.model-table) .feedback-toolbar{padding-bottom:0}.model-table-notes{display:grid;grid-template-columns:max-content minmax(0, 1fr);gap:0.25rem 1rem;max-width:55rem;margin-top:1rem;color:var(--text-secondary);font-size:0.75rem;line-height:1.25rem}.model-table-notes>span:nth-child(odd){color:var(--text-primary);font-weight:500}.model-table-notes code{font-size:0.75rem}.model-table-notes a code{padding:0;border:0;background:none;color:inherit}@media (max-width: 767px){.model-table-notes{grid-template-columns:minmax(0, 1fr)}.model-table-notes>span:nth-child(even){margin-bottom:0.5rem}}#content-container,#content-area,main{overflow:visible!important}.outlined-button{display:flex;flex-shrink:0;flex-direction:column;justify-content:center;align-items: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);font-weight:500;transition:background-color 0.3s ease, border 0.3s ease, color 0.3s ease}.outlined-button:hover{background-color:var(--paper);border:1px solid var(--brand-blue);color:var(--text-primary)}.mdx-content:has(.model-page-card){display:grid;grid-template-columns:minmax(0, 1fr)}.mdx-content:has(.model-page-card)>.not-prose,.model-page-card{display:contents}.model-page-back{display:inline-flex;align-items:center;gap:0.25rem;justify-self:start;margin-bottom:1.5rem;border-bottom:none!important;color:var(--brand-blue)!important;font-size:0.8125rem;font-weight:500;text-decoration:none}.model-page-back:hover{text-decoration:underline;text-underline-offset:2px}.model-page-head{display:flex;flex-wrap:wrap;align-items:flex-start;justify-content:space-between;gap:1.5rem;margin-bottom:2rem;padding-bottom:2rem;border-bottom:1px solid var(--border)}.model-page-title{display:flex;flex:1 1 30rem;align-items:flex-start;gap:1rem;min-width:0}.model-page-logo{display:flex;flex:0 0 auto;align-items:center;justify-content:center;width:3rem;height:3rem;border:1px solid var(--border);border-radius:4px}.model-page-logo img{width:2rem;height:2rem;object-fit:contain}.model-page-title h1{margin:0;color:var(--text-primary);font-family:paperMono, ui-monospace, SFMono-Regular, Menlo, monospace;font-size:2rem;font-weight:700;line-height:1.3;letter-spacing:-0.02em;overflow-wrap:anywhere}.model-page-meta{display:flex;flex-wrap:wrap;align-items:center;gap:0.5rem;margin-top:0.5rem;color:var(--text-secondary);font-size:0.8125rem}.model-page-meta>span:not(.model-plan-badge)+span:not(.model-plan-badge)::before{content:\"·\";margin-right:0.5rem;opacity:0.6}.model-page-actions{display:flex;flex-wrap:wrap;gap:0.5rem}.model-page-button{display:inline-flex;align-items:center;height:2.5rem;padding:0 1rem;border:1px solid var(--border);border-radius:4px;background:var(--paper);color:var(--brand-blue)!important;font-size:0.875rem;font-weight:500;white-space:nowrap;text-decoration:none;cursor:pointer}.model-page-button:hover{border-color:var(--brand-blue)}.model-page-button.primary{border-color:var(--brand-blue);background:var(--brand-blue);color:#ffffff!important}.dark .model-page-button.primary{color:#1c1917!important}.model-page-button.primary:hover{opacity:0.9}.model-page-button:focus-visible{outline:2px solid var(--brand-blue);outline-offset:2px}.model-page-specs{display:flex;flex-direction:column;gap:1.5rem;margin-bottom:2.5rem}.model-page-specs-card{padding:1.25rem;border:1px solid var(--border);border-radius:4px;background:var(--paper)}.model-page-eyebrow{display:block;margin-bottom:0.75rem;color:var(--text-secondary);font-size:0.625rem;letter-spacing:0.1em;text-transform:uppercase}.model-page-specs dl{display:grid;grid-template-columns:7rem minmax(0, 1fr);gap:0.625rem 0.75rem;margin:0;font-size:0.8125rem;line-height:1.25rem}.model-page-specs dt{color:var(--text-secondary)}.model-page-specs dd{margin:0;color:var(--text-primary)}.model-page-compare{display:flex;flex-direction:column;gap:0.5rem}.model-page-compare .model-page-eyebrow{margin-bottom:0}.model-page-compare a{display:flex;align-items:center;gap:0.75rem;padding:0.75rem;border:1px solid var(--border);border-radius:4px;color:var(--text-primary)!important;text-decoration:none}.model-page-compare a:hover{border-color:var(--brand-blue)}.model-page-compare a>span:last-child{display:flex;flex-direction:column;min-width:0}.model-page-compare-id{font-family:paperMono, ui-monospace, SFMono-Regular, Menlo, monospace;font-size:0.8125rem;font-weight:500;overflow-wrap:anywhere}.model-page-compare-note{color:var(--text-secondary);font-size:0.75rem}.model-page-content>[data-as=\"p\"]{display:block;margin:1.25rem 0}.model-page-content>:first-child{margin-top:0}.model-page-content h2{margin-top:2.5rem;font-size:1.25rem}.model-page-content h3{font-size:1rem}.model-page-content pre{white-space:pre-wrap}@media (max-width: 767px){.model-page-title h1{font-size:1.5rem}}.model-page-sidebar{display:none}.model-page-widget{order:1;margin-top:2.5rem}.model-page-widget iframe{display:block;width:100%;border:0}@media (min-width: 1080px){.mdx-content:has(.model-page-card){grid-template-columns:minmax(0, 1fr) 20rem;grid-template-rows:auto auto auto 1fr;column-gap:3rem}.model-page-widget{order:0;grid-row:4;grid-column:2;align-self:start;margin-top:1.5rem}.model-page-back,.model-page-head{grid-column:1 / -1}.model-page-specs{grid-row:3;grid-column:2;align-self:start;margin-bottom:0}.model-page-guides{grid-row:3 / span 2;grid-column:1;min-width:0}}#pinecone-connect-widget iframe{width:100%!important;max-width:500px!important}@media (max-width: 576px){#pinecone-connect-widget{scale:0.95!important;transform-origin:top left}.connect-widget-skeleton{height:180px;margin-block:30px}.skeleton-content{height:180px}#pinecone-connect-widget,#pinecone-connect-widget>div,#pinecone-connect-widget iframe{width:100%!important;min-width:0!important;max-width:100%!important}div[style*=\"min-width\"]{min-width:0!important;width:100%!important}}.pinecone-console-embed{#navbar img {\n display: none;\n }\n\n /* Hide top part of navbar */\n #navbar .relative:first-of-type > div:first-of-type {\n height: 0 !important;\n }\n\n /* Hide navbar links */\n #navbar nav {\n display: none;\n }\n\n /* Hide dark mode toggle */\n #navbar [aria-label=\"Toggle dark mode\"] {\n display: none;\n }\n\n /* Move API version selector to the right edge */\n #navbar button[aria-haspopup=\"menu\"] {\n position: absolute;\n top: 12px;\n right: 0px;\n }\n\n /* Move content up to account for smaller navbar */\n #content-container,\n #sidebar {\n margin-top: -4rem;\n }\n\n /* Hide mobile and desktop search button */\n #search-bar-entry-mobile,\n #search-bar-entry {\n display: none;\n }\n\n /* Hide actions menu */\n button[aria-label='More actions'] {\n display: none;\n }\n\n /* Move header link action to the right edge */\n h2 > .absolute:first-of-type,\n h3 > .absolute:first-of-type,\n h4 > .absolute:first-of-type {\n right: -12px;\n }}#page-context-menu-button{border-start-start-radius:0.25rem!important;border-end-start-radius:0.25rem!important}#page-context-menu button:last-child{border-radius:0!important;border-start-end-radius:0.25rem!important;border-end-end-radius:0.25rem!important}.agent-tool{border-left:4px solid var(--brand-blue, #002BFF);padding:1rem 1.25rem;border-radius:0.375rem;background-color:#f0f4ff;margin:0.5rem 0 1rem 0}.agent-tool>p:first-child{margin-top:0;font-size:0.875rem;letter-spacing:0.025em}.dark .agent-tool{background-color:rgba(0, 43, 255, 0.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:0.5rem}.pc-cl-heading{margin:0 0 0.25rem;font-size:0.8125rem;font-weight:600;color:var(--text-primary)}.pc-cl-search{width:100%;padding:0.375rem 0.625rem;font-size:0.8125rem;line-height:1.5;color:inherit;background-color:transparent;border:1px solid var(--divider);border-radius:0.5rem;appearance:none}.pc-cl-search::placeholder{color:var(--text-secondary)}.pc-cl-search:focus{outline:none;border-color:var(--brand-blue)}.pc-cl-dd-toggle{width:100%;display:flex;align-items:center;justify-content:space-between;gap:0.5rem;padding:0.375rem 0.625rem;font-size:0.8125rem;line-height:1.5;text-align:left;color:inherit;cursor:pointer;background-color:transparent;border:1px solid var(--divider);border-radius:0.5rem}.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:0.75rem;height:0.75rem;opacity:0.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:0.25rem;overflow-y:auto;list-style:none;background-color:var(--paper);border:1px solid var(--divider);border-radius:0.5rem;box-shadow:0 8px 24px rgba(0, 0, 0, 0.08)}.dark .pc-cl-dd-menu{box-shadow:0 8px 24px rgba(0, 0, 0, 0.4)}.pc-cl-dd-menu li{margin:0;padding:0;list-style:none}.pc-cl-dd-menu li::marker,.pc-cl-dd-menu li::before{content:none;display:none}.pc-cl-dd-menu button{width:100%;padding:0.3125rem 0.5rem;font-size:0.8125rem;line-height:1.4;text-align:left;color:inherit;cursor:pointer;background-color:transparent;border:0;border-radius:0.375rem}.pc-cl-dd-menu button:hover{background-color:var(--surface)}.pc-cl-clear{align-self:flex-start;padding:0;font-size:0.8125rem;color:var(--brand-blue);cursor:pointer;background:none;border:0}.pc-cl-clear:hover{text-decoration:underline}.pc-cl-count{margin:0;font-size:0.75rem;color:var(--text-secondary)}.pc-cl-empty{color:var(--text-secondary)}[class*=\"flex-wrap\"][class*=\"gap-2\"][class*=\"text-secondary\"]>span[class*=\"rounded-lg\"][class*=\"font-medium\"]{padding:0.1875rem 0.625rem;border-radius:9999px;border:1px solid var(--divider);background:transparent}.pc-mermaid-action rect{fill:var(--brand-blue)!important;stroke:var(--brand-blue)!important}.pc-mermaid-action .nodeLabel,.pc-mermaid-action .nodeLabel *{color:var(--text-contrast)!important}.pc-mermaid-item rect,.cluster.pc-mermaid-group rect{fill:transparent!important;stroke:var(--brand-blue)!important}.cluster.pc-mermaid-frame rect{fill:transparent!important;stroke:var(--secondary)!important}"}]}
{"page":{"pagePath":"api-reference/contexts/update-a-context","slug":"/api-reference/contexts/update-a-context","pageMetadata":{"title":"Update a context","description":"All fields optional; an absent one is left untouched. An empty string clears `description`/`guide`, and `{}` clears the manifest back to defaults.","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","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"All fields optional; an absent one is left untouched. An empty string clears \", _jsx(_components.code, {\n children: \"description\"\n }), \"/\", _jsx(_components.code, {\n children: \"guide\"\n }), \", and \", _jsx(_components.code, {\n children: \"{}\"\n }), \" clears the manifest back to defaults.\"]\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}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Update a context","description":"All fields optional; an absent one is left untouched. An empty string clears `description`/`guide`, and `{}` clears the manifest back to defaults.","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","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/pinecone/345ae6b85c58f0d4/console-iframe.js","/_mintlify/custom/pinecone/659fdc4f30ced33f/script.js","/_mintlify/custom/pinecone/4d30bdf131035051/inkeep.js"],"openApiReferenceData":{"operation":{"tags":["Contexts"],"summary":"Update a context","description":"All fields optional; an absent one is left untouched. An empty string clears `description`/`guide`, and `{}` clears the manifest back to defaults.","operationId":"update_context","parameters":["12e6adc7-1011-4850-a8b5-516220d0cf09","8f240490-8c6d-4c12-8d6e-2893f5ffca08"],"requestBody":"92f737cf-004b-47fd-a960-8eaeb5842087","responses":{"200":"1b2d20c6-76b7-4a07-a3fb-f92b69c3a6f7","400":"afe1dbd1-19f2-4f33-8b21-9052f3e283b7","404":"57696cff-241a-4abf-a8f7-2df6f984f59d","409":"153888d6-605d-48e8-81be-f07494b34685"},"method":"put","type":"path","servers":["99373903-6548-4b08-80ee-c6e520612dde"],"security":["0831f00e-3f5e-4a3b-8468-71f65be635b5","98ada4b9-3d74-41a7-b83e-d7f377508368"],"path":"/contexts/{slug}","baseUrlOptions":["https://{host}/api"],"title":"Update a context","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"12e6adc7-1011-4850-a8b5-516220d0cf09":{"in":"path","name":"slug","description":"Context slug or UUID.","required":true,"schema":{"type":"string","isRequired":true,"description":"Context slug or UUID.","uniqueKey":"","typeLabel":"string"},"style":"simple"},"8f240490-8c6d-4c12-8d6e-2893f5ffca08":{"in":"header","name":"X-Pinecone-Api-Version","description":"Date-based contract version, echoed back on the same header. Omit for the default (`2026-07`); send `unstable` for the in-development surface. An unrecognized value is rejected with `400 unsupported_api_version`.","schema":{"default":"2026-07","x-enum":["2026-07","unstable"],"type":"string","description":"Date-based contract version, echoed back on the same header. Omit for the default (`2026-07`); send `unstable` for the in-development surface. An unrecognized value is rejected with `400 unsupported_api_version`.","uniqueKey":"","typeLabel":"string"},"style":"simple"}},"requestBody":{"content":{"application/json":{"schema":{"description":"All fields optional. Empty string for description/guide clears it; `{}` for manifest clears it back to defaults. Absent leaves untouched. `kind` is immutable and cannot be updated.","type":"object","properties":{"slug":{"description":"Renames the context. Must stay unique within the project.","type":"string","uniqueKey":"slug","typeLabel":"string"},"name":{"description":"New display name.","type":"string","uniqueKey":"name","typeLabel":"string"},"description":{"description":"New summary. Empty string clears it.","type":"string","uniqueKey":"description","typeLabel":"string"},"guide":{"description":"New standing instructions. Empty string clears them.","type":"string","uniqueKey":"guide","typeLabel":"string"},"manifest":{"description":"The document that drives curate and search. Sparse: every field is optional and an omitted one falls back to its default, so absent fields are omitted rather than nulled. A change reaches the index on the next curate; rebuilding what is already indexed needs a forced one.","type":"object","properties":{"curate":{"description":"What curate builds out of the sources — the chunk leg, the artifact leg, or both.","type":"object","properties":{"chunks":{"description":"The chunk leg — sources split into passages, embedded for semantic search and optionally indexed for keyword search.","type":"object","properties":{"enabled":{"description":"Whether curate builds the chunk leg at all.","default":true,"type":"boolean","uniqueKey":"manifest.curate.chunks.enabled","typeLabel":"boolean"},"embedding_model":{"description":"Model that embeds the chunks.","default":"multilingual-e5-large","type":"string","maxLength":128,"uniqueKey":"manifest.curate.chunks.embedding_model","typeLabel":"string"},"chunking":{"description":"How a source is cut into chunks.","type":"object","properties":{"strategy":{"description":"Which structure the splitter cuts on — markdown headings, fixed-size windows, HTML elements, CSV rows, or code syntax. Pick the one that matches the corpus.","default":"markdown_heading","x-enum":["markdown_heading","sliding_window","html","csv","code"],"type":"string","uniqueKey":"manifest.curate.chunks.chunking.strategy","typeLabel":"string"},"target_size":{"description":"Chunk size the splitter aims for, in tokens. Smaller chunks retrieve more precisely; larger ones carry more surrounding context.","default":512,"type":"integer","minimum":64,"maximum":4096,"uniqueKey":"manifest.curate.chunks.chunking.target_size","typeLabel":"integer"},"overlap":{"description":"Tokens each chunk repeats from its predecessor, so a passage split across a boundary is still retrievable whole.","default":64,"type":"integer","minimum":0,"maximum":1024,"uniqueKey":"manifest.curate.chunks.chunking.overlap","typeLabel":"integer"},"respect_sections":{"description":"Never cut across a section boundary, even when that leaves a chunk short of `target_size`.","default":true,"type":"boolean","uniqueKey":"manifest.curate.chunks.chunking.respect_sections","typeLabel":"boolean"}},"uniqueKey":"manifest.curate.chunks.chunking","typeLabel":"object"},"keyword":{"description":"The lexical index built alongside the vectors, for exact-term matching.","type":"object","properties":{"enabled":{"description":"Whether the lexical index is built.","default":true,"type":"boolean","uniqueKey":"manifest.curate.chunks.keyword.enabled","typeLabel":"boolean"}},"uniqueKey":"manifest.curate.chunks.keyword","typeLabel":"object"}},"uniqueKey":"manifest.curate.chunks","typeLabel":"object"},"artifacts":{"description":"The artifact leg: knowledge an LLM distills out of the sources, as prose files or database rows. Off by default.","type":"object","properties":{"enabled":{"description":"Whether curate extracts artifacts at all.","default":false,"type":"boolean","uniqueKey":"manifest.curate.artifacts.enabled","typeLabel":"boolean"},"artifact_model":{"description":"Model tier that does the extraction. `standard` reads more carefully at a higher token cost.","default":"lite","x-enum":["standard","lite"],"type":"string","uniqueKey":"manifest.curate.artifacts.artifact_model","typeLabel":"string"},"artifact_types":{"description":"What kinds of artifact to extract. Nothing is extracted until at least one is declared.","type":"array","items":{"description":"One kind of artifact to extract. `name` is required of a written manifest; a read echoes a stored document that lacks one rather than failing.","type":"object","properties":{"name":{"description":"What the type is called. Edge endpoints reference it, and a sqlite type's table is named after it.","type":"string","maxLength":64,"isRequired":true,"uniqueKey":"manifest.curate.artifacts.artifact_types.items.[INDEX].name","typeLabel":"string"},"kind":{"description":"What the artifact represents, which selects the extraction prompt. `glossary` is the exception — it reads the headings named in `sections` deterministically, with no LLM call.","default":"topic","x-enum":["summary","topic","entity","event","doc","page","glossary"],"type":"string","uniqueKey":"manifest.curate.artifacts.artifact_types.items.[INDEX].kind","typeLabel":"string"},"scope":{"description":"How widely the extraction reaches. `document` extracts one artifact per source; `corpus` reduces mentions from across every source into one artifact per subject.","default":"corpus","x-enum":["document","corpus"],"type":"string","uniqueKey":"manifest.curate.artifacts.artifact_types.items.[INDEX].scope","typeLabel":"string"},"icon":{"description":"Symbol to display beside artifacts of this kind.","type":"string","maxLength":64,"uniqueKey":"manifest.curate.artifacts.artifact_types.items.[INDEX].icon","typeLabel":"string"},"description":{"description":"What this type should capture. Goes into the extraction prompt, so it steers the result.","type":"string","maxLength":512,"uniqueKey":"manifest.curate.artifacts.artifact_types.items.[INDEX].description","typeLabel":"string"},"coverage":{"description":"Topics the extraction is told to address wherever the source speaks to them.","type":"array","items":{"description":"One topic the extraction should address.","type":"string","maxLength":128,"uniqueKey":"manifest.curate.artifacts.artifact_types.items.[INDEX].coverage.items.[INDEX]","typeLabel":"string"},"maxItems":32,"uniqueKey":"manifest.curate.artifacts.artifact_types.items.[INDEX].coverage","typeLabel":"string[]"},"sections":{"description":"Exact section headings a `glossary`-kind type reads verbatim. Ignored by every other kind.","type":"array","items":{"description":"One exact section heading to read.","type":"string","maxLength":128,"uniqueKey":"manifest.curate.artifacts.artifact_types.items.[INDEX].sections.items.[INDEX]","typeLabel":"string"},"maxItems":64,"uniqueKey":"manifest.curate.artifacts.artifact_types.items.[INDEX].sections","typeLabel":"string[]"},"min_doc_count":{"description":"Overrides the manifest-level `min_doc_count` for this type.","default":1,"type":"integer","minimum":1,"maximum":64,"uniqueKey":"manifest.curate.artifacts.artifact_types.items.[INDEX].min_doc_count","typeLabel":"integer"},"format":{"description":"Where the artifacts of this type are written — `markdown` a prose file each, `sqlite` rows in the context's structured database.","default":"markdown","x-enum":["markdown","sqlite"],"type":"string","uniqueKey":"manifest.curate.artifacts.artifact_types.items.[INDEX].format","typeLabel":"string"},"columns":{"description":"Table schema for a `sqlite`-format type. Ignored for `markdown`. Two names that normalize to the same column collide, and the first declaration wins.","type":"array","items":{"description":"One column of the type's table.","type":"object","properties":{"name":{"description":"Column name.","type":"string","maxLength":64,"isRequired":true,"uniqueKey":"manifest.curate.artifacts.artifact_types.items.[INDEX].columns.items.[INDEX].name","typeLabel":"string"},"type":{"description":"SQLite column affinity.","default":"TEXT","x-enum":["TEXT","INTEGER","REAL","NUMERIC"],"type":"string","uniqueKey":"manifest.curate.artifacts.artifact_types.items.[INDEX].columns.items.[INDEX].type","typeLabel":"string"},"description":{"description":"What the column holds. Steers the extraction that fills it.","type":"string","maxLength":256,"uniqueKey":"manifest.curate.artifacts.artifact_types.items.[INDEX].columns.items.[INDEX].description","typeLabel":"string"}},"required":["name"],"uniqueKey":"manifest.curate.artifacts.artifact_types.items.[INDEX].columns.items.[INDEX]","typeLabel":"object"},"maxItems":64,"uniqueKey":"manifest.curate.artifacts.artifact_types.items.[INDEX].columns","typeLabel":"object[]"},"natural_key":{"description":"Columns that identify a row uniquely, so re-curating a source upserts its rows rather than duplicating them. `sqlite`-format types only.","type":"array","items":{"description":"One column of the upsert key.","type":"string","maxLength":64,"uniqueKey":"manifest.curate.artifacts.artifact_types.items.[INDEX].natural_key.items.[INDEX]","typeLabel":"string"},"maxItems":16,"uniqueKey":"manifest.curate.artifacts.artifact_types.items.[INDEX].natural_key","typeLabel":"string[]"}},"required":["name"],"uniqueKey":"manifest.curate.artifacts.artifact_types.items.[INDEX]","typeLabel":"object"},"maxItems":32,"uniqueKey":"manifest.curate.artifacts.artifact_types","typeLabel":"object[]"},"edge_types":{"description":"Typed, directed relationships between artifact types, which turn the artifacts into a graph the agent can traverse.","type":"array","items":{"description":"One typed, directed relationship between artifact types. `name`, `from`, and `to` are required of a written manifest; a read echoes a stored document that lacks one rather than failing.","type":"object","properties":{"name":{"description":"What the relationship is called, e.g. `mentions`.","type":"string","maxLength":64,"isRequired":true,"uniqueKey":"manifest.curate.artifacts.edge_types.items.[INDEX].name","typeLabel":"string"},"from":{"description":"Source artifact-type name. May equal `to` for a self-referential edge.","type":"string","maxLength":64,"isRequired":true,"uniqueKey":"manifest.curate.artifacts.edge_types.items.[INDEX].from","typeLabel":"string"},"to":{"description":"Target artifact-type name","type":"string","maxLength":64,"isRequired":true,"uniqueKey":"manifest.curate.artifacts.edge_types.items.[INDEX].to","typeLabel":"string"},"description":{"description":"What the relationship means. Steers the extraction that finds it.","type":"string","maxLength":512,"uniqueKey":"manifest.curate.artifacts.edge_types.items.[INDEX].description","typeLabel":"string"},"attributes":{"description":"Extra properties recorded on each edge, e.g. `count`.","type":"array","items":{"description":"One attribute name.","type":"string","maxLength":64,"uniqueKey":"manifest.curate.artifacts.edge_types.items.[INDEX].attributes.items.[INDEX]","typeLabel":"string"},"maxItems":16,"uniqueKey":"manifest.curate.artifacts.edge_types.items.[INDEX].attributes","typeLabel":"string[]"}},"required":["name","from","to"],"uniqueKey":"manifest.curate.artifacts.edge_types.items.[INDEX]","typeLabel":"object"},"maxItems":32,"uniqueKey":"manifest.curate.artifacts.edge_types","typeLabel":"object[]"},"min_doc_count":{"description":"How many source documents must mention a corpus-scoped subject before it earns an artifact. Raise it to suppress one-off mentions. An artifact type may override it.","default":1,"type":"integer","minimum":1,"maximum":64,"uniqueKey":"manifest.curate.artifacts.min_doc_count","typeLabel":"integer"},"max_tokens":{"description":"Output cap for one extracted artifact, in tokens.","default":1500,"type":"integer","minimum":128,"maximum":8192,"uniqueKey":"manifest.curate.artifacts.max_tokens","typeLabel":"integer"},"max_doc_chars":{"description":"Input cap for one extraction call, in characters. With windowing off this also caps how much of a source is read at all; everything beyond it is dropped.","default":60000,"type":"integer","minimum":1000,"maximum":2000000,"uniqueKey":"manifest.curate.artifacts.max_doc_chars","typeLabel":"integer"},"extraction_window_chars":{"description":"Window size for walking a long source across several extraction calls, so its back half is covered rather than dropped. `0` opts out and reads only the head, up to `max_doc_chars`.","default":0,"type":"integer","minimum":0,"maximum":1000000,"uniqueKey":"manifest.curate.artifacts.extraction_window_chars","typeLabel":"integer"},"mention_max_chars":{"description":"Cap on one recorded mention — what a single document says about the subject — in characters.","default":400,"type":"integer","minimum":100,"maximum":4000,"uniqueKey":"manifest.curate.artifacts.mention_max_chars","typeLabel":"integer"},"max_mentions_per_artifact":{"description":"How many mentions are fed into the pass that reduces them into one corpus-wide artifact.","default":40,"type":"integer","minimum":1,"maximum":500,"uniqueKey":"manifest.curate.artifacts.max_mentions_per_artifact","typeLabel":"integer"},"mention_context_chars":{"description":"Cap on those mentions once concatenated, in characters. Applied after `max_mentions_per_artifact`.","default":8000,"type":"integer","minimum":1000,"maximum":100000,"uniqueKey":"manifest.curate.artifacts.mention_context_chars","typeLabel":"integer"},"max_artifacts_per_type":{"description":"How many artifacts one type may produce. Omit for no cap.","default":10000,"type":"integer","minimum":1,"maximum":10000,"uniqueKey":"manifest.curate.artifacts.max_artifacts_per_type","typeLabel":"integer"}},"uniqueKey":"manifest.curate.artifacts","typeLabel":"object"}},"uniqueKey":"manifest.curate","typeLabel":"object"},"optimize":{"description":"The scheduled self-tuning loop: it clusters the queries that answered badly and tries candidate manifests against an ephemeral index until one reproduces the recorded answers.","type":"object","properties":{"schedule":{"description":"Cron expression the tuning loop runs on.","default":"0 * * * *","type":"string","maxLength":128,"uniqueKey":"manifest.optimize.schedule","typeLabel":"string"},"latency_threshold_ms":{"description":"A query slower than this counts as a problem worth tuning for, as does any query that fell back from artifacts to chunks. `0` disables the latency test, leaving only fallback.","default":60000,"type":"integer","minimum":0,"maximum":600000,"uniqueKey":"manifest.optimize.latency_threshold_ms","typeLabel":"integer"},"min_group_size":{"description":"How many near-duplicate problem queries must cluster together before the loop tunes for them. Keeps a one-off slow query from triggering a manifest change.","default":2,"type":"integer","minimum":1,"maximum":100,"uniqueKey":"manifest.optimize.min_group_size","typeLabel":"integer"},"eval_pass_rate_threshold":{"description":"Fraction of eval queries a candidate manifest must answer correctly to be considered ready. `1` demands all of them.","default":1,"type":"number","format":"double","minimum":0,"maximum":1,"uniqueKey":"manifest.optimize.eval_pass_rate_threshold","typeLabel":"number\u003cdouble>"},"max_iterations":{"description":"How many candidate manifests the loop tries before stopping with its best.","default":20,"type":"integer","minimum":1,"maximum":100,"uniqueKey":"manifest.optimize.max_iterations","typeLabel":"integer"}},"uniqueKey":"manifest.optimize","typeLabel":"object"},"search":{"description":"Standing instructions for the query runtime, pinned on the context rather than sent per turn.","type":"object","properties":{"instructions":{"description":"The context's default system prompt, applied to every turn in scope. A session's own `system_prompt` appends to it rather than replacing it.","type":"string","uniqueKey":"manifest.search.instructions","typeLabel":"string"}},"uniqueKey":"manifest.search","typeLabel":"object"}},"uniqueKey":"manifest","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"slug":"\u003cstring>","name":"\u003cstring>","description":"\u003cstring>","guide":"\u003cstring>","manifest":{"curate":{"chunks":{"enabled":true,"embedding_model":"multilingual-e5-large","chunking":{"strategy":"markdown_heading","target_size":512,"overlap":64,"respect_sections":true},"keyword":{"enabled":true}},"artifacts":{"enabled":false,"artifact_model":"lite","artifact_types":[{"name":"\u003cstring>","kind":"topic","scope":"corpus","icon":"\u003cstring>","description":"\u003cstring>","coverage":["\u003cstring>"],"sections":["\u003cstring>"],"min_doc_count":1,"format":"markdown","columns":[{"name":"\u003cstring>","type":"TEXT","description":"\u003cstring>"}],"natural_key":["\u003cstring>"]}],"edge_types":[{"name":"\u003cstring>","from":"\u003cstring>","to":"\u003cstring>","description":"\u003cstring>","attributes":["\u003cstring>"]}],"min_doc_count":1,"max_tokens":1500,"max_doc_chars":60000,"extraction_window_chars":0,"mention_max_chars":400,"max_mentions_per_artifact":40,"mention_context_chars":8000,"max_artifacts_per_type":10000}},"optimize":{"schedule":"0 * * * *","latency_threshold_ms":60000,"min_group_size":2,"eval_pass_rate_threshold":1,"max_iterations":20},"search":{"instructions":"\u003cstring>"}}}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"1b2d20c6-76b7-4a07-a3fb-f92b69c3a6f7":{"description":"The updated context","content":{"application/json":{"schema":{"description":"What context endpoints return — the stored context plus the lifecycle flags derived from its in-flight tasks.","type":"object","properties":{"id":{"description":"Stable UUID. Accepted anywhere `{slug}` is.","type":"string","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"slug":{"description":"URL-safe name, unique within the project. Mutable via `PUT`.","type":"string","isRequired":true,"uniqueKey":"slug","typeLabel":"string"},"name":{"description":"Human-readable display name.","type":"string","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"kind":{"description":"How the context is built. `search` — built from source documents, and must be curated before it can be queried. `work` — built from traces of work done, queryable immediately, consolidated by `groom` rather than `curate`.","default":"search","x-enum":["search","work"],"type":"string","isRequired":true,"uniqueKey":"kind","typeLabel":"string"},"created_by":{"description":"Principal that created the context.","type":"string","isRequired":true,"uniqueKey":"created_by","typeLabel":"string"},"description":{"oneOf":[{"description":"Free-text summary of what the context holds.","type":"string","isRequired":true,"uniqueKey":"description.oneOf.0","typeLabel":"string"},{"description":"Free-text summary of what the context holds.","type":"null","isRequired":true,"uniqueKey":"description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"description","typeLabel":"string | null"},"is_optimizing":{"description":"An optimize task is in flight.","type":"boolean","isRequired":true,"uniqueKey":"is_optimizing","typeLabel":"boolean"},"has_sources":{"description":"The source tree holds at least one file. False blocks curate.","type":"boolean","isRequired":true,"uniqueKey":"has_sources","typeLabel":"boolean"},"is_curating":{"description":"A curate task is in flight.","type":"boolean","isRequired":true,"uniqueKey":"is_curating","typeLabel":"boolean"},"is_importing":{"description":"An import task is in flight.","type":"boolean","isRequired":true,"uniqueKey":"is_importing","typeLabel":"boolean"},"is_exploring":{"description":"An explore task is in flight.","type":"boolean","isRequired":true,"uniqueKey":"is_exploring","typeLabel":"boolean"},"is_restoring":{"description":"A restore task is in flight.","type":"boolean","isRequired":true,"uniqueKey":"is_restoring","typeLabel":"boolean"},"is_grooming":{"description":"A groom task is in flight. Work contexts only.","type":"boolean","isRequired":true,"uniqueKey":"is_grooming","typeLabel":"boolean"},"created_at":{"description":"When the context was created.","type":"string","format":"date-time","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"description":"When the context last changed.","type":"string","format":"date-time","isRequired":true,"uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"},"workspace":{"description":"Owning workspace. Absent off a workspace-enabled cluster.","type":"string","uniqueKey":"workspace","typeLabel":"string"},"guide":{"description":"High-level standing instructions the query runtime reads on every turn.","type":"string","uniqueKey":"guide","typeLabel":"string"},"manifest":{"type":"object","description":"Pinned manifest document. Absent when the context runs on validator defaults.","properties":{"curate":{"description":"What curate builds out of the sources — the chunk leg, the artifact leg, or both.","type":"object","properties":{"chunks":{"description":"The chunk leg — sources split into passages, embedded for semantic search and optionally indexed for keyword search.","type":"object","properties":{"enabled":{"description":"Whether curate builds the chunk leg at all.","default":true,"type":"boolean","uniqueKey":"manifest.curate.chunks.enabled","typeLabel":"boolean"},"embedding_model":{"description":"Model that embeds the chunks.","default":"multilingual-e5-large","type":"string","maxLength":128,"uniqueKey":"manifest.curate.chunks.embedding_model","typeLabel":"string"},"chunking":{"description":"How a source is cut into chunks.","type":"object","properties":{"strategy":{"description":"Which structure the splitter cuts on — markdown headings, fixed-size windows, HTML elements, CSV rows, or code syntax. Pick the one that matches the corpus.","default":"markdown_heading","x-enum":["markdown_heading","sliding_window","html","csv","code"],"type":"string","uniqueKey":"manifest.curate.chunks.chunking.strategy","typeLabel":"string"},"target_size":{"description":"Chunk size the splitter aims for, in tokens. Smaller chunks retrieve more precisely; larger ones carry more surrounding context.","default":512,"type":"integer","minimum":64,"maximum":4096,"uniqueKey":"manifest.curate.chunks.chunking.target_size","typeLabel":"integer"},"overlap":{"description":"Tokens each chunk repeats from its predecessor, so a passage split across a boundary is still retrievable whole.","default":64,"type":"integer","minimum":0,"maximum":1024,"uniqueKey":"manifest.curate.chunks.chunking.overlap","typeLabel":"integer"},"respect_sections":{"description":"Never cut across a section boundary, even when that leaves a chunk short of `target_size`.","default":true,"type":"boolean","uniqueKey":"manifest.curate.chunks.chunking.respect_sections","typeLabel":"boolean"}},"uniqueKey":"manifest.curate.chunks.chunking","typeLabel":"object"},"keyword":{"description":"The lexical index built alongside the vectors, for exact-term matching.","type":"object","properties":{"enabled":{"description":"Whether the lexical index is built.","default":true,"type":"boolean","uniqueKey":"manifest.curate.chunks.keyword.enabled","typeLabel":"boolean"}},"uniqueKey":"manifest.curate.chunks.keyword","typeLabel":"object"}},"uniqueKey":"manifest.curate.chunks","typeLabel":"object"},"artifacts":{"description":"The artifact leg: knowledge an LLM distills out of the sources, as prose files or database rows. Off by default.","type":"object","properties":{"enabled":{"description":"Whether curate extracts artifacts at all.","default":false,"type":"boolean","uniqueKey":"manifest.curate.artifacts.enabled","typeLabel":"boolean"},"artifact_model":{"description":"Model tier that does the extraction. `standard` reads more carefully at a higher token cost.","default":"lite","x-enum":["standard","lite"],"type":"string","uniqueKey":"manifest.curate.artifacts.artifact_model","typeLabel":"string"},"artifact_types":{"description":"What kinds of artifact to extract. Nothing is extracted until at least one is declared.","type":"array","items":{"description":"One kind of artifact to extract. `name` is required of a written manifest; a read echoes a stored document that lacks one rather than failing.","type":"object","properties":{"name":{"description":"What the type is called. Edge endpoints reference it, and a sqlite type's table is named after it.","type":"string","maxLength":64,"isRequired":true,"uniqueKey":"manifest.curate.artifacts.artifact_types.items.[INDEX].name","typeLabel":"string"},"kind":{"description":"What the artifact represents, which selects the extraction prompt. `glossary` is the exception — it reads the headings named in `sections` deterministically, with no LLM call.","default":"topic","x-enum":["summary","topic","entity","event","doc","page","glossary"],"type":"string","uniqueKey":"manifest.curate.artifacts.artifact_types.items.[INDEX].kind","typeLabel":"string"},"scope":{"description":"How widely the extraction reaches. `document` extracts one artifact per source; `corpus` reduces mentions from across every source into one artifact per subject.","default":"corpus","x-enum":["document","corpus"],"type":"string","uniqueKey":"manifest.curate.artifacts.artifact_types.items.[INDEX].scope","typeLabel":"string"},"icon":{"description":"Symbol to display beside artifacts of this kind.","type":"string","maxLength":64,"uniqueKey":"manifest.curate.artifacts.artifact_types.items.[INDEX].icon","typeLabel":"string"},"description":{"description":"What this type should capture. Goes into the extraction prompt, so it steers the result.","type":"string","maxLength":512,"uniqueKey":"manifest.curate.artifacts.artifact_types.items.[INDEX].description","typeLabel":"string"},"coverage":{"description":"Topics the extraction is told to address wherever the source speaks to them.","type":"array","items":{"description":"One topic the extraction should address.","type":"string","maxLength":128,"uniqueKey":"manifest.curate.artifacts.artifact_types.items.[INDEX].coverage.items.[INDEX]","typeLabel":"string"},"maxItems":32,"uniqueKey":"manifest.curate.artifacts.artifact_types.items.[INDEX].coverage","typeLabel":"string[]"},"sections":{"description":"Exact section headings a `glossary`-kind type reads verbatim. Ignored by every other kind.","type":"array","items":{"description":"One exact section heading to read.","type":"string","maxLength":128,"uniqueKey":"manifest.curate.artifacts.artifact_types.items.[INDEX].sections.items.[INDEX]","typeLabel":"string"},"maxItems":64,"uniqueKey":"manifest.curate.artifacts.artifact_types.items.[INDEX].sections","typeLabel":"string[]"},"min_doc_count":{"description":"Overrides the manifest-level `min_doc_count` for this type.","default":1,"type":"integer","minimum":1,"maximum":64,"uniqueKey":"manifest.curate.artifacts.artifact_types.items.[INDEX].min_doc_count","typeLabel":"integer"},"format":{"description":"Where the artifacts of this type are written — `markdown` a prose file each, `sqlite` rows in the context's structured database.","default":"markdown","x-enum":["markdown","sqlite"],"type":"string","uniqueKey":"manifest.curate.artifacts.artifact_types.items.[INDEX].format","typeLabel":"string"},"columns":{"description":"Table schema for a `sqlite`-format type. Ignored for `markdown`. Two names that normalize to the same column collide, and the first declaration wins.","type":"array","items":{"description":"One column of the type's table.","type":"object","properties":{"name":{"description":"Column name.","type":"string","maxLength":64,"isRequired":true,"uniqueKey":"manifest.curate.artifacts.artifact_types.items.[INDEX].columns.items.[INDEX].name","typeLabel":"string"},"type":{"description":"SQLite column affinity.","default":"TEXT","x-enum":["TEXT","INTEGER","REAL","NUMERIC"],"type":"string","uniqueKey":"manifest.curate.artifacts.artifact_types.items.[INDEX].columns.items.[INDEX].type","typeLabel":"string"},"description":{"description":"What the column holds. Steers the extraction that fills it.","type":"string","maxLength":256,"uniqueKey":"manifest.curate.artifacts.artifact_types.items.[INDEX].columns.items.[INDEX].description","typeLabel":"string"}},"required":["name"],"uniqueKey":"manifest.curate.artifacts.artifact_types.items.[INDEX].columns.items.[INDEX]","typeLabel":"object"},"maxItems":64,"uniqueKey":"manifest.curate.artifacts.artifact_types.items.[INDEX].columns","typeLabel":"object[]"},"natural_key":{"description":"Columns that identify a row uniquely, so re-curating a source upserts its rows rather than duplicating them. `sqlite`-format types only.","type":"array","items":{"description":"One column of the upsert key.","type":"string","maxLength":64,"uniqueKey":"manifest.curate.artifacts.artifact_types.items.[INDEX].natural_key.items.[INDEX]","typeLabel":"string"},"maxItems":16,"uniqueKey":"manifest.curate.artifacts.artifact_types.items.[INDEX].natural_key","typeLabel":"string[]"}},"required":["name"],"uniqueKey":"manifest.curate.artifacts.artifact_types.items.[INDEX]","typeLabel":"object"},"maxItems":32,"uniqueKey":"manifest.curate.artifacts.artifact_types","typeLabel":"object[]"},"edge_types":{"description":"Typed, directed relationships between artifact types, which turn the artifacts into a graph the agent can traverse.","type":"array","items":{"description":"One typed, directed relationship between artifact types. `name`, `from`, and `to` are required of a written manifest; a read echoes a stored document that lacks one rather than failing.","type":"object","properties":{"name":{"description":"What the relationship is called, e.g. `mentions`.","type":"string","maxLength":64,"isRequired":true,"uniqueKey":"manifest.curate.artifacts.edge_types.items.[INDEX].name","typeLabel":"string"},"from":{"description":"Source artifact-type name. May equal `to` for a self-referential edge.","type":"string","maxLength":64,"isRequired":true,"uniqueKey":"manifest.curate.artifacts.edge_types.items.[INDEX].from","typeLabel":"string"},"to":{"description":"Target artifact-type name","type":"string","maxLength":64,"isRequired":true,"uniqueKey":"manifest.curate.artifacts.edge_types.items.[INDEX].to","typeLabel":"string"},"description":{"description":"What the relationship means. Steers the extraction that finds it.","type":"string","maxLength":512,"uniqueKey":"manifest.curate.artifacts.edge_types.items.[INDEX].description","typeLabel":"string"},"attributes":{"description":"Extra properties recorded on each edge, e.g. `count`.","type":"array","items":{"description":"One attribute name.","type":"string","maxLength":64,"uniqueKey":"manifest.curate.artifacts.edge_types.items.[INDEX].attributes.items.[INDEX]","typeLabel":"string"},"maxItems":16,"uniqueKey":"manifest.curate.artifacts.edge_types.items.[INDEX].attributes","typeLabel":"string[]"}},"required":["name","from","to"],"uniqueKey":"manifest.curate.artifacts.edge_types.items.[INDEX]","typeLabel":"object"},"maxItems":32,"uniqueKey":"manifest.curate.artifacts.edge_types","typeLabel":"object[]"},"min_doc_count":{"description":"How many source documents must mention a corpus-scoped subject before it earns an artifact. Raise it to suppress one-off mentions. An artifact type may override it.","default":1,"type":"integer","minimum":1,"maximum":64,"uniqueKey":"manifest.curate.artifacts.min_doc_count","typeLabel":"integer"},"max_tokens":{"description":"Output cap for one extracted artifact, in tokens.","default":1500,"type":"integer","minimum":128,"maximum":8192,"uniqueKey":"manifest.curate.artifacts.max_tokens","typeLabel":"integer"},"max_doc_chars":{"description":"Input cap for one extraction call, in characters. With windowing off this also caps how much of a source is read at all; everything beyond it is dropped.","default":60000,"type":"integer","minimum":1000,"maximum":2000000,"uniqueKey":"manifest.curate.artifacts.max_doc_chars","typeLabel":"integer"},"extraction_window_chars":{"description":"Window size for walking a long source across several extraction calls, so its back half is covered rather than dropped. `0` opts out and reads only the head, up to `max_doc_chars`.","default":0,"type":"integer","minimum":0,"maximum":1000000,"uniqueKey":"manifest.curate.artifacts.extraction_window_chars","typeLabel":"integer"},"mention_max_chars":{"description":"Cap on one recorded mention — what a single document says about the subject — in characters.","default":400,"type":"integer","minimum":100,"maximum":4000,"uniqueKey":"manifest.curate.artifacts.mention_max_chars","typeLabel":"integer"},"max_mentions_per_artifact":{"description":"How many mentions are fed into the pass that reduces them into one corpus-wide artifact.","default":40,"type":"integer","minimum":1,"maximum":500,"uniqueKey":"manifest.curate.artifacts.max_mentions_per_artifact","typeLabel":"integer"},"mention_context_chars":{"description":"Cap on those mentions once concatenated, in characters. Applied after `max_mentions_per_artifact`.","default":8000,"type":"integer","minimum":1000,"maximum":100000,"uniqueKey":"manifest.curate.artifacts.mention_context_chars","typeLabel":"integer"},"max_artifacts_per_type":{"description":"How many artifacts one type may produce. Omit for no cap.","default":10000,"type":"integer","minimum":1,"maximum":10000,"uniqueKey":"manifest.curate.artifacts.max_artifacts_per_type","typeLabel":"integer"}},"uniqueKey":"manifest.curate.artifacts","typeLabel":"object"}},"uniqueKey":"manifest.curate","typeLabel":"object"},"optimize":{"description":"The scheduled self-tuning loop: it clusters the queries that answered badly and tries candidate manifests against an ephemeral index until one reproduces the recorded answers.","type":"object","properties":{"schedule":{"description":"Cron expression the tuning loop runs on.","default":"0 * * * *","type":"string","maxLength":128,"uniqueKey":"manifest.optimize.schedule","typeLabel":"string"},"latency_threshold_ms":{"description":"A query slower than this counts as a problem worth tuning for, as does any query that fell back from artifacts to chunks. `0` disables the latency test, leaving only fallback.","default":60000,"type":"integer","minimum":0,"maximum":600000,"uniqueKey":"manifest.optimize.latency_threshold_ms","typeLabel":"integer"},"min_group_size":{"description":"How many near-duplicate problem queries must cluster together before the loop tunes for them. Keeps a one-off slow query from triggering a manifest change.","default":2,"type":"integer","minimum":1,"maximum":100,"uniqueKey":"manifest.optimize.min_group_size","typeLabel":"integer"},"eval_pass_rate_threshold":{"description":"Fraction of eval queries a candidate manifest must answer correctly to be considered ready. `1` demands all of them.","default":1,"type":"number","format":"double","minimum":0,"maximum":1,"uniqueKey":"manifest.optimize.eval_pass_rate_threshold","typeLabel":"number\u003cdouble>"},"max_iterations":{"description":"How many candidate manifests the loop tries before stopping with its best.","default":20,"type":"integer","minimum":1,"maximum":100,"uniqueKey":"manifest.optimize.max_iterations","typeLabel":"integer"}},"uniqueKey":"manifest.optimize","typeLabel":"object"},"search":{"description":"Standing instructions for the query runtime, pinned on the context rather than sent per turn.","type":"object","properties":{"instructions":{"description":"The context's default system prompt, applied to every turn in scope. A session's own `system_prompt` appends to it rather than replacing it.","type":"string","uniqueKey":"manifest.search.instructions","typeLabel":"string"}},"uniqueKey":"manifest.search","typeLabel":"object"}},"uniqueKey":"manifest","typeLabel":"object"},"semantic_index":{"oneOf":[{"description":"Host of the index backing this context's vector retrieval. Null until a curate resolves one.","type":"string","uniqueKey":"semantic_index.oneOf.0","typeLabel":"string"},{"description":"Host of the index backing this context's vector retrieval. Null until a curate resolves one.","type":"null","uniqueKey":"semantic_index.oneOf.1","typeLabel":"null"}],"uniqueKey":"semantic_index","typeLabel":"string | null"},"keyword_index":{"oneOf":[{"description":"Host of the index backing keyword retrieval. The same host as `semantic_index` today — the two names are separate seams over one index.","type":"string","uniqueKey":"keyword_index.oneOf.0","typeLabel":"string"},{"description":"Host of the index backing keyword retrieval. The same host as `semantic_index` today — the two names are separate seams over one index.","type":"null","uniqueKey":"keyword_index.oneOf.1","typeLabel":"null"}],"uniqueKey":"keyword_index","typeLabel":"string | null"},"optimize_task_id":{"oneOf":[{"description":"The optimize task — the running one, or the last to finish.","type":"string","uniqueKey":"optimize_task_id.oneOf.0","typeLabel":"string"},{"description":"The optimize task — the running one, or the last to finish.","type":"null","uniqueKey":"optimize_task_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"optimize_task_id","typeLabel":"string | null"},"optimize_score":{"oneOf":[{"description":"Eval pass rate the last optimize's best iteration scored.","type":"number","format":"double","uniqueKey":"optimize_score.oneOf.0","typeLabel":"number\u003cdouble>"},{"description":"Eval pass rate the last optimize's best iteration scored.","type":"null","format":"double","uniqueKey":"optimize_score.oneOf.1","typeLabel":"null"}],"uniqueKey":"optimize_score","typeLabel":"number\u003cdouble> | null"},"optimize_iterations":{"oneOf":[{"description":"How many candidate manifests the last run tried.","type":"integer","uniqueKey":"optimize_iterations.oneOf.0","typeLabel":"integer"},{"description":"How many candidate manifests the last run tried.","type":"null","uniqueKey":"optimize_iterations.oneOf.1","typeLabel":"null"}],"uniqueKey":"optimize_iterations","typeLabel":"integer | null"},"last_optimized_at":{"oneOf":[{"description":"When an optimize last persisted a tuned manifest.","type":"string","format":"date-time","uniqueKey":"last_optimized_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"When an optimize last persisted a tuned manifest.","type":"null","format":"date-time","uniqueKey":"last_optimized_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"last_optimized_at","typeLabel":"string\u003cdate-time> | null"},"last_curated_at":{"oneOf":[{"description":"When a curate last flipped a new index version live.","type":"string","format":"date-time","uniqueKey":"last_curated_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"When a curate last flipped a new index version live.","type":"null","format":"date-time","uniqueKey":"last_curated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"last_curated_at","typeLabel":"string\u003cdate-time> | null"},"last_source_import_at":{"oneOf":[{"description":"When sources were last staged by an upload or import.","type":"string","format":"date-time","uniqueKey":"last_source_import_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"When sources were last staged by an upload or import.","type":"null","format":"date-time","uniqueKey":"last_source_import_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"last_source_import_at","typeLabel":"string\u003cdate-time> | null"},"curate_task_id":{"oneOf":[{"description":"The curate task — the running one, or the last to finish.","type":"string","uniqueKey":"curate_task_id.oneOf.0","typeLabel":"string"},{"description":"The curate task — the running one, or the last to finish.","type":"null","uniqueKey":"curate_task_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"curate_task_id","typeLabel":"string | null"},"import_task_id":{"oneOf":[{"description":"The import task — the running one, or the last to finish.","type":"string","uniqueKey":"import_task_id.oneOf.0","typeLabel":"string"},{"description":"The import task — the running one, or the last to finish.","type":"null","uniqueKey":"import_task_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"import_task_id","typeLabel":"string | null"},"explore_task_id":{"oneOf":[{"description":"The explore task — the running one, or the last to finish.","type":"string","uniqueKey":"explore_task_id.oneOf.0","typeLabel":"string"},{"description":"The explore task — the running one, or the last to finish.","type":"null","uniqueKey":"explore_task_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"explore_task_id","typeLabel":"string | null"},"restore_task_id":{"oneOf":[{"description":"The restore task — the running one, or the last to finish.","type":"string","uniqueKey":"restore_task_id.oneOf.0","typeLabel":"string"},{"description":"The restore task — the running one, or the last to finish.","type":"null","uniqueKey":"restore_task_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"restore_task_id","typeLabel":"string | null"},"manifest_suggestion":{"description":"Outcome of the last explore run, pinned to the context row. A proposal only — apply it by writing the manifest and forcing a curate.","type":"object","properties":{"matches":{"description":"Proposed templates, best fit first.","type":"array","items":{"description":"One manifest template an explore run proposes for the corpus.","type":"object","properties":{"template_id":{"description":"Catalog entry the run proposes for this corpus.","type":"string","isRequired":true,"uniqueKey":"manifest_suggestion.matches.items.[INDEX].template_id","typeLabel":"string"},"rationale":{"description":"Why the run thinks this template fits the corpus.","type":"string","isRequired":true,"uniqueKey":"manifest_suggestion.matches.items.[INDEX].rationale","typeLabel":"string"},"confidence":{"description":"How sure the run is, 0–1. Low-confidence proposals are dropped before this point.","type":"number","format":"double","isRequired":true,"uniqueKey":"manifest_suggestion.matches.items.[INDEX].confidence","typeLabel":"number\u003cdouble>"}},"required":["template_id","rationale","confidence"],"uniqueKey":"manifest_suggestion.matches.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"manifest_suggestion.matches","typeLabel":"object[]"},"none":{"description":"True when no template fit","type":"boolean","isRequired":true,"uniqueKey":"manifest_suggestion.none","typeLabel":"boolean"},"explored_at":{"description":"When the run produced this proposal.","type":"string","format":"date-time","isRequired":true,"uniqueKey":"manifest_suggestion.explored_at","typeLabel":"string\u003cdate-time>"},"task_id":{"description":"The explore task that produced it.","type":"string","uniqueKey":"manifest_suggestion.task_id","typeLabel":"string"}},"required":["matches","none","explored_at"],"uniqueKey":"manifest_suggestion","typeLabel":"object"},"sample_queries":{"description":"Example questions the curated corpus can answer, written by the last curate.","type":"array","items":{"description":"One example question.","type":"string","uniqueKey":"sample_queries.items.[INDEX]","typeLabel":"string"},"uniqueKey":"sample_queries","typeLabel":"string[]"},"groom_task_id":{"description":"The groom task — the running one, or the last to finish.","type":"string","uniqueKey":"groom_task_id","typeLabel":"string"},"groom_artifact_count":{"description":"Artifacts the last groom left in the work context.","type":"integer","format":"int64","uniqueKey":"groom_artifact_count","typeLabel":"integer\u003cint64>"},"last_groomed_at":{"description":"When a groom last consolidated the work context.","type":"string","format":"date-time","uniqueKey":"last_groomed_at","typeLabel":"string\u003cdate-time>"},"stats":{"type":"object","description":"Aggregate task counters. Populated only on the list endpoint.","required":["tasks_total","tasks_active","tasks_completed","tasks_failed","tasks_cancelled","tokens_total","runtime_seconds"],"properties":{"tasks_total":{"description":"Tasks this context has ever run.","type":"integer","format":"int64","isRequired":true,"uniqueKey":"stats.tasks_total","typeLabel":"integer\u003cint64>"},"tasks_active":{"description":"Tasks in a non-terminal state.","type":"integer","format":"int64","isRequired":true,"uniqueKey":"stats.tasks_active","typeLabel":"integer\u003cint64>"},"tasks_completed":{"description":"Tasks that finished successfully.","type":"integer","format":"int64","isRequired":true,"uniqueKey":"stats.tasks_completed","typeLabel":"integer\u003cint64>"},"tasks_failed":{"description":"Tasks that ended in failure.","type":"integer","format":"int64","isRequired":true,"uniqueKey":"stats.tasks_failed","typeLabel":"integer\u003cint64>"},"tasks_cancelled":{"description":"Runs stopped before they finished.","type":"integer","format":"int64","isRequired":true,"uniqueKey":"stats.tasks_cancelled","typeLabel":"integer\u003cint64>"},"tokens_total":{"description":"Prompt plus completion tokens across every task.","type":"integer","format":"int64","isRequired":true,"uniqueKey":"stats.tokens_total","typeLabel":"integer\u003cint64>"},"runtime_seconds":{"description":"Summed container runtime across every task.","type":"integer","format":"int64","isRequired":true,"uniqueKey":"stats.runtime_seconds","typeLabel":"integer\u003cint64>"}},"uniqueKey":"stats","typeLabel":"object"}},"required":["id","slug","name","kind","created_by","description","is_optimizing","has_sources","is_curating","is_importing","is_exploring","is_restoring","is_grooming","created_at","updated_at"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","slug":"\u003cstring>","name":"\u003cstring>","kind":"search","created_by":"\u003cstring>","description":"\u003cstring>","is_optimizing":true,"has_sources":true,"is_curating":true,"is_importing":true,"is_exploring":true,"is_restoring":true,"is_grooming":true,"created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z","workspace":"\u003cstring>","guide":"\u003cstring>","manifest":{"curate":{"chunks":{"enabled":true,"embedding_model":"multilingual-e5-large","chunking":{"strategy":"markdown_heading","target_size":512,"overlap":64,"respect_sections":true},"keyword":{"enabled":true}},"artifacts":{"enabled":false,"artifact_model":"lite","artifact_types":[{"name":"\u003cstring>","kind":"topic","scope":"corpus","icon":"\u003cstring>","description":"\u003cstring>","coverage":["\u003cstring>"],"sections":["\u003cstring>"],"min_doc_count":1,"format":"markdown","columns":[{"name":"\u003cstring>","type":"TEXT","description":"\u003cstring>"}],"natural_key":["\u003cstring>"]}],"edge_types":[{"name":"\u003cstring>","from":"\u003cstring>","to":"\u003cstring>","description":"\u003cstring>","attributes":["\u003cstring>"]}],"min_doc_count":1,"max_tokens":1500,"max_doc_chars":60000,"extraction_window_chars":0,"mention_max_chars":400,"max_mentions_per_artifact":40,"mention_context_chars":8000,"max_artifacts_per_type":10000}},"optimize":{"schedule":"0 * * * *","latency_threshold_ms":60000,"min_group_size":2,"eval_pass_rate_threshold":1,"max_iterations":20},"search":{"instructions":"\u003cstring>"}},"semantic_index":"\u003cstring>","keyword_index":"\u003cstring>","optimize_task_id":"\u003cstring>","optimize_score":123,"optimize_iterations":123,"last_optimized_at":"2023-11-07T05:31:56Z","last_curated_at":"2023-11-07T05:31:56Z","last_source_import_at":"2023-11-07T05:31:56Z","curate_task_id":"\u003cstring>","import_task_id":"\u003cstring>","explore_task_id":"\u003cstring>","restore_task_id":"\u003cstring>","manifest_suggestion":{"matches":[{"template_id":"\u003cstring>","rationale":"\u003cstring>","confidence":123}],"none":true,"explored_at":"2023-11-07T05:31:56Z","task_id":"\u003cstring>"},"sample_queries":["\u003cstring>"],"groom_task_id":"\u003cstring>","groom_artifact_count":123,"last_groomed_at":"2023-11-07T05:31:56Z","stats":{"tasks_total":123,"tasks_active":123,"tasks_completed":123,"tasks_failed":123,"tasks_cancelled":123,"tokens_total":123,"runtime_seconds":123}}}},"exampleType":"generated"}},"exampleType":"generated"},"afe1dbd1-19f2-4f33-8b21-9052f3e283b7":{"description":"Invalid request","content":{"application/json":{"schema":{"description":"The error envelope every non-2xx response uses.","type":"object","properties":{"message":{"description":"Human-readable explanation. Not stable — branch on `code`, not on this.","type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"description":"Stable machine-readable code, present only on errors a client must branch on. ","x-enum":["unsupported_api_version","preview_not_enabled","preview_file_limit","preview_byte_limit","workspace_host_required","workspace_not_found"],"type":"string","uniqueKey":"code","typeLabel":"string"}},"required":["message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","code":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"57696cff-241a-4abf-a8f7-2df6f984f59d":{"description":"Not found","content":{"application/json":{"schema":{"description":"The error envelope every non-2xx response uses.","type":"object","properties":{"message":{"description":"Human-readable explanation. Not stable — branch on `code`, not on this.","type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"description":"Stable machine-readable code, present only on errors a client must branch on. ","x-enum":["unsupported_api_version","preview_not_enabled","preview_file_limit","preview_byte_limit","workspace_host_required","workspace_not_found"],"type":"string","uniqueKey":"code","typeLabel":"string"}},"required":["message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","code":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"153888d6-605d-48e8-81be-f07494b34685":{"description":"Slug conflict","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"0831f00e-3f5e-4a3b-8468-71f65be635b5":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Session token from `POST /auth/login`, sent as `Authorization: Bearer \u003ctoken>`.","scopes":[],"schemeName":"bearerAuth"}},"98ada4b9-3d74-41a7-b83e-d7f377508368":{"apiKey":{"type":"apiKey","in":"header","name":"Api-Key","description":"Pinecone API key, accepted as an alternative to the bearer token.","scopes":[],"schemeName":"apiKey"}}},"servers":{"99373903-6548-4b08-80ee-c6e520612dde":{"url":"https://{host}/api","description":"Your Nexus deployment host","variables":{"host":{"default":"api.example.com","description":"Host of your Nexus deployment."}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Session token from `POST /auth/login`, sent as `Authorization: Bearer \u003ctoken>`.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Session token from `POST /auth/login`, sent as `Authorization: Bearer \u003ctoken>`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"},{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"Api-Key","description":"Pinecone API key, accepted as an alternative to the bearer token.","scopes":[],"schemeName":"apiKey"},"schema":{"title":"Api-Key","type":"string","description":"Pinecone API key, accepted as an alternative to the bearer token.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKey","name":"Api-Key"}],"title":"apiKey"}]},"originalFileLocation":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml"},"subdomain":"pinecone","siteName":"Pinecone Docs","title":"Update a context - Pinecone Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-03T00:34:47.235Z","originalFileLocation":"api-reference/contexts/update-a-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=\"All fields optional; an absent one is left untouched. An empty string clears description/guide, and {} clears the manifest back to defaults.\">\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=\"Update a context - Pinecone Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"All fields optional; an absent one is left untouched. An empty string clears description/guide, and {} clears the manifest back to defaults.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Pinecone Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.pinecone.io/api-reference/contexts/update-a-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/api-reference/contexts/update-a-context\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/contexts/update-a-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/api-reference/contexts/update-a-context#webpage\",\"url\":\"https://docs.pinecone.io/api-reference/contexts/update-a-context\",\"name\":\"Update a context\",\"description\":\"All fields optional; an absent one is left untouched. An empty string clears description/guide, and {} clears the manifest back to defaults.\",\"dateModified\":\"2026-11-03T00:34:47.235Z\",\"isPartOf\":{\"@id\":\"https://docs.pinecone.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.pinecone.io/api-reference/contexts/update-a-context#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.pinecone.io/api-reference/contexts/update-a-context#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Data plane\",\"item\":\"https://docs.pinecone.io/api-reference/auth/exchange-a-pinecone-api-key-for-a-session-token\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Contexts\",\"item\":\"https://docs.pinecone.io/api-reference/contexts/list-contexts-newest-first-with-stats\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Update a context\",\"item\":\"https://docs.pinecone.io/api-reference/contexts/update-a-context\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.pinecone.io/api-reference/contexts/update-a-context#apireference\",\"headline\":\"Update a context\",\"name\":\"Update a context\",\"description\":\"All fields optional; an absent one is left untouched. An empty string clears description/guide, and {} clears the manifest back to defaults.\",\"url\":\"https://docs.pinecone.io/api-reference/contexts/update-a-context\",\"mainEntityOfPage\":{\"@id\":\"https://docs.pinecone.io/api-reference/contexts/update-a-context#webpage\"},\"image\":\"https://www.pinecone.io/images/docs_og_image_v2.png\",\"dateModified\":\"2026-11-03T00:34:47.235Z\",\"publisher\":{\"@id\":\"https://docs.pinecone.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.pinecone.io#website\"}}]}\u003c/script>","agentPointerHref":"/api-reference/contexts/update-a-context.md","siteName":"Pinecone Docs","nav":{"global":null,"dropdowns":[{"dropdown":"Pinecone Database","icon":"database","description":"Search engine for AI agents and applications","tabs":[{"tab":"Guides","groups":[{"group":"Get started","pages":[{"title":"Pinecone Database","sidebarTitle":"Overview","mode":"wide","href":"/guides/get-started/overview"},{"title":"Pinecone quickstart","sidebarTitle":"Quickstart","href":"/guides/get-started/quickstart"},{"title":"Pinecone Documents API","sidebarTitle":"Documents API","href":"/guides/get-started/documents-api"},{"title":"Pinecone architecture","sidebarTitle":"Architecture","href":"/guides/get-started/architecture"}]},{"group":"Indexes","pages":[{"title":"Index data overview","sidebarTitle":"Overview","href":"/guides/indexes/index-data-overview"},{"group":"Create and configure","pages":[{"title":"Create an index","sidebarTitle":"Create an index","href":"/guides/indexes/create-an-index"},{"title":"Move to the Documents API","sidebarTitle":"Move to the Documents API","href":"/guides/indexes/move-to-the-documents-api"},{"title":"Convert an index to a document index","sidebarTitle":"Convert an index","href":"/guides/indexes/convert-an-index"},{"title":"Index configuration","sidebarTitle":"Index configuration","href":"/guides/indexes/index-configuration"},{"title":"Processing locations","href":"/guides/indexes/processing-locations"},{"title":"Configure metadata indexing","href":"/guides/indexes/configure-metadata-indexing"},{"title":"Manage serverless indexes","sidebarTitle":"Manage indexes","href":"/guides/indexes/manage-indexes"}]},{"title":"Target an index","href":"/guides/indexes/target-an-index"},{"title":"Data modeling","href":"/guides/indexes/data-modeling"},{"group":"Backups","pages":[{"title":"Backups overview","href":"/guides/indexes/backups-overview"},{"title":"Back up an index","href":"/guides/indexes/back-up-an-index"},{"title":"Restore an index","href":"/guides/indexes/restore-an-index"}]}]},{"group":"Data","pages":[{"group":"Ingestion","pages":[{"title":"Data ingestion overview","sidebarTitle":"Overview","href":"/guides/data/data-ingestion-overview"},{"title":"Upsert data","href":"/guides/data/upsert-data"},{"title":"Import data","href":"/guides/data/import-data"},{"group":"Integrate with cloud storage","pages":[{"title":"Integrate with Amazon S3","icon":"aws","sidebarTitle":"Amazon S3","href":"/guides/storage-integrations/integrate-with-amazon-s3"},{"title":"Integrate with Google Cloud Storage","icon":"google","sidebarTitle":"Google Cloud Storage (GCS)","href":"/guides/storage-integrations/integrate-with-google-cloud-storage"},{"title":"Integrate with Azure Blob Storage","icon":"microsoft","sidebarTitle":"Azure Blob Storage","href":"/guides/storage-integrations/integrate-with-azure-blob-storage"},{"title":"Manage storage integrations","href":"/guides/storage-integrations/manage-storage-integrations"}]},{"title":"Migrate from pgvector","href":"/guides/data/migrate-from-pgvector"},{"title":"Check data freshness","href":"/guides/data/check-data-freshness"}]},{"group":"Namespaces","pages":[{"title":"Manage namespaces","href":"/guides/data/manage-namespaces"},{"group":"Aliases","pages":[{"title":"Namespace aliases overview","sidebarTitle":"Overview","href":"/guides/data/namespace-aliases/overview"},{"title":"Swap a namespace without downtime","sidebarTitle":"Swap a namespace","href":"/guides/data/namespace-aliases/swap-a-namespace"},{"title":"Manage namespace aliases","sidebarTitle":"Manage aliases","href":"/guides/data/namespace-aliases/manage-aliases"}]}]},{"group":"Multitenancy","pages":[{"title":"Design for multitenancy","sidebarTitle":"Design","href":"/guides/data/design-for-multitenancy"},{"title":"Implement multitenancy","sidebarTitle":"Implement","href":"/guides/data/implement-multitenancy"}]},{"group":"Documents and records","pages":[{"title":"Fetch data","href":"/guides/data/fetch-data"},{"title":"List IDs","href":"/guides/data/list-record-ids"},{"title":"Update data","href":"/guides/data/update-data"},{"title":"Delete data","href":"/guides/data/delete-data"},{"title":"Manage document chunks","href":"/guides/data/manage-document-chunks"}]}]},{"group":"Search","pages":[{"title":"Search overview","sidebarTitle":"Overview","href":"/guides/search/search-overview"},{"group":"Full-text search","pages":[{"title":"Full-text search overview","sidebarTitle":"Overview","href":"/guides/search/full-text-search"},{"title":"Full-text search query syntax","sidebarTitle":"Query syntax","href":"/guides/search/full-text-search/query-syntax"},{"title":"Full-text search text processing","sidebarTitle":"Text processing","href":"/guides/search/full-text-search/text-processing"}]},{"title":"Semantic search","href":"/guides/search/semantic-search"},{"title":"Sparse-vector search","href":"/guides/search/sparse-vector-search"},{"group":"Hybrid search","pages":[{"title":"Hybrid search overview","sidebarTitle":"Overview","href":"/guides/search/hybrid-search"},{"title":"Reciprocal rank fusion","href":"/guides/search/reciprocal-rank-fusion"}]},{"title":"Integrated embedding","href":"/guides/search/integrated-embedding"},{"title":"Bring your own vectors","href":"/guides/search/bring-your-own-vectors"},{"title":"Filter by metadata","href":"/guides/search/filter-by-metadata"},{"title":"Rerank results","href":"/guides/search/rerank-results"}]},{"group":"Optimize","pages":[{"title":"Increase search relevance","sidebarTitle":"Increase relevance","href":"/guides/optimize/increase-relevance"},{"title":"Diagnose poor search results","href":"/guides/optimize/debug-recall"},{"title":"Increase throughput","href":"/guides/optimize/increase-throughput"},{"title":"Decrease latency","href":"/guides/optimize/decrease-latency"},{"title":"Test Pinecone at scale","sidebarTitle":"Test at scale","href":"/guides/optimize/test-at-scale"},{"group":"Dedicated read nodes","pages":[{"title":"Dedicated read nodes overview","sidebarTitle":"Overview","href":"/guides/optimize/dedicated-read-nodes/overview"},{"title":"Dedicated read nodes concepts","sidebarTitle":"Concepts","href":"/guides/optimize/dedicated-read-nodes/concepts"},{"title":"Create a dedicated read nodes index","sidebarTitle":"Create","href":"/guides/optimize/dedicated-read-nodes/create"},{"title":"Migrate to dedicated read nodes","sidebarTitle":"Migrate","href":"/guides/optimize/dedicated-read-nodes/migrate"},{"title":"Size and test a dedicated read nodes index","sidebarTitle":"Size and test","href":"/guides/optimize/dedicated-read-nodes/size-and-test"},{"title":"Tune queries on dedicated read nodes","sidebarTitle":"Tune queries","href":"/guides/optimize/dedicated-read-nodes/tune-queries"},{"title":"Scale a dedicated read nodes index","sidebarTitle":"Scale","href":"/guides/optimize/dedicated-read-nodes/scale"},{"title":"Manage a dedicated read nodes index","sidebarTitle":"Manage","href":"/guides/optimize/dedicated-read-nodes/manage"}]}]},{"group":"Cost","pages":[{"title":"Understand Pinecone cost","href":"/guides/cost/understand-cost"},{"title":"Save on Pinecone costs","href":"/guides/cost/save-on-costs"},{"title":"Set monthly spend alerts","href":"/guides/cost/set-spend-alerts"},{"title":"Check usage per request","href":"/guides/cost/check-usage-per-request"},{"title":"Download a usage report","url":"/admin/billing/download-usage-report","href":"/guides/cost/download-usage-report-link"}]},{"group":"Production","pages":[{"title":"Production checklist","sidebarTitle":"Overview","href":"/guides/production/production-checklist"},{"group":"Bring Your Own Cloud (BYOC)","pages":[{"title":"Bring Your Own Cloud (BYOC) overview","sidebarTitle":"Overview","href":"/guides/production/bring-your-own-cloud"},{"title":"Deploy BYOC","sidebarTitle":"Deploy","href":"/guides/production/bring-your-own-cloud/deploy"},{"title":"Create an index in BYOC","sidebarTitle":"Create an index","href":"/guides/production/bring-your-own-cloud/create-an-index"},{"title":"Connect to and manage BYOC","sidebarTitle":"Connect and manage","href":"/guides/production/bring-your-own-cloud/connect-and-manage"}]},{"group":"Data security","pages":[{"title":"Configure customer-managed encryption keys","sidebarTitle":"Configure CMEK","href":"/guides/production/configure-cmek"},{"title":"Configure private endpoints","sidebarTitle":"Configure private endpoints","href":"/guides/production/configure-private-endpoints"},{"title":"Data deletion on Pinecone","sidebarTitle":"Data deletion policy","href":"/guides/production/data-deletion"}]},{"title":"Error handling","href":"/guides/production/error-handling"},{"title":"Mock the Pinecone API for testing","sidebarTitle":"Mock the API for testing","href":"/guides/production/mock-the-api"},{"title":"Monitor performance","href":"/guides/production/monitor-performance"}]},{"group":"Agents","pages":[{"title":"Use the Pinecone MCP server","sidebarTitle":"Use the MCP server","href":"/guides/agents/mcp-server"},{"title":"Build a knowledge retrieval agent","href":"/guides/agents/build-a-knowledge-agent"}]},{"group":"Legacy","pages":[{"group":"Vectors API","pages":[{"title":"Create a legacy vector index","sidebarTitle":"Create a vector index","href":"/guides/legacy/vectors-api/create-a-vector-index"},{"title":"Upsert vectors into a legacy vector index","sidebarTitle":"Upsert vectors","href":"/guides/legacy/vectors-api/upsert-vectors"},{"title":"Import vectors into a legacy vector index","sidebarTitle":"Import vectors","href":"/guides/legacy/vectors-api/import-vectors"},{"title":"Query a legacy vector index","sidebarTitle":"Query vectors","href":"/guides/legacy/vectors-api/query-vectors"},{"title":"Fetch vectors from a legacy vector index","sidebarTitle":"Fetch vectors","href":"/guides/legacy/vectors-api/fetch-vectors"},{"title":"Update vectors in a legacy vector index","sidebarTitle":"Update vectors","href":"/guides/legacy/vectors-api/update-vectors"},{"title":"Delete vectors from a legacy vector index","sidebarTitle":"Delete vectors","href":"/guides/legacy/vectors-api/delete-vectors"},{"title":"List vector IDs in a legacy vector index","sidebarTitle":"List vector IDs","href":"/guides/legacy/vectors-api/list-vector-ids"},{"title":"Manage chunked records in a legacy index","sidebarTitle":"Manage chunked records","href":"/guides/legacy/vectors-api/manage-chunked-records"},{"title":"Run hybrid search on a legacy vector index","sidebarTitle":"Hybrid search on a single index","href":"/guides/legacy/vectors-api/hybrid-search-single-index"},{"title":"Run hybrid search on two legacy vector indexes","sidebarTitle":"Hybrid search on separate indexes","href":"/guides/legacy/vectors-api/hybrid-search-separate-indexes"}]},{"group":"Records API","pages":[{"title":"Create a legacy integrated index","sidebarTitle":"Create an integrated index","href":"/guides/legacy/records-api/create-an-integrated-index"},{"title":"Upsert text into a legacy integrated index","sidebarTitle":"Upsert text","href":"/guides/legacy/records-api/upsert-text"},{"title":"Search a legacy integrated index with text","sidebarTitle":"Search with text","href":"/guides/legacy/records-api/search-with-text"}]},{"group":"Pod-based indexes","pages":[{"title":"Understanding pod-based indexes","sidebarTitle":"Overview","href":"/guides/legacy/pod-based-indexes/understanding-pod-based-indexes"},{"title":"Migrate a pod-based index to serverless","href":"/guides/legacy/pod-based-indexes/migrate-a-pod-based-index-to-serverless"},{"title":"Choose a pod type and size","sidebarTitle":"Choose a pod type","href":"/guides/legacy/pod-based-indexes/choose-a-pod-type-and-size"},{"title":"Create a pod-based index","href":"/guides/legacy/pod-based-indexes/create-a-pod-based-index"},{"title":"Manage pod-based indexes","href":"/guides/legacy/pod-based-indexes/manage-pod-based-indexes"},{"title":"Scale pod-based indexes","href":"/guides/legacy/pod-based-indexes/scale-pod-based-indexes"},{"group":"Backups","pages":[{"title":"Understanding collections","href":"/guides/legacy/pod-based-indexes/understanding-collections"},{"title":"Back up a pod-based index","href":"/guides/legacy/pod-based-indexes/back-up-a-pod-based-index"},{"title":"Restore a pod-based index","href":"/guides/legacy/pod-based-indexes/restore-a-pod-based-index"}]}]}]}]},{"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 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":"Index conversion","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}/convert","title":"Convert an index into a document index","href":"/reference/api/2026-07/control-plane/convert_index"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_control_2026-07.oas.yaml get /conversion-jobs","title":"List conversion jobs","href":"/reference/api/2026-07/control-plane/list_conversion_jobs"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_control_2026-07.oas.yaml get /conversion-jobs/{job_id}","title":"Describe a conversion job","href":"/reference/api/2026-07/control-plane/describe_conversion_job"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_control_2026-07.oas.yaml post /conversion-jobs/{job_id}/cancel","title":"Cancel a conversion job","href":"/reference/api/2026-07/control-plane/cancel_conversion_job"}]},{"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":"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":"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":"Legacy Vectors API","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 /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 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":"Legacy Records API","pages":[{"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_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 post /records/namespaces/{namespace}/search","title":"Search with text (legacy Records API)","href":"/reference/api/2026-07/data-plane/search_records"}]}]},{"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","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","href":"/reference/tools/pinecone-spark-connector"}]}]},{"version":"2026-04","pages":[{"title":"2026-04","href":"/reference/api/introduction"}]},{"version":"2025-10","pages":[{"title":"2025-10","href":"/reference/api/introduction"}]},{"version":"2025-04","pages":[{"title":"2025-04","href":"/reference/api/introduction"}]},{"version":"2025-01","pages":[{"title":"2025-01","href":"/reference/api/introduction"}]},{"version":"2024-10","pages":[{"title":"2024-10","href":"/reference/api/introduction"}]},{"version":"2024-07","pages":[{"title":"2024-07","href":"/reference/api/introduction"}]},{"version":"2024-04","pages":[{"title":"2024-04","href":"/reference/api/introduction"}]}]},{"tab":"Examples","groups":[{"group":"Examples","pages":[{"title":"Notebooks","href":"/examples/notebooks"},{"title":"Sample apps","href":"/examples/sample-apps"},{"title":"Reference architectures","href":"/examples/reference-architectures"}]}]},{"tab":"Models","groups":[{"group":"Models","pages":[{"title":"Model gallery","href":"/models/overview"}]}]},{"tab":"Integrations","groups":[{"group":"Connect an integration","pages":[{"title":"Integrations overview","sidebarTitle":"All integrations","href":"/integrations/overview"},{"group":"AI coding tools","pages":[{"title":"AI coding tools","sidebarTitle":"Overview","href":"/integrations/ai-coding-tools"},{"title":"Agent Skills","href":"/integrations/agent-skills"},{"title":"Claude Code plugin","href":"/integrations/claude-code"},{"title":"Codex plugin","href":"/integrations/codex"},{"title":"Cursor plugin","href":"/integrations/cursor"}]},{"group":"Data sources","pages":[{"title":"Airbyte","href":"/integrations/airbyte"},{"title":"Apify","href":"/integrations/apify"},{"title":"Aryn","href":"/integrations/aryn"},{"title":"Box","href":"/integrations/box"},{"title":"Confluent","href":"/integrations/confluent"},{"title":"Databricks","href":"/integrations/databricks"},{"title":"Estuary","href":"/integrations/estuary"},{"title":"Fleak","href":"/integrations/fleak"},{"title":"FlowiseAI","href":"/integrations/flowise"},{"title":"Gathr","href":"/integrations/gathr"},{"title":"Matillion","href":"/integrations/matillion"},{"title":"Nexla","href":"/integrations/nexla"},{"title":"Redpanda","href":"/integrations/redpanda"},{"title":"Snowflake Openflow","href":"/integrations/snowflake-openflow"},{"title":"StreamNative","href":"/integrations/streamnative"},{"title":"Unstructured","href":"/integrations/unstructured"}]},{"group":"Frameworks","pages":[{"title":"AI Engine","href":"/integrations/ai-engine"},{"title":"Amazon Bedrock","href":"/integrations/amazon-bedrock"},{"title":"Amazon SageMaker","href":"/integrations/amazon-sagemaker"},{"title":"Cloudera AI","href":"/integrations/cloudera"},{"title":"Context Data","href":"/integrations/context-data"},{"title":"Genkit","href":"/integrations/genkit"},{"title":"Haystack","href":"/integrations/haystack"},{"title":"Instill AI","href":"/integrations/instill"},{"title":"LangChain","href":"/integrations/langchain"},{"title":"LlamaIndex","href":"/integrations/llamaindex"},{"title":"n8n","href":"/integrations/n8n"},{"title":"Progress Agentic RAG","href":"/integrations/progress-agentic-rag"},{"title":"VoltAgent","href":"/integrations/voltagent"}]},{"group":"Infrastructure","pages":[{"title":"AWS Marketplace","href":"/integrations/aws-marketplace"},{"title":"Google Cloud Marketplace","href":"/integrations/google-cloud-marketplace"},{"title":"Microsoft Marketplace","href":"/integrations/microsoft-marketplace"},{"title":"Pulumi","href":"/integrations/pulumi"},{"title":"Terraform","href":"/integrations/terraform"},{"title":"Vercel","href":"/integrations/vercel"},{"title":"Zapier","href":"/integrations/zapier"}]},{"group":"Models","pages":[{"title":"Cohere","href":"/integrations/cohere"},{"title":"Voyage AI","href":"/integrations/voyage"},{"title":"Hugging Face Inference Endpoints","href":"/integrations/hugging-face-inference-endpoints"},{"title":"Jina AI","href":"/integrations/jina"},{"title":"OpenAI","href":"/integrations/openai"},{"title":"Twelve Labs","href":"/integrations/twelve-labs"}]},{"group":"Observability","pages":[{"title":"Datadog","href":"/integrations/datadog"},{"title":"HoneyHive","href":"/integrations/honeyhive"},{"title":"New Relic","href":"/integrations/new-relic"},{"title":"Traceloop","href":"/integrations/traceloop"},{"title":"TruLens","href":"/integrations/trulens"}]}]},{"group":"Build an integration","pages":[{"title":"Integration ecosystem","href":"/integrations/build-integration/integration-ecosystem"},{"title":"Attribute usage to your integration","href":"/integrations/build-integration/attribute-usage-to-your-integration"},{"title":"Connect your users to Pinecone","href":"/integrations/build-integration/connect-your-users-to-pinecone"}]}]},{"tab":"Admin","groups":[{"group":"Organizations","pages":[{"title":"Organizations overview","sidebarTitle":"Overview","href":"/admin/organizations/organizations-overview"},{"title":"Manage organization members","sidebarTitle":"Manage members","href":"/admin/organizations/manage-organization-members"},{"title":"Manage organization service accounts","sidebarTitle":"Manage service accounts","href":"/admin/organizations/manage-service-accounts"},{"title":"Delete your organization","href":"/admin/organizations/delete-your-organization"}]},{"group":"Projects","pages":[{"title":"Projects overview","sidebarTitle":"Overview","href":"/admin/projects/projects-overview"},{"title":"Create a project","mode":"wide","href":"/admin/projects/create-a-project"},{"title":"Manage projects","href":"/admin/projects/manage-projects"},{"title":"Manage project members","href":"/admin/projects/manage-project-members"},{"title":"Manage API keys","href":"/admin/projects/manage-api-keys"},{"title":"Manage project service accounts","sidebarTitle":"Manage service accounts","href":"/admin/projects/manage-service-accounts"}]},{"group":"Billing","pages":[{"title":"Upgrade your billing plan","href":"/admin/billing/upgrade-billing-plan"},{"title":"Redeem a promo code","href":"/admin/billing/redeem-a-promo-code"},{"title":"Change your payment method","href":"/admin/billing/change-payment-method"},{"title":"Account deactivation for non-payment","href":"/admin/billing/non-payment-account-deactivation"},{"title":"Downgrade your billing plan","href":"/admin/billing/downgrade-billing-plan"},{"title":"Download a usage report","href":"/admin/billing/download-usage-report"},{"title":"Access your invoices","href":"/admin/billing/access-your-invoices"},{"title":"Pinecone Standard plan trial","href":"/admin/billing/standard-trial"},{"title":"Billing disputes and refunds","href":"/admin/billing/billing-disputes-and-refunds"}]},{"group":"Security","pages":[{"title":"Security overview","sidebarTitle":"Overview","href":"/admin/security/security-overview"},{"title":"Manage roles and access","sidebarTitle":"Manage roles and access","href":"/admin/security/manage-rbac"},{"group":"Single sign-on","pages":[{"title":"Configure SSO with Okta","href":"/admin/security/configure-single-sign-on/okta"},{"title":"Manage roles with Okta","sidebarTitle":"Manage roles with Okta","href":"/admin/security/configure-single-sign-on/okta-role-management"},{"title":"SCIM provisioning with Okta","sidebarTitle":"SCIM provisioning with Okta","href":"/admin/security/configure-single-sign-on/okta-scim-provisioning"}]},{"title":"Configure audit logs","href":"/admin/security/configure-audit-logs"}]},{"group":"Account and support","pages":[{"title":"Get help with Pinecone","sidebarTitle":"Get help","href":"/admin/support/contact-support"},{"title":"Support plans and SLAs","href":"/admin/support/pinecone-support-slas"},{"title":"Login code issues","href":"/admin/account/login-code-issues"},{"title":"Custom data processing agreements","href":"/admin/account/custom-data-processing-agreements"},{"title":"Delete your account","href":"/admin/account/delete-your-account"}]}]}]},{"dropdown":"Pinecone Assistant","icon":"comments","description":"Managed RAG for chat and agent applications","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","href":"/guides/assistant/create-assistant"},{"title":"Manage assistants","href":"/guides/assistant/manage-assistants"}]},{"group":"Upload your data","pages":[{"title":"Files overview","sidebarTitle":"Overview","href":"/guides/assistant/files-overview"},{"title":"Upload files","href":"/guides/assistant/upload-files"},{"title":"Manage files","href":"/guides/assistant/manage-files"},{"title":"File metadata","sidebarTitle":"File metadata","href":"/guides/assistant/file-metadata"},{"title":"Multimodal context","sidebarTitle":"Multimodal context","href":"/guides/assistant/multimodal-context"}]},{"group":"Chat with an assistant","pages":[{"title":"Chat through the standard interface","sidebarTitle":"Standard interface","href":"/guides/assistant/chat-standard-interface"},{"title":"Chat through the OpenAI-compatible interface","sidebarTitle":"OpenAI-compatible interface","href":"/guides/assistant/chat-openai-compatible-interface"}]},{"group":"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":"Evaluate answers","pages":[{"title":"Evaluation overview","sidebarTitle":"Overview","href":"/guides/assistant/evaluation-overview"},{"title":"Evaluate answers","href":"/guides/assistant/evaluate-answers"}]},{"group":"Agents","pages":[{"title":"Use the Pinecone Assistant MCP server","sidebarTitle":"Use the 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-usage-and-cost"},{"title":"Billing and access","url":"/admin/organizations/organizations-overview","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","description":"Knowledge engine for agents","tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/guides/nexus/overview"}]},{"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","description":"One context and its derived lifecycle flags.","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)","description":"Delete the context, its sources, its curated knowledge, and its Pinecone indexes. Not reversible.","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","description":"Open-source PostgreSQL extension for Pinecone search","tabs":[{"tab":"Guides","groups":[{"group":"Get started","pages":[{"title":"pg_pinecone","sidebarTitle":"Overview","href":"/guides/pg-pinecone/overview"},{"title":"Install pg_pinecone","sidebarTitle":"Install","href":"/guides/pg-pinecone/install"},{"title":"pg_pinecone quickstart","sidebarTitle":"Quickstart","href":"/guides/pg-pinecone/quickstart"}]},{"group":"Engines","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":"Migrate from pgvector","url":"https://docs.pinecone.io/guides/data/migrate-from-pgvector","href":"/guides/pg-pinecone/migrate-from-pgvector"}]},{"group":"Search","pages":[{"title":"Search a table with full-text search","sidebarTitle":"Full-text search","href":"/guides/pg-pinecone/full-text-search"},{"title":"Search a table with semantic search","sidebarTitle":"Semantic search","href":"/guides/pg-pinecone/semantic-search"}]},{"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","description":"Every Pinecone change by product or topic","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"}]}]},"basePath":"","title":"Update a context - Pinecone Docs","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["10e4515597","c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["BannerMarkdown-BOAJk9BH.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js"]}