Convert a serverless vector index or legacy integrated index into a new document index. The source index isn’t changed, and the new index holds a snapshot of the source taken when the job starts.
The request returns once the new index is created in the Initializing state. Track the job with Describe a conversion job. If the job fails or is canceled, the index is left in the InitializationFailed state with no usable data. Delete it to free its name. A job that fails because of your data is charged for the data it read, and a canceled job isn’t charged.
The name of the index. Resource name must be 1-45 characters long, start and end with an alphanumeric character, and consist only of lower case alphanumeric characters or '-'.
The fields the index searches over: dense vectors, sparse vectors, and string fields searched by full-text search or by embeddings Pinecone derives from their text.
An index has one dense vector slot and one sparse vector slot: at most one field can be a dense_vector field or declare embed, and at most one can be a sparse_vector field or declare sparse_embed. Metadata isn't declared in the schema; it's indexed automatically from the documents you upsert.
How a conversion handles a source record the new index cannot take, such as a record whose metadata value for a full_text_search field is not a string. Records the schema can hold are never affected. If omitted, on_error is abort.
Custom user tags added to an index, at most 20 per index. Keys must be 80 characters or less and alphanumeric, '_', or '-'. Values must be 120 characters or less and consist of printable ASCII characters or spaces. To unset a key, set the value to be an empty string. null in responses when the index has no tags.
By default the index will be created with read capacity mode OnDemand, for managed and BYOC indexes alike. If you prefer to allocate dedicated read nodes for your workload, you must specify mode Dedicated and additional configurations for node_type and scaling.
On-demand
Dedicated
Show child attributes
Example:
{ "mode": "OnDemand" }
Response
The new index has been created and the conversion job queued.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Pinecone Docs","description":"Official documentation for Pinecone's trusted AI knowledge platform, including Pinecone Database, Pinecone Assistant, and Pinecone Nexus.","colors":{"primary":"#002BFF","light":"#1E86EE","dark":"#002BFF"},"logo":{"light":"https://mintcdn.com/pinecone/HsZKO51bNmpAasdT/logo/Pinecone-Full-Logo-Black.svg?fit=max\u0026auto=format\u0026n=HsZKO51bNmpAasdT\u0026q=85\u0026s=211d0e7bbefc29ce3b8feee1a05d76ee","dark":"https://mintcdn.com/pinecone/HsZKO51bNmpAasdT/logo/Pinecone-Full-Logo-White.svg?fit=max\u0026auto=format\u0026n=HsZKO51bNmpAasdT\u0026q=85\u0026s=4839c7a50a8bee830e943705c648297c","href":"https://www.pinecone.io"},"favicon":"https://mintcdn.com/pinecone/9qvQp5nU6duJvusQ/favicon-512.png?fit=max\u0026auto=format\u0026n=9qvQp5nU6duJvusQ\u0026q=85\u0026s=a05db290834f742b6b4b5d30a8d74e90","api":{"openapi":["https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_control_2026-07.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_control_2026-07.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/inference_2026-07.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/assistant_control_2026-07.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/assistant_data_2026-07.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/assistant_evaluation_2026-07.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-01.alpha/db_control_2026-01.alpha.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-01.alpha/db_data_2026-01.alpha.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/assistant_control_2026-04.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/assistant_data_2026-04.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/assistant_evaluation_2026-04.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/oauth_2026-04.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_control_2026-04.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_data_2026-04.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/inference_2026-04.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/admin_2025-10.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/oauth_2025-10.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/assistant_control_2025-10.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/assistant_data_2025-10.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/assistant_evaluation_2025-10.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/db_control_2025-10.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/db_data_2025-10.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/inference_2025-10.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/admin_2025-04.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/oauth_2025-04.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/assistant_control_2025-04.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/assistant_data_2025-04.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/assistant_evaluation_2025-04.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/db_control_2025-04.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/db_data_2025-04.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/inference_2025-04.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-01/assistant_control_2025-01.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-01/assistant_data_2025-01.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-01/assistant_evaluation_2025-01.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-01/db_control_2025-01.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-01/db_data_2025-01.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-01/inference_2025-01.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-10/db_control_2024-10.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-10/db_data_2024-10.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-10/inference_2024-10.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-07/control_2024-07.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-07/data_2024-07.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-04/control_2024-04.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-04/data_2024-04.oas.yaml"],"playground":{"display":"simple"}},"appearance":{"default":"system","strict":false},"background":{"color":{"light":"#FBFBFC","dark":"#171717"}},"navbar":{"links":[{"href":"/guides/get-started/overview","label":"Docs"},{"href":"https://status.pinecone.io","label":"Status"},{"href":"https://app.pinecone.io/organizations/-/settings/support","label":"Support"},{"href":"https://app.pinecone.io/?sessionType=login","label":"Log in"}],"primary":{"type":"button","label":"Sign up free","href":"https://app.pinecone.io/?sessionType=signup"}},"footer":{"socials":{"x":"https://x.com/pinecone?ref_src=twsrc%5Egoogle%7Ctwcamp%5Eserp%7Ctwgr%5Eauthor","linkedin":"https://www.linkedin.com/company/pinecone-io","youtube":"https://www.youtube.com/@pinecone-io","github":"https://github.com/pinecone-io"}},"seo":{"metatags":{"og:image":"https://www.pinecone.io/images/docs_og_image_v2.png","twitter:title":"Documentation for the trusted AI knowledge platform | Pinecone","twitter:description":"Guides, API references, and examples for building with Pinecone Database, Pinecone Assistant, and Pinecone Nexus.","twitter:site":"@pinecone","twitter:image":"https://www.pinecone.io/images/docs_og_image_v2.png","google-site-verification":"woTBImNAcYO-gseVfFKIzQrDRUmLWzFjBWrYbYkOTlI"},"indexing":"all"},"integrations":{"gtm":{"tagId":"GTM-5RCSPVG"},"heap":{"appId":"3879495182"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":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":""},"chroma":{"liveDeploymentHistoryId":"6aea076a4867c64450fd0611","collectionId":"f3e0460f-9b2c-423f-a491-4b2fadf1a30a","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aea076a4867c64450fd0611"},"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":"6aea076a4867c64450fd0611","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"default","tag":"Pinecone Database","count":557},{"language":"default","tag":"Reference","count":545},{"language":"default","tag":"Database","count":244},{"language":"default","tag":"Admin","count":151},{"language":"default","tag":"Guides","count":138},{"language":"default","tag":"Pinecone Assistant","count":127},{"language":"default","tag":"Pinecone Nexus","count":81},{"language":"default","tag":"Backups","count":70},{"language":"default","tag":"Indexes","count":66},{"language":"default","tag":"Integrations","count":56}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"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":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"styles.css","content":"@keyframes shimmer{0%{transform:translateX(-100%)}to{transform:translateX(100%)}}:root{--brand-blue:#002BFF;--primary-main:#002BFF;--primary-dark:#222160;--text-contrast:#FFFFFF;--background:#FBFBFC;--paper:#FFFFFF;--surface:#F2F3F6;--divider:#D8DDDF;--secondary:#72788D;--text-primary:#1C1917;--text-body:#44403C;--text-secondary:#72788D;--border:#e7e5e4}.dark{--brand-blue:#1E86EE;--primary-main:#002BFF;--primary-dark:#222160;--text-contrast:#FFFFFF;--background:#171717;--paper:#1E1E1E;--surface:#252525;--divider:#2A2A2A;--secondary:#72788D;--text-primary:#FFFFFF;--text-body:#D4D4D4;--text-secondary:#A0A0A0;--border:#303030}.dark .dark-inverted{filter:invert(1)}#topbar-cta-button{margin-left:1rem}#topbar-cta-button>a{display:flex;align-items:center;padding:.375rem 1rem!important;gap:.5rem;background-color:var(--brand-blue);color:var(--text-contrast)!important;border-radius:.25rem;font-weight:500;letter-spacing:.4px}#topbar-cta-button a:hover{background-color:var(--primary-dark)!important}.documentation-link{color:var(--brand-blue);text-decoration:none}.documentation-link:hover{color:#000}#navbar{background:var(--background);position:fixed}#navbar-transition{border-bottom:1px solid var(--border)}#navbar .max-w-8xl{max-width:100%}#navbar>div>div>div>div>div>div.flex-1.flex.items-center>a:first-child{min-width:209px}[aria-haspopup=menu]{border-radius:.25rem;border:1px solid var(--border);background-color:transparent!important;color:var(--text-primary)}#navbar nav a{color:var(--text-primary);padding:.6rem 1rem;transition:background-color 250ms cubic-bezier(.4,0,.2,1)}#navbar nav ul li:not(:last-of-type){margin-left:0}#navbar a{margin:0;padding-left:.875rem;padding-right:.875rem}#navbar .nav-tabs{gap:0!important}#navbar div.absolute.bottom-0{display:none}#sidebar{left:0;padding-left:0;background:var(--background);border-right:1px solid var(--border)}#sidebar div.sticky{visibility:hidden}#sidebar-content{padding-left:.5rem}@media (min-width:1024px){:root{--sidebar-width:17.5rem}div:has(>#sidebar){max-width:none;margin-left:0;padding-left:0}#navbar .lg\\:px-12{padding-left:.625rem}#navbar div:has(>.nav-tabs){padding-left:1.5rem}#sidebar-content .sidebar-group a,#sidebar-content .sidebar-group button{padding-block:.3125rem;line-height:1.25rem}#sidebar-content .sidebar-group-header{margin-bottom:.5rem}#navigation-items>div:has(>.sidebar-group-header){margin-top:1.25rem}#content-container>div{justify-content:flex-end}#content-area{max-width:54rem;margin-inline:0;padding-left:3.125rem}div:has(>#sidebar[style*=\"display: none\"]){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:.5625rem;right:-2rem;display:flex;align-items:center;justify-content:center;width:1.75rem;height:1.75rem;color:var(--text-secondary);cursor:pointer}#pc-sidebar-toggle:hover{color:var(--text-primary)}#pc-sidebar-toggle:focus-visible{outline:2px solid var(--brand-blue);outline-offset:2px;border-radius:.25rem}#sidebar #navigation-items{position:relative}#sidebar-content>[data-component-part=scroll-area-scrollbar][data-orientation=vertical]{margin-top:4.5rem}#sidebar .nav-dropdown-trigger{width:calc(100% - .75rem)}.pc-sidebar-collapsed #sidebar{width:3rem;overflow:hidden}.pc-sidebar-collapsed #sidebar>*{visibility:hidden}.pc-sidebar-collapsed #pc-sidebar-toggle:not([hidden]){position:fixed;left:1.1875rem;right:auto}}#header h1,#navbar a,#sidebar a,#sidebar li div,#sidebar-content h5,.prose h2,.prose h3,.prose h4{color:var(--text-primary)}#navigation-items .sidebar-group-header{color:var(--text-secondary);font-size:.75rem;font-weight:600;letter-spacing:1px;line-height:160%;text-transform:uppercase}#navigation-items>div+div>.sidebar-group-header{padding-top:1.25rem;border-top:1px solid var(--border)}#navigation-items .sidebar-group-header:has(+.sidebar-group li[data-active=true]){color:var(--text-primary)}#navigation-items .sidebar-group li>button{flex-direction:row-reverse;justify-content:flex-end;column-gap:.375rem;font-weight:500}#navigation-items .sidebar-group li>button>div:last-child{margin-left:-.75rem}#navigation-items .sidebar-group li>button svg,.model-filter-chip svg{color:var(--text-secondary)}#navigation-items .sidebar-group li>ul,#table-of-contents .toc-item>ul{position:relative}#navigation-items .sidebar-group li>ul::before,#table-of-contents .toc-item>ul::before{content:\"\";position:absolute;top:0;bottom:0;left:1rem;border-left:1px solid var(--border)}#table-of-contents .toc-item>ul::before{left:.25rem}#navigation-items>div>ul>li{margin-left:.75rem}#navigation-items>div>ul>li a.font-semibold{font-weight:400;background-color:var(--surface)}#content-container>div{padding-top:10rem}#content-area>#content:first-child{margin-top:0}@media (min-width:1024px){#content-container>div{gap:3rem}#content-container #table-of-contents{padding-left:0}}#header .eyebrow,.sample-app-heading .eyebrow{text-transform:uppercase;color:var(--text-primary);font-size:.625rem;letter-spacing:1px;line-height:160%}#header .eyebrow:empty{display:none}#header>div:first-of-type>div:nth-of-type(2){margin-top:0}.prose [data-as=p],.prose li,.prose p{color:var(--text-body)}.prose table td,.prose table th{color:var(--text-body)!important}.prose a{color:var(--brand-blue)!important;font-weight:400}.card{box-shadow:none;border:1px solid var(--border)!important;border-radius:.25rem;transition:box-shadow .3s ease;background-color:var(--paper)!important}.card:hover,.example-card:hover{box-shadow:0 5px 5px -3px rgba(163,169,175,.2),0 8px 10px 1px rgba(163,169,175,.14),0 3px 14px 2px rgba(163,169,175,.12)!important}.dark .card:hover,.dark .example-card:hover{box-shadow:none!important}.card>div{padding:1.5rem}.card .integration-title,.card h2,.example-card h2{font-size:1.25rem}.card .integration-title{font-weight:600;line-height:1.5rem;margin-bottom:.833rem;color:var(--text-primary)}.card p,.example-card p,.example-card span[data-as=p]{margin-top:.625rem;font-size:.875rem;color:var(--text-primary)}.card .integration-logo,.card .integration-logo-long{width:3.125rem;height:3.125rem;display:flex;justify-content:center;align-items:center}.card .integration-logo-long{width:5.125rem}.card-grid{display:grid;gap:1.5rem}@media (min-width:640px){.card-grid{grid-template-columns:1fr 1fr}}@media (min-width:1024px){.card-grid{grid-template-columns:1fr 1fr 1fr}}#related-articles,.example-card{display:flex;flex-direction:column}.example-card{box-shadow:none;border:1px solid var(--border);border-radius:.25rem;transition:box-shadow .3s ease;padding:1.5rem;flex-grow:1;background-color:var(--paper)}.example-card .arrow{margin-left:auto;margin-top:auto;opacity:0;transition:opacity .3s ease}.example-card:hover .arrow{opacity:1}.example-card:hover{border:1px solid var(--border)!important}.example-card .tags{display:flex;flex-wrap:wrap;gap:.75rem;margin-top:1.5rem}.example-card .card-tag{border-radius:1rem;background-color:var(--background);color:var(--text-primary);font-size:.8125rem;line-height:138%;letter-spacing:.16px;padding:.1875rem .375rem;display:flex;gap:.375rem;align-items:center}.examples-h2{font-size:1.25rem;margin-bottom:1.5rem}#related-articles{width:100%}#related-articles a,#related-articles h2{color:var(--text-primary);line-height:150%;letter-spacing:.15px}#related-articles h2{font-size:1.25rem;font-weight:600;margin-bottom:1rem}#related-articles a{padding:1.0625rem 0;display:flex;align-items:flex-start;justify-content:space-between;gap:1rem;font-size:.875rem}#related-articles a:not(:last-of-type){border-bottom:1px solid var(--border)}#back-button:hover,#related-articles a:hover{opacity:.7}#back-button>svg,#related-articles a>svg{flex-shrink:0}#back-button{display:flex;gap:.5rem;align-items:center;color:var(--text-primary)!important;font-size:.875rem;margin-bottom:1.5rem}.sample-app-heading{display:flex;flex-direction:column;align-items:center;text-align:center}.sample-app-heading h1,.sample-app-heading p{color:var(--text-primary);margin:.5rem 0 0;font-size:2.125rem;font-weight:600;line-height:123.5%;letter-spacing:.25px}#back-button,.sample-app-heading p{line-height:150%;letter-spacing:.15px}.sample-app-heading p{margin:.5rem 0 1.5rem;font-size:1.25rem}.sample-app-split{display:flex;flex-direction:column;gap:3rem}.sample-app-split .sidebar a:not(.connect-with-pinecone){font-size:.875rem;color:var(--text-primary)!important;border-bottom:none}.sample-app-split .toc-list{display:flex;flex-direction:column;gap:1rem}.sample-app-split .toc-list a.bold{font-weight:700;margin-top:.5rem}.sample-app-split .toc-list a:not(.bold,.connect-with-pinecone){position:relative;padding-left:1rem}.sample-app-split .toc-list a:not(.bold,.connect-with-pinecone)::before{content:\"\";position:absolute;top:0;bottom:0;left:.25rem;border-left:1px solid var(--border)}.sample-app-split .toc-list a:not(.bold,.connect-with-pinecone)+a:not(.bold)::before{top:-1rem}.connect-with-pinecone{border:1px solid var(--border);border-radius:.25rem;padding:.5rem 1rem;display:inline-flex;align-items:center;gap:.5rem;font-size:.875rem;font-weight:500;line-height:1.5rem;letter-spacing:.4px;color:var(--text-primary)!important;text-decoration:none;align-self:flex-start}@media (min-width:1280px){.sample-app-split{flex-direction:row}.sample-app-split :is(.content, .mint-content){overflow-x:auto}.sample-app-split .sidebar{width:20.625rem;flex-shrink:0}}p>code{font-size:.75rem;line-height:150%;letter-spacing:.5px;border-radius:.25rem;padding:.125rem .5rem;background-color:var(--paper)!important;border:0}code .api-key.set{color:orange}.pinecone-connect-connected{width:100%;max-width:31.25rem;background-color:var(--paper);transition:box-shadow 300ms cubic-bezier(.4,0,.2,1) 0ms;border-radius:.25rem;padding:1.5rem;margin:1.5rem 0;border:1px solid var(--border)}.pinecone-connect-connected img{height:1.875rem;margin:0}.pinecone-connect-connected p,p>code{color:var(--text-primary)!important}.pinecone-connect-connected p:last-of-type{margin-top:.75rem}.remove-api-key{display:flex;width:100%;max-width:31.25rem;margin-top:-1.25rem}.remove-api-key>button{font-size:.8125rem;font-weight:500;color:var(--brand-blue);margin-left:auto}.connect-widget-skeleton{margin-block:45px;width:100%;max-width:31.25rem;height:180px;background:var(--paper);border-radius:4px;overflow:hidden;position:relative;border:1px solid var(--border)}.skeleton-content{width:100%;max-width:450px;height:180px;background:linear-gradient(90deg,rgba(255,255,255,0) 0,rgba(255,255,255,.6) 50%,rgba(255,255,255,0) 100%);animation:shimmer 1.5s infinite;position:absolute;top:0;left:0}.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:.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:.8125rem}.model-table-controls{position:static;height:auto;margin-bottom:.75rem;flex-wrap:wrap;justify-content:flex-start;gap:.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:.5rem}}.model-filter-chip{display:inline-flex;align-items:center;gap:.25rem;height:2rem;padding:0 .625rem;border:1px solid var(--border);border-radius:4px;background:var(--paper);color:var(--text-primary);font-size:.8125rem;white-space:nowrap;cursor:pointer}.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:.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:.625rem;color:var(--text-secondary);pointer-events:none}.model-search{width:100%;height:2rem;padding:0 .625rem 0 2rem;border:1px solid var(--border);border-radius:4px;background:var(--paper);color:var(--text-primary);font-size:.8125rem}.model-search::placeholder,.pc-cl-search::placeholder{color:var(--text-secondary)}.model-search:focus{outline:0;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:.125rem;border-radius:4px;color:var(--text-secondary);opacity:.7;vertical-align:middle;cursor:pointer}.model-filter-button:hover,.model-filter-button[aria-expanded=true]{background:rgb(115 143 171/.12);opacity:1}.model-filter-button.active{color:var(--brand-blue);opacity:1}.model-clear:focus-visible,.model-filter-button: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:.5rem;color:var(--brand-blue);font-size:.6875rem;font-weight:500}.model-filter-menu,table.model-table-ready{border:1px solid var(--border);background:var(--paper)}.model-filter-menu{position:fixed;z-index:50;min-width:12.5rem;padding:.375rem 0;border-radius:4px;box-shadow:0 8px 10px -5px rgb(18 17 66/.12),0 16px 24px 2px rgb(18 17 66/.09),0 6px 30px 5px rgb(18 17 66/.07)}.model-filter-menu label{padding:.5rem .875rem;color:var(--text-primary);font-size:.875rem;cursor:pointer}.model-filter-menu label:hover{background:rgb(60 114 255/.06)}.model-filter-menu input{width:1rem;height:1rem;margin:0;accent-color:var(--brand-blue)}.model-filter-menu svg,.model-page-specs dt{color:var(--text-secondary)}table.model-table-ready{border-radius:6px;border-collapse:separate;border-spacing:0;overflow:clip;font-size:.875rem}.model-table-ready td,.model-table-ready th{min-width:0!important}.model-table-ready .model-col-folded{display:none}.model-table-ready thead th{height:3rem;padding:0 .75rem!important;background:var(--paper);color:var(--text-secondary);font-size:.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:.75em;height:.75em;margin-left:.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:-.05em}.model-table-ready thead th a:hover{color:var(--brand-blue)!important}.model-table-ready tbody td{padding:.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:0 0;color:inherit;font-size:.75rem;white-space:nowrap}.model-table-ready tbody tr:hover td{background:rgb(60 114 255/.04)}.model-cell,.model-filter-menu label{display:flex;align-items:center;gap:.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:.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:.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:0 0}.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:.5rem}.model-company-name,.model-plan-badge{color:var(--text-secondary);font-size:.75rem;line-height:1.125rem}.model-plan-badge{padding:0 .375rem;border:1px solid var(--border);border-radius:4px;font-size:.625rem;line-height:1rem;white-space:nowrap}.model-deprecated-badge{border-color:rgb(217 119 6/.5);color:rgb(180 83 9)}.dark .model-deprecated-badge{color:rgb(251 191 36)}.model-input-icons{display:inline-flex;gap:.375rem;color:var(--text-primary);vertical-align:middle}.model-cell-muted{color:var(--text-secondary);opacity:.7}.model-input-text{display:none}@media (min-width:768px) and (max-width:1279px){.model-table-ready tbody td:first-child,.model-table-ready thead th: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/.04),rgb(60 114 255/.04)),var(--paper)}}@media (max-width:767px){table.model-table-ready{display:block;width:100%!important;border:0;background:0 0}.model-table-ready thead{display:none}.model-table-ready tbody{display:flex;flex-direction:column;gap:.75rem}.model-table-ready tbody tr{display:block;padding:.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:.75rem;padding:.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:.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:.375rem;padding-bottom:.75rem!important;border-bottom:1px solid var(--border)}.model-table-ready tbody td:last-child{padding-top:.5rem!important}.model-input-icons,.model-table-ready tbody td.model-cell-empty,.model-table-ready tbody td.model-cell-muted{display:none}.model-table-ready tbody tr:hover td{background:0 0}.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-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:.25rem 1rem;max-width:55rem;margin-top:1rem;color:var(--text-secondary);font-size:.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:.75rem}.model-table-notes a code{padding:0;border:0;background:0 0;color:inherit}@media (max-width:767px){.model-table-notes{grid-template-columns:minmax(0,1fr)}.model-table-notes>span:nth-child(even){margin-bottom:.5rem}}#content-area,#content-container,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 .3s ease,border .3s ease,color .3s ease}.outlined-button:hover{background-color:var(--paper);border:1px solid var(--brand-blue);color:var(--text-primary)}.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:.25rem;justify-self:start;margin-bottom:1.5rem;border-bottom:none!important;color:var(--brand-blue)!important;font-size:.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:-.02em;overflow-wrap:anywhere}.model-page-meta{display:flex;flex-wrap:wrap;align-items:center;gap:.5rem;margin-top:.5rem;color:var(--text-secondary);font-size:.8125rem}.model-page-meta>span:not(.model-plan-badge)+span:not(.model-plan-badge)::before{content:\"·\";margin-right:.5rem;opacity:.6}.model-page-actions{display:flex;flex-wrap:wrap;gap:.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:.875rem;font-weight:500;white-space:nowrap;text-decoration:none;cursor:pointer}.model-page-button.primary,.model-page-button:hover,.model-page-compare a:hover{border-color:var(--brand-blue)}.model-page-button.primary{background:var(--brand-blue);color:#fff!important}.dark .model-page-button.primary{color:#1c1917!important}.model-page-button.primary:hover{opacity:.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-compare a,.model-page-specs-card{border:1px solid var(--border);border-radius:4px}.model-page-specs-card{padding:1.25rem;background:var(--paper)}.model-page-eyebrow{display:block;margin-bottom:.75rem;color:var(--text-secondary);font-size:.625rem;letter-spacing:.1em;text-transform:uppercase}.model-page-specs dl{display:grid;grid-template-columns:7rem minmax(0,1fr);gap:.625rem .75rem;margin:0;font-size:.8125rem;line-height:1.25rem}.model-page-specs dd{margin:0;color:var(--text-primary)}.model-page-compare{display:flex;flex-direction:column;gap:.5rem}.model-page-compare .model-page-eyebrow{margin-bottom:0}.model-page-compare a{display:flex;align-items:center;gap:.75rem;padding:.75rem;color:var(--text-primary)!important;text-decoration:none}.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:.8125rem;font-weight:500;overflow-wrap:anywhere}.model-page-compare-note{color:var(--text-secondary);font-size:.75rem}.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:.95!important;transform-origin:top left}.connect-widget-skeleton{height:180px;margin-block:30px}.skeleton-content{height:180px}#pinecone-connect-widget,#pinecone-connect-widget iframe,#pinecone-connect-widget>div{width:100%!important;min-width:0!important;max-width:100%!important}div[style*=min-width]{min-width:0!important;width:100%!important}}#page-context-menu-button{border-start-start-radius:.25rem!important;border-end-start-radius:.25rem!important}#page-context-menu button:last-child{border-radius:0!important;border-start-end-radius:.25rem!important;border-end-end-radius:.25rem!important}.agent-tool{border-left:4px solid var(--brand-blue, #002BFF);padding:1rem 1.25rem;border-radius:.375rem;background-color:#f0f4ff;margin:.5rem 0 1rem}.agent-tool>p:first-child{margin-top:0;font-size:.875rem;letter-spacing:.025em}.dark .agent-tool{background-color:rgba(0,43,255,.08);border-left-color:#4d6fff}#changelog-filters{display:none!important}#pc-cl-filters{margin-top:1.5rem;padding-top:1.25rem;border-top:1px solid var(--divider);display:flex;flex-direction:column;gap:.5rem}.pc-cl-heading{margin:0 0 .25rem;font-size:.8125rem;font-weight:600;color:var(--text-primary)}.pc-cl-search{width:100%;padding:.375rem .625rem;font-size:.8125rem;line-height:1.5;color:inherit;background-color:transparent;border:1px solid var(--divider);border-radius:.5rem;appearance:none}.pc-cl-search:focus{outline:0;border-color:var(--brand-blue)}.pc-cl-dd-toggle{width:100%;display:flex;align-items:center;justify-content:space-between;gap:.5rem;padding:.375rem .625rem;font-size:.8125rem;line-height:1.5;text-align:left;color:inherit;cursor:pointer;background-color:transparent;border:1px solid var(--divider);border-radius:.5rem}.pc-cl-dd-menu button:hover,.pc-cl-dd-toggle:hover{background-color:var(--surface)}.pc-cl-dd.is-active .pc-cl-dd-toggle{border-color:var(--brand-blue);font-weight:500}.pc-cl-dd-caret{flex:none;width:.75rem;height:.75rem;opacity:.6}.pc-cl-dd-toggle[aria-expanded=true] .pc-cl-dd-caret{transform:rotate(180deg)}.pc-cl-dd-menu{position:fixed;z-index:50;margin:0;padding:.25rem;overflow-y:auto;list-style:none;background-color:var(--paper);border:1px solid var(--divider);border-radius:.5rem;box-shadow:0 8px 24px rgba(0,0,0,.08)}.dark .pc-cl-dd-menu{box-shadow:0 8px 24px rgba(0,0,0,.4)}.pc-cl-dd-menu li{margin:0;padding:0;list-style:none}.pc-cl-dd-menu li::before,.pc-cl-dd-menu li::marker{content:none;display:none}.pc-cl-clear,.pc-cl-dd-menu button{font-size:.8125rem;cursor:pointer;border:0}.pc-cl-dd-menu button{width:100%;padding:.3125rem .5rem;line-height:1.4;text-align:left;color:inherit;background-color:transparent;border-radius:.375rem}.pc-cl-clear{align-self:flex-start;padding:0;color:var(--brand-blue);background:0 0}.pc-cl-clear:hover{text-decoration:underline}.pc-cl-count{margin:0;font-size:.75rem}.pc-cl-count,.pc-cl-empty{color:var(--text-secondary)}[class*=flex-wrap][class*=gap-2][class*=text-secondary]>span[class*=rounded-lg][class*=font-medium]{padding:.1875rem .625rem;border-radius:9999px;border:1px solid var(--divider);background:0 0}.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}.cluster.pc-mermaid-group rect,.pc-mermaid-item rect{fill:transparent!important;stroke:var(--brand-blue)!important}.cluster.pc-mermaid-frame rect{fill:transparent!important;stroke:var(--secondary)!important}"}],"page":{"pagePath":"reference/api/2026-07/control-plane/convert_index","slug":"/reference/api/2026-07/control-plane/convert_index","pageMetadata":{"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","description":"Convert a serverless vector index or legacy integrated index into a new document index. The source index isn't changed, and the new index holds a snapshot of the source taken when the job starts.\n\nThe request returns once the new index is created in the `Initializing` state. Track the job with [Describe a conversion job](https://docs.pinecone.io/reference/api/2026-07/control-plane/describe_conversion_job). If the job fails or is canceled, the index is left in the `InitializationFailed` state with no usable data. Delete it to free its name. A job that fails because of your data is charged for the data it read, and a canceled job isn't charged.\n\nFor how source records map to the schema, see [Convert an index](https://docs.pinecone.io/guides/index-data/convert-an-index).","href":"/reference/api/2026-07/control-plane/convert_index"},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n a: \"a\",\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Convert a serverless vector index or legacy integrated index into a new document index. The source index isn’t changed, and the new index holds a snapshot of the source taken when the job starts.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"The request returns once the new index is created in the \", _jsx(_components.code, {\n children: \"Initializing\"\n }), \" state. Track the job with \", _jsx(_components.a, {\n href: \"https://docs.pinecone.io/reference/api/2026-07/control-plane/describe_conversion_job\",\n children: \"Describe a conversion job\"\n }), \". If the job fails or is canceled, the index is left in the \", _jsx(_components.code, {\n children: \"InitializationFailed\"\n }), \" state with no usable data. Delete it to free its name. A job that fails because of your data is charged for the data it read, and a canceled job isn’t charged.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"For how source records map to the schema, see \", _jsx(_components.a, {\n href: \"https://docs.pinecone.io/guides/index-data/convert-an-index\",\n children: \"Convert an index\"\n }), \".\"]\n })]\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":{"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","description":"Convert a serverless vector index or legacy integrated index into a new document index. The source index isn't changed, and the new index holds a snapshot of the source taken when the job starts.\n\nThe request returns once the new index is created in the `Initializing` state. Track the job with [Describe a conversion job](https://docs.pinecone.io/reference/api/2026-07/control-plane/describe_conversion_job). If the job fails or is canceled, the index is left in the `InitializationFailed` state with no usable data. Delete it to free its name. A job that fails because of your data is charged for the data it read, and a canceled job isn't charged.\n\nFor how source records map to the schema, see [Convert an index](https://docs.pinecone.io/guides/index-data/convert-an-index).","href":"/reference/api/2026-07/control-plane/convert_index"}}},"mdxSourceWithNoJs":{"compiledSource":"\"use strict\";const{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,pre:`pre`,span:`span`,..._provideComponents(),...props.components},{CodeBlock,RequestExample}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!RequestExample)_missingMdxReference(`RequestExample`,true);return _jsxs(RequestExample,{children:[_jsx(CodeBlock,{filename:`Vector index`,numberOfLines:`27`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`27`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`PINECONE_API_KEY`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"YOUR_API_KEY\"`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://api.pinecone.io/indexes/support-tickets/convert`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Api-Key: `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$PINECONE_API_KEY`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"X-Pinecone-Api-Version: 2026-07\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'Content-Type: application/json'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -d`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"name\": \"support-tickets-docs\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"schema\": {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"fields\": {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"embedding\": {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"type\": \"dense_vector\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"dimension\": 1024,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"metric\": \"cosine\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"ticket_text\": {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"type\": \"string\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"full_text_search\": {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"language\": \"en\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"error_mode\": {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"on_error\": \"continue\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }'`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`Legacy integrated index`,numberOfLines:`19`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`19`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`PINECONE_API_KEY`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"YOUR_API_KEY\"`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://api.pinecone.io/indexes/support-articles/convert`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Api-Key: `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$PINECONE_API_KEY`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"X-Pinecone-Api-Version: 2026-07\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'Content-Type: application/json'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -d`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"name\": \"support-articles-docs\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"schema\": {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"fields\": {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"chunk_text\": {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"type\": \"string\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"embed\": {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"model\": \"multilingual-e5-large\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }'`})}),`\n`]})})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"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","description":"Convert a serverless vector index or legacy integrated index into a new document index. The source index isn't changed, and the new index holds a snapshot of the source taken when the job starts.\n\nThe request returns once the new index is created in the `Initializing` state. Track the job with [Describe a conversion job](https://docs.pinecone.io/reference/api/2026-07/control-plane/describe_conversion_job). If the job fails or is canceled, the index is left in the `InitializationFailed` state with no usable data. Delete it to free its name. A job that fails because of your data is charged for the data it read, and a canceled job isn't charged.\n\nFor how source records map to the schema, see [Convert an index](https://docs.pinecone.io/guides/index-data/convert-an-index).","href":"/reference/api/2026-07/control-plane/convert_index"}}}},"mdxExtracts":{"tableOfContents":[],"codeExamples":{"request":{"type":"RequestExample","children":[{"filename":"Vector index","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"shellscript\">\u003ccode language=\"shellscript\" numberOfLines=\"27\">\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#9CDCFE\">PINECONE_API_KEY\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D4D4D4\">=\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"YOUR_API_KEY\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#953800;--shiki-dark:#DCDCAA\">curl\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> https://api.pinecone.io/indexes/support-tickets/convert\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> -H\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"Api-Key: \u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#9CDCFE\">$PINECONE_API_KEY\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> -H\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"X-Pinecone-Api-Version: 2026-07\"\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> -H\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> 'Content-Type: application/json'\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> -d\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> '{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"name\": \"support-tickets-docs\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"schema\": {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"fields\": {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"embedding\": {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"type\": \"dense_vector\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"dimension\": 1024,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"metric\": \"cosine\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"ticket_text\": {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"type\": \"string\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"full_text_search\": {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"language\": \"en\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"error_mode\": {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"on_error\": \"continue\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> }'\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"},{"filename":"Legacy integrated index","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"shellscript\">\u003ccode language=\"shellscript\" numberOfLines=\"19\">\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#9CDCFE\">PINECONE_API_KEY\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D4D4D4\">=\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"YOUR_API_KEY\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#953800;--shiki-dark:#DCDCAA\">curl\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> https://api.pinecone.io/indexes/support-articles/convert\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> -H\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"Api-Key: \u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#9CDCFE\">$PINECONE_API_KEY\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> -H\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"X-Pinecone-Api-Version: 2026-07\"\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> -H\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> 'Content-Type: application/json'\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> -d\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> '{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"name\": \"support-articles-docs\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"schema\": {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"fields\": {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"chunk_text\": {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"type\": \"string\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"embed\": {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"model\": \"multilingual-e5-large\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> }'\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"}],"attributes":[]}}},"jsLinks":["/_mintlify/custom/pinecone/345ae6b85c58f0d4/console-iframe.js","/_mintlify/custom/pinecone/8893dd911df6f02e/script.js","/_mintlify/custom/pinecone/4d30bdf131035051/inkeep.js"],"openApiReferenceData":{"operation":{"tags":["Manage Indexes"],"summary":"Convert an index into a document index","description":"Convert a serverless vector index or legacy integrated index into a new document index. The source index isn't changed, and the new index holds a snapshot of the source taken when the job starts.\n\nThe request returns once the new index is created in the `Initializing` state. Track the job with [Describe a conversion job](https://docs.pinecone.io/reference/api/2026-07/control-plane/describe_conversion_job). If the job fails or is canceled, the index is left in the `InitializationFailed` state with no usable data. Delete it to free its name. A job that fails because of your data is charged for the data it read, and a canceled job isn't charged.\n\nFor how source records map to the schema, see [Convert an index](https://docs.pinecone.io/guides/index-data/convert-an-index).","operationId":"convert_index","parameters":["2f395259-c783-4ab6-9370-024af6792460","399bf1aa-0dfc-419f-b704-96a827af119b"],"requestBody":"87a4b151-e45b-41e5-a8f8-376e8c882ee0","responses":{"202":"6781d05c-e04e-43de-a982-3472625d5171","400":"e14b7452-c945-40c3-8ce1-302db112213d","401":"0ed1bfaf-bc12-4778-803c-d8ef33fb9302","402":"cb40199a-e463-43c4-bd48-ea15964fa714","403":"817b9eaf-465f-454e-b3ff-2e88b4d4f14e","404":"5ed00197-440a-47e9-aaba-947a3e745e7f","409":"008fa43b-f90f-4ac7-a1c4-ce267fb722a1","412":"4980b923-61a3-4fe2-a2db-536a44e1b364","422":"6c45330e-b529-40c1-8f29-1499dbdf7489","500":"6ed36cf7-bac4-4014-b6a9-ec8d84b78a81"},"method":"post","type":"path","servers":["3ca75f45-7588-45d8-9fc3-6d78793c61b4"],"security":["da7157b6-f255-45e5-9544-cc40eba5a9d4"],"path":"/indexes/{index_name}/convert","baseUrlOptions":["https://api.pinecone.io"],"title":"Convert an index into a document index","codeSamples":[],"requiredOnlyExamples":false,"requestExamples":[{"dropdown":false,"language":"shellscript","code":{"type":"pre","key":null,"ref":null,"props":{"className":"shiki shiki-themes github-light-default dark-plus","style":{"backgroundColor":"#ffffff","--shiki-dark-bg":"#0B0C0E","color":"#1f2328","--shiki-dark":"#D4D4D4"},"language":"shellscript","children":{"type":"code","key":null,"ref":null,"props":{"language":"shellscript","numberOfLines":"27","children":[{"type":"span","key":"0","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#9CDCFE"},"children":"PINECONE_API_KEY"}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#CF222E","--shiki-dark":"#D4D4D4"},"children":"="}},{"type":"span","key":"2","ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":"\"YOUR_API_KEY\""}}]}},"\n",{"type":"span","key":"2","ref":null,"props":{"className":"line","children":null}},"\n",{"type":"span","key":"4","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#953800","--shiki-dark":"#DCDCAA"},"children":"curl"}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" https://api.pinecone.io/indexes/support-tickets/convert"}},{"type":"span","key":"2","ref":null,"props":{"style":{"color":"#CF222E","--shiki-dark":"#D7BA7D"},"children":" \\"}}]}},"\n",{"type":"span","key":"6","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#0550AE","--shiki-dark":"#569CD6"},"children":" -H"}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" \"Api-Key: "}},{"type":"span","key":"2","ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#9CDCFE"},"children":"$PINECONE_API_KEY"}},{"type":"span","key":"3","ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":"\""}},{"type":"span","key":"4","ref":null,"props":{"style":{"color":"#CF222E","--shiki-dark":"#D7BA7D"},"children":" \\"}}]}},"\n",{"type":"span","key":"8","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#0550AE","--shiki-dark":"#569CD6"},"children":" -H"}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" \"X-Pinecone-Api-Version: 2026-07\""}},{"type":"span","key":"2","ref":null,"props":{"style":{"color":"#CF222E","--shiki-dark":"#D7BA7D"},"children":" \\"}}]}},"\n",{"type":"span","key":"10","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#0550AE","--shiki-dark":"#569CD6"},"children":" -H"}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" 'Content-Type: application/json'"}},{"type":"span","key":"2","ref":null,"props":{"style":{"color":"#CF222E","--shiki-dark":"#D7BA7D"},"children":" \\"}}]}},"\n",{"type":"span","key":"12","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#0550AE","--shiki-dark":"#569CD6"},"children":" -d"}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" '{"}}]}},"\n",{"type":"span","key":"14","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" \"name\": \"support-tickets-docs\","}}}},"\n",{"type":"span","key":"16","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" \"schema\": {"}}}},"\n",{"type":"span","key":"18","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" \"fields\": {"}}}},"\n",{"type":"span","key":"20","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" \"embedding\": {"}}}},"\n",{"type":"span","key":"22","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" \"type\": \"dense_vector\","}}}},"\n",{"type":"span","key":"24","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" \"dimension\": 1024,"}}}},"\n",{"type":"span","key":"26","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" \"metric\": \"cosine\""}}}},"\n",{"type":"span","key":"28","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" },"}}}},"\n",{"type":"span","key":"30","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" \"ticket_text\": {"}}}},"\n",{"type":"span","key":"32","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" \"type\": \"string\","}}}},"\n",{"type":"span","key":"34","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" \"full_text_search\": {"}}}},"\n",{"type":"span","key":"36","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" \"language\": \"en\""}}}},"\n",{"type":"span","key":"38","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" }"}}}},"\n",{"type":"span","key":"40","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" }"}}}},"\n",{"type":"span","key":"42","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" }"}}}},"\n",{"type":"span","key":"44","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" },"}}}},"\n",{"type":"span","key":"46","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" \"error_mode\": {"}}}},"\n",{"type":"span","key":"48","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" \"on_error\": \"continue\""}}}},"\n",{"type":"span","key":"50","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" }"}}}},"\n",{"type":"span","key":"52","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" }'"}}}},"\n"]}}}},"filename":"Vector index"},{"dropdown":false,"language":"shellscript","code":{"type":"pre","key":null,"ref":null,"props":{"className":"shiki shiki-themes github-light-default dark-plus","style":{"backgroundColor":"#ffffff","--shiki-dark-bg":"#0B0C0E","color":"#1f2328","--shiki-dark":"#D4D4D4"},"language":"shellscript","children":{"type":"code","key":null,"ref":null,"props":{"language":"shellscript","numberOfLines":"19","children":[{"type":"span","key":"0","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#9CDCFE"},"children":"PINECONE_API_KEY"}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#CF222E","--shiki-dark":"#D4D4D4"},"children":"="}},{"type":"span","key":"2","ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":"\"YOUR_API_KEY\""}}]}},"\n",{"type":"span","key":"2","ref":null,"props":{"className":"line","children":null}},"\n",{"type":"span","key":"4","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#953800","--shiki-dark":"#DCDCAA"},"children":"curl"}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" https://api.pinecone.io/indexes/support-articles/convert"}},{"type":"span","key":"2","ref":null,"props":{"style":{"color":"#CF222E","--shiki-dark":"#D7BA7D"},"children":" \\"}}]}},"\n",{"type":"span","key":"6","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#0550AE","--shiki-dark":"#569CD6"},"children":" -H"}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" \"Api-Key: "}},{"type":"span","key":"2","ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#9CDCFE"},"children":"$PINECONE_API_KEY"}},{"type":"span","key":"3","ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":"\""}},{"type":"span","key":"4","ref":null,"props":{"style":{"color":"#CF222E","--shiki-dark":"#D7BA7D"},"children":" \\"}}]}},"\n",{"type":"span","key":"8","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#0550AE","--shiki-dark":"#569CD6"},"children":" -H"}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" \"X-Pinecone-Api-Version: 2026-07\""}},{"type":"span","key":"2","ref":null,"props":{"style":{"color":"#CF222E","--shiki-dark":"#D7BA7D"},"children":" \\"}}]}},"\n",{"type":"span","key":"10","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#0550AE","--shiki-dark":"#569CD6"},"children":" -H"}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" 'Content-Type: application/json'"}},{"type":"span","key":"2","ref":null,"props":{"style":{"color":"#CF222E","--shiki-dark":"#D7BA7D"},"children":" \\"}}]}},"\n",{"type":"span","key":"12","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#0550AE","--shiki-dark":"#569CD6"},"children":" -d"}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" '{"}}]}},"\n",{"type":"span","key":"14","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" \"name\": \"support-articles-docs\","}}}},"\n",{"type":"span","key":"16","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" \"schema\": {"}}}},"\n",{"type":"span","key":"18","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" \"fields\": {"}}}},"\n",{"type":"span","key":"20","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" \"chunk_text\": {"}}}},"\n",{"type":"span","key":"22","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" \"type\": \"string\","}}}},"\n",{"type":"span","key":"24","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" \"embed\": {"}}}},"\n",{"type":"span","key":"26","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" \"model\": \"multilingual-e5-large\""}}}},"\n",{"type":"span","key":"28","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" }"}}}},"\n",{"type":"span","key":"30","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" }"}}}},"\n",{"type":"span","key":"32","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" }"}}}},"\n",{"type":"span","key":"34","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" }"}}}},"\n",{"type":"span","key":"36","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" }'"}}}},"\n"]}}}},"filename":"Legacy integrated index"}],"requestExampleType":"mdx","responseExampleType":"generated"},"dependencies":{"parameters":{"2f395259-c783-4ab6-9370-024af6792460":{"in":"header","name":"X-Pinecone-Api-Version","description":"Required date-based version header","required":true,"schema":{"default":"2026-07","type":"string","isRequired":true,"description":"Required date-based version header","uniqueKey":"","typeLabel":"string"},"style":"simple"},"399bf1aa-0dfc-419f-b704-96a827af119b":{"in":"path","name":"index_name","description":"The name of the vector index to convert.","required":true,"schema":{"type":"string","isRequired":true,"description":"The name of the vector index to convert.","uniqueKey":"","typeLabel":"string"},"example":"example-index","style":"simple"}},"requestBody":{"content":{"application/json":{"schema":{"description":"The configuration of the document index a vector index is converted into.","type":"object","properties":{"name":{"example":"example-index","description":"The name of the index. Resource name must be 1-45 characters long, start and end with an alphanumeric character, and consist only of lower case alphanumeric characters or '-'.","type":"string","minLength":1,"maxLength":45,"isRequired":true,"uniqueKey":"name","typeLabel":"string"},"schema":{"example":{"fields":{"body":{"full_text_search":{"language":"en"},"type":"string"},"your_vector":{"dimension":1536,"metric":"cosine","type":"dense_vector"}}},"description":"The fields the index searches over: dense vectors, sparse vectors, and string fields searched by full-text search or by embeddings Pinecone derives from their text.\n\nAn index has one dense vector slot and one sparse vector slot: at most one field can be a `dense_vector` field or declare `embed`, and at most one can be a `sparse_vector` field or declare `sparse_embed`. Metadata isn't declared in the schema; it's indexed automatically from the documents you upsert.","type":"object","properties":{"fields":{"description":"A map of field names to field configurations. Names are at most 64 bytes and can't start with `$`. Names starting with `_` are reserved; to create a vector index with the reserved `_values` and `_sparse_values` fields, see [Adopt the Documents API](https://docs.pinecone.io/guides/index-data/adopt-the-documents-api#what-this-means-for-your-existing-code).","type":"object","additionalProperties":{"oneOf":[{"type":"object","title":"Dense vector","description":"The configuration of a single field. `type` determines how the field is stored and searched.","required":["type","dimension","metric"],"example":{"dimension":1536,"metric":"cosine","type":"dense_vector"},"properties":{"type":{"description":"Identifies this as a dense vector field. Must be `dense_vector`.","type":"string","enum":["dense_vector"],"isRequired":true,"uniqueKey":"schema.fields.additionalProperties.oneOf.0.type","typeLabel":"enum\u003cstring>"},"dimension":{"example":1536,"description":"The number of dimensions in the dense vectors stored in this field.","type":"integer","format":"int32","minimum":1,"maximum":20000,"isRequired":true,"uniqueKey":"schema.fields.additionalProperties.oneOf.0.dimension","typeLabel":"integer\u003cint32>"},"metric":{"example":"cosine","description":"The distance metric used for similarity search.\n\nPossible values: `cosine`, `dotproduct`, or `euclidean`.","x-enum":["cosine","dotproduct","euclidean"],"type":"string","isRequired":true,"uniqueKey":"schema.fields.additionalProperties.oneOf.0.metric","typeLabel":"string"},"description":{"oneOf":[{"description":"Optional description for this field, at most 256 bytes. `null` in responses when none was set.","type":"string","maxLength":256,"uniqueKey":"schema.fields.additionalProperties.oneOf.0.description.oneOf.0","typeLabel":"string"},{"description":"Optional description for this field, at most 256 bytes. `null` in responses when none was set.","type":"null","maxLength":256,"uniqueKey":"schema.fields.additionalProperties.oneOf.0.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"schema.fields.additionalProperties.oneOf.0.description","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"schema.fields.additionalProperties.oneOf.0","typeLabel":"Dense vector · object"},{"type":"object","title":"Sparse vector","description":"The configuration of a single field. `type` determines how the field is stored and searched.","required":["type"],"example":{"type":"sparse_vector"},"properties":{"type":{"description":"Identifies this as a sparse vector field. Must be `sparse_vector`.","type":"string","enum":["sparse_vector"],"isRequired":true,"uniqueKey":"schema.fields.additionalProperties.oneOf.1.type","typeLabel":"enum\u003cstring>"},"description":{"oneOf":[{"description":"Optional description for this field, at most 256 bytes. `null` in responses when none was set.","type":"string","maxLength":256,"uniqueKey":"schema.fields.additionalProperties.oneOf.1.description.oneOf.0","typeLabel":"string"},{"description":"Optional description for this field, at most 256 bytes. `null` in responses when none was set.","type":"null","maxLength":256,"uniqueKey":"schema.fields.additionalProperties.oneOf.1.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"schema.fields.additionalProperties.oneOf.1.description","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"schema.fields.additionalProperties.oneOf.1","typeLabel":"Sparse vector · object"},{"type":"object","title":"String","description":"The configuration of a single field. `type` determines how the field is stored and searched.","required":["type"],"example":{"full_text_search":{"language":"en"},"type":"string"},"properties":{"type":{"description":"Identifies this as a string field. Must be `string`.","type":"string","enum":["string"],"isRequired":true,"uniqueKey":"schema.fields.additionalProperties.oneOf.2.type","typeLabel":"enum\u003cstring>"},"description":{"description":"Optional description for this field, at most 256 bytes.","type":"string","maxLength":256,"uniqueKey":"schema.fields.additionalProperties.oneOf.2.description","typeLabel":"string"},"full_text_search":{"description":"Full-text search configuration. When present, the field is indexed for full-text search.\n\n`stop_words` requires `stemming: true`. `ngram` cannot be combined with `stemming` or `stop_words`.","type":"object","properties":{"language":{"example":"en","description":"The language for text analysis.","default":"en","type":"string","uniqueKey":"schema.fields.additionalProperties.oneOf.2.full_text_search.language","typeLabel":"string"},"stemming":{"description":"Whether to apply stemming during text analysis.","default":false,"type":"boolean","uniqueKey":"schema.fields.additionalProperties.oneOf.2.full_text_search.stemming","typeLabel":"boolean"},"stop_words":{"description":"Whether to filter stop words during text analysis. Requires `stemming: true`.","default":false,"type":"boolean","uniqueKey":"schema.fields.additionalProperties.oneOf.2.full_text_search.stop_words","typeLabel":"boolean"},"ngram":{"description":"Character n-gram tokenization for substring matching. When present, the field is tokenized into character n-grams instead of words. Cannot be combined with `stemming` or `stop_words`.","type":"object","properties":{"min_gram":{"example":2,"description":"Minimum n-gram length. Must be no greater than `max_gram`.","type":"integer","minimum":1,"maximum":10,"isRequired":true,"uniqueKey":"schema.fields.additionalProperties.oneOf.2.full_text_search.ngram.min_gram","typeLabel":"integer"},"max_gram":{"example":3,"description":"Maximum n-gram length.","type":"integer","minimum":1,"maximum":10,"isRequired":true,"uniqueKey":"schema.fields.additionalProperties.oneOf.2.full_text_search.ngram.max_gram","typeLabel":"integer"},"prefix_only":{"description":"When `true`, only prefix n-grams anchored at the start of the token are generated (e.g. for autocomplete).","default":false,"type":"boolean","uniqueKey":"schema.fields.additionalProperties.oneOf.2.full_text_search.ngram.prefix_only","typeLabel":"boolean"}},"required":["min_gram","max_gram"],"additionalProperties":false,"uniqueKey":"schema.fields.additionalProperties.oneOf.2.full_text_search.ngram","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"schema.fields.additionalProperties.oneOf.2.full_text_search","typeLabel":"object"},"store_text":{"example":true,"description":"Whether to store the field's text. A stored field is always indexed for full-text search, with default settings if `full_text_search` is omitted.\n\nSet to `false` to embed the text without storing it. The field must then declare `embed` or `sparse_embed`, can't declare `full_text_search`, can't be named in `include_fields`, and can't be searched by text. Fixed at creation.","default":true,"type":"boolean","uniqueKey":"schema.fields.additionalProperties.oneOf.2.store_text","typeLabel":"boolean"},"embed":{"example":{"dimension":512,"model":"llama-text-embed-v2"},"description":"Dense embedding configuration for a `string` field. Pinecone embeds the field's text when documents are upserted or updated, and the query text when a search scores the field with an `embed` scoring method.\n\nEvery key is optional; `{}` selects the default model at its default dimension and metric. Fixed at creation.","type":"object","properties":{"model":{"example":"llama-text-embed-v2","description":"The name of a hosted dense embedding model. Defaults to `llama-text-embed-v2`.\n\nRefer to the [model guide](https://docs.pinecone.io/guides/index-data/create-an-index#embedding-models) for available models.","type":"string","uniqueKey":"schema.fields.additionalProperties.oneOf.2.embed.model","typeLabel":"string"},"dimension":{"example":1024,"description":"The dimension of the embedding vectors. Defaults to the model's default dimension.\n\nRefer to the [model guide](https://docs.pinecone.io/guides/index-data/create-an-index#embedding-models) for each model's supported dimensions.","type":"integer","format":"int32","minimum":1,"uniqueKey":"schema.fields.additionalProperties.oneOf.2.embed.dimension","typeLabel":"integer\u003cint32>"},"processing_location":{"example":"us","description":"Where the model processes your data. Defaults to the model's default processing location.\n\nSupported processing locations depend on the model and your plan. See [Processing locations](https://docs.pinecone.io/guides/index-data/processing-locations).","type":"string","uniqueKey":"schema.fields.additionalProperties.oneOf.2.embed.processing_location","typeLabel":"string"},"metric":{"example":"cosine","description":"The distance metric used for similarity search. Defaults to the model's default metric.\n\nPossible values: `cosine`, `dotproduct`, or `euclidean`.","x-enum":["cosine","dotproduct","euclidean"],"type":"string","uniqueKey":"schema.fields.additionalProperties.oneOf.2.embed.metric","typeLabel":"string"},"write_parameters":{"example":{"truncate":"END"},"description":"Model-specific parameters applied when embedding document text, such as `truncate`. Omitted parameters take the model's defaults.","type":"object","uniqueKey":"schema.fields.additionalProperties.oneOf.2.embed.write_parameters","typeLabel":"object"},"read_parameters":{"example":{"truncate":"END"},"description":"Model-specific parameters applied when embedding search query text, such as `truncate`. Omitted parameters take the model's defaults.","type":"object","uniqueKey":"schema.fields.additionalProperties.oneOf.2.embed.read_parameters","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"schema.fields.additionalProperties.oneOf.2.embed","typeLabel":"object"},"sparse_embed":{"example":{"model":"pinecone-sparse-english-v0"},"description":"Learned-sparse embedding configuration for a `string` field. Pinecone embeds the field's text when documents are upserted or updated, and the query text when a search scores the field with a `sparse_embed` scoring method.\n\nEvery key is optional; `{}` selects the default model. Fixed at creation.","type":"object","properties":{"model":{"example":"pinecone-sparse-english-v0","description":"The name of a hosted sparse embedding model. Defaults to `pinecone-sparse-english-v0`.\n\nRefer to the [model guide](https://docs.pinecone.io/guides/index-data/create-an-index#embedding-models) for available models.","type":"string","uniqueKey":"schema.fields.additionalProperties.oneOf.2.sparse_embed.model","typeLabel":"string"},"write_parameters":{"example":{"truncate":"END"},"description":"Model-specific parameters applied when embedding document text, such as `truncate`. Omitted parameters take the model's defaults.","type":"object","uniqueKey":"schema.fields.additionalProperties.oneOf.2.sparse_embed.write_parameters","typeLabel":"object"},"read_parameters":{"example":{"truncate":"END"},"description":"Model-specific parameters applied when embedding search query text, such as `truncate`. Omitted parameters take the model's defaults.","type":"object","uniqueKey":"schema.fields.additionalProperties.oneOf.2.sparse_embed.read_parameters","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"schema.fields.additionalProperties.oneOf.2.sparse_embed","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"schema.fields.additionalProperties.oneOf.2","typeLabel":"String · object"}],"uniqueKey":"schema.fields.additionalProperties","typeLabel":"Dense vector · object | Sparse vector · object | String · object"},"minProperties":1,"isRequired":true,"uniqueKey":"schema.fields","typeLabel":"object"}},"required":["fields"],"additionalProperties":false,"isRequired":true,"uniqueKey":"schema","typeLabel":"object"},"error_mode":{"description":"How a conversion handles a source record the new index cannot take, such as a record whose metadata value for a `full_text_search` field is not a string. Records the schema can hold are never affected. If omitted, `on_error` is `abort`.","type":"object","properties":{"on_error":{"example":"abort","description":"What a record the new index cannot take does to the conversion.\n\nPossible values:\n- `abort`: the conversion fails, and the job's `error` names the record and the reason.\n- `continue`: the record is skipped and counted in the job's `records_skipped`.","x-enum":["abort","continue"],"type":"string","uniqueKey":"error_mode.on_error","typeLabel":"string"}},"uniqueKey":"error_mode","typeLabel":"object"},"tags":{"oneOf":[{"example":{"tag0":"val0","tag1":"val1"},"description":"Custom user tags added to an index, at most 20 per index. Keys must be 80 characters or less and alphanumeric, '_', or '-'. Values must be 120 characters or less and consist of printable ASCII characters or spaces. To unset a key, set the value to be an empty string. `null` in responses when the index has no tags.","type":"object","additionalProperties":{"type":"string","uniqueKey":"tags.oneOf.0.additionalProperties","typeLabel":"string"},"uniqueKey":"tags.oneOf.0","typeLabel":"object"},{"example":{"tag0":"val0","tag1":"val1"},"description":"Custom user tags added to an index, at most 20 per index. Keys must be 80 characters or less and alphanumeric, '_', or '-'. Values must be 120 characters or less and consist of printable ASCII characters or spaces. To unset a key, set the value to be an empty string. `null` in responses when the index has no tags.","type":"null","additionalProperties":{"type":"string","uniqueKey":"tags.oneOf.1.additionalProperties","typeLabel":"string"},"uniqueKey":"tags.oneOf.1","typeLabel":"null"}],"uniqueKey":"tags","typeLabel":"object | null"},"deletion_protection":{"description":"Whether [deletion protection](http://docs.pinecone.io/guides/manage-data/manage-indexes#configure-deletion-protection) is enabled/disabled for the index.\n\nPossible values: `disabled` or `enabled`.","default":"disabled","x-enum":["disabled","enabled"],"type":"string","uniqueKey":"deletion_protection","typeLabel":"string"},"read_capacity":{"oneOf":[{"type":"object","title":"On-demand","description":"By default the index will be created with read capacity mode `OnDemand`, for managed and BYOC indexes alike. If you prefer to allocate dedicated read nodes for your workload, you must specify mode `Dedicated` and additional configurations for `node_type` and `scaling`.","required":["mode"],"example":{"mode":"OnDemand"},"properties":{"mode":{"description":"The mode of the index. Possible values: `OnDemand` or `Dedicated`. Defaults to `OnDemand`. If set to `Dedicated`, `dedicated.node_type`, `dedicated.scaling`, and `dedicated.manual` must be specified.","type":"string","isRequired":true,"uniqueKey":"read_capacity.oneOf.0.mode","typeLabel":"string"}},"uniqueKey":"read_capacity.oneOf.0","typeLabel":"On-demand · object"},{"type":"object","title":"Dedicated","description":"By default the index will be created with read capacity mode `OnDemand`, for managed and BYOC indexes alike. If you prefer to allocate dedicated read nodes for your workload, you must specify mode `Dedicated` and additional configurations for `node_type` and `scaling`.","required":["mode","dedicated"],"example":{"dedicated":{"manual":{"replicas":1,"shards":1},"node_type":"t1","scaling":"Manual"},"mode":"Dedicated"},"properties":{"mode":{"description":"The mode of the index. Possible values: `OnDemand` or `Dedicated`. Defaults to `OnDemand`. If set to `Dedicated`, `dedicated.node_type`, `dedicated.scaling`, and `dedicated.manual` must be specified.","type":"string","isRequired":true,"uniqueKey":"read_capacity.oneOf.1.mode","typeLabel":"string"},"dedicated":{"description":"Configuration for dedicated read capacity. See [this guide](https://docs.pinecone.io/guides/index-data/dedicated-read-nodes) for more details on how to configure dedicated read capacity.","type":"object","properties":{"node_type":{"description":"The type of machines to use. Available options: `b1` and `t1`. `t1` includes increased processing power and memory.","type":"string","isRequired":true,"uniqueKey":"read_capacity.oneOf.1.dedicated.node_type","typeLabel":"string"},"scaling":{"description":"The type of scaling strategy to use.","type":"string","isRequired":true,"uniqueKey":"read_capacity.oneOf.1.dedicated.scaling","typeLabel":"string"},"manual":{"description":"The config to use for manual read capacity scaling.","type":"object","properties":{"replicas":{"description":"The number of replicas to use. Replicas duplicate the compute resources and data of an index, allowing higher query throughput and availability. Setting replicas to 0 disables the index but can be used to reduce costs while usage is paused.","type":"integer","format":"int32","minimum":0,"isRequired":true,"uniqueKey":"read_capacity.oneOf.1.dedicated.manual.replicas","typeLabel":"integer\u003cint32>"},"shards":{"description":"The number of shards to use. Shards determine the storage capacity of an index, with each shard providing 250 GB of storage.","type":"integer","format":"int32","minimum":1,"isRequired":true,"uniqueKey":"read_capacity.oneOf.1.dedicated.manual.shards","typeLabel":"integer\u003cint32>"}},"required":["replicas","shards"],"isRequired":true,"uniqueKey":"read_capacity.oneOf.1.dedicated.manual","typeLabel":"object"}},"required":["node_type","scaling","manual"],"isRequired":true,"uniqueKey":"read_capacity.oneOf.1.dedicated","typeLabel":"object"}},"uniqueKey":"read_capacity.oneOf.1","typeLabel":"Dedicated · object"}],"uniqueKey":"read_capacity","typeLabel":"On-demand · object | Dedicated · object"}},"required":["name","schema"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"dense-with-text":{"title":"dense-with-text","description":"The source holds 1536-dimension cosine vectors and a `chunk_text` metadata string on each record. The new index keeps the vectors in `embedding` and indexes `chunk_text` for full-text search.","value":{"name":"example-index-docs","schema":{"fields":{"chunk_text":{"full_text_search":{"language":"en"},"type":"string"},"embedding":{"dimension":1536,"metric":"cosine","type":"dense_vector"}}}}},"skip-bad-records":{"title":"skip-bad-records","value":{"error_mode":{"on_error":"continue"},"name":"example-index-docs","schema":{"fields":{"chunk_text":{"full_text_search":{},"type":"string"},"embedding":{"dimension":1536,"metric":"cosine","type":"dense_vector"}}}}}},"exampleType":"examples"}},"required":true,"exampleType":"examples"},"responses":{"6781d05c-e04e-43de-a982-3472625d5171":{"description":"The new index has been created and the conversion job queued.","content":{"application/json":{"schema":{"description":"The response for converting an index.","type":"object","properties":{"conversion_job_id":{"example":"670e8400-e29b-41d4-a716-446655440001","description":"Pass to Describe a conversion job to track the conversion's progress.","type":"string","isRequired":true,"uniqueKey":"conversion_job_id","typeLabel":"string"},"index_id":{"example":"123e4567-e89b-12d3-a456-426614174000","description":"The ID of the document index that was created.","type":"string","isRequired":true,"uniqueKey":"index_id","typeLabel":"string"}},"required":["conversion_job_id","index_id"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"conversion_job_id":"670e8400-e29b-41d4-a716-446655440001","index_id":"123e4567-e89b-12d3-a456-426614174000"}}},"exampleType":"generated"}},"exampleType":"generated"},"e14b7452-c945-40c3-8ce1-302db112213d":{"description":"The request is invalid, or the index cannot be converted into the requested schema. The message names the problem and how to fix it.","content":{"application/json":{"schema":{"example":{"error":{"code":"INVALID_ARGUMENT","message":"Index name must contain only lowercase alphanumeric characters or hyphens, and must not begin or end with a hyphen."},"status":400},"description":"The response shape used for all error responses.","type":"object","properties":{"status":{"example":500,"description":"The HTTP status code of the error.","type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"error":{"example":{"code":"INVALID_ARGUMENT","message":"Index name must contain only lowercase alphanumeric characters or hyphens, and must not begin or end with a hyphen."},"description":"Detailed information about the error that occurred.","type":"object","properties":{"code":{"description":"The error code.\n\nPossible values: `OK`, `UNKNOWN`, `INVALID_ARGUMENT`, `DEADLINE_EXCEEDED`, `NOT_FOUND`, `ALREADY_EXISTS`, `PERMISSION_DENIED`, `UNAUTHENTICATED`, `RESOURCE_EXHAUSTED`, `FAILED_PRECONDITION`, `ABORTED`, `OUT_OF_RANGE`, `INTERNAL`, `FORBIDDEN`, `PAYMENT_REQUIRED`, `SERVICE_UNAVAILABLE`, `PAYLOAD_TOO_LARGE`, or `UNPROCESSABLE_ENTITY`.","x-enum":["OK","UNKNOWN","INVALID_ARGUMENT","DEADLINE_EXCEEDED","NOT_FOUND","ALREADY_EXISTS","PERMISSION_DENIED","UNAUTHENTICATED","RESOURCE_EXHAUSTED","FAILED_PRECONDITION","ABORTED","OUT_OF_RANGE","INTERNAL","FORBIDDEN","PAYMENT_REQUIRED","SERVICE_UNAVAILABLE","PAYLOAD_TOO_LARGE","UNPROCESSABLE_ENTITY"],"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"example":"Index name must contain only lowercase alphanumeric characters or hyphens, and must not begin or end with a hyphen.","description":"A human-readable description of the error","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"description":"Additional information about the error. This field is not guaranteed to be present.","type":"object","uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["status","error"],"uniqueKey":"","typeLabel":"object"},"examples":{"pod-source":{"title":"pod-source","value":{"error":{"code":"INVALID_ARGUMENT","message":"Index example-index is a pod-based index. Only serverless indexes can be converted; migrate it to serverless first."},"status":400}},"byoc-source":{"title":"byoc-source","value":{"error":{"code":"INVALID_ARGUMENT","message":"Index example-index is in a BYOC environment. BYOC indexes cannot be converted."},"status":400}},"schema-exists":{"title":"schema-exists","value":{"error":{"code":"INVALID_ARGUMENT","message":"Index example-index already has a document schema. Only vector indexes can be converted."},"status":400}},"dimension-mismatch":{"title":"dimension-mismatch","value":{"error":{"code":"INVALID_ARGUMENT","message":"The schema needs a dense_vector field with dimension 1536 to hold the vectors of index example-index. Set the dense field's dimension to 1536."},"status":400}},"metric-mismatch":{"title":"metric-mismatch","value":{"error":{"code":"INVALID_ARGUMENT","message":"Field embedding uses metric euclidean, but index example-index uses cosine. Set the field's metric to cosine so scores keep their meaning."},"status":400}},"invalid-error-mode":{"title":"invalid-error-mode","value":{"error":{"code":"INVALID_ARGUMENT","message":"Invalid on_error behavior specified. Use \"continue\" or \"abort\"."},"status":400}}},"exampleType":"examples"}},"exampleType":"examples"},"0ed1bfaf-bc12-4778-803c-d8ef33fb9302":{"description":"Unauthorized. Possible causes: missing or invalid API key.","content":{"text/plain":{"schema":{"example":"Invalid API key","description":"The plain-text body of a `401` response. Authentication failures are rejected before the request reaches the API, so they carry a short message rather than an `ErrorResponse`.","type":"string","uniqueKey":"","typeLabel":"string"},"examples":{"Example":{"title":"Example","value":"Invalid API key"}},"exampleType":"generated"}},"exampleType":"generated"},"cb40199a-e463-43c4-bd48-ea15964fa714":{"description":"Payment required. Organization is on a paid plan and is delinquent on payment.","content":{"application/json":{"schema":{"example":{"error":{"code":"INVALID_ARGUMENT","message":"Index name must contain only lowercase alphanumeric characters or hyphens, and must not begin or end with a hyphen."},"status":400},"description":"The response shape used for all error responses.","type":"object","properties":{"status":{"example":500,"description":"The HTTP status code of the error.","type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"error":{"example":{"code":"INVALID_ARGUMENT","message":"Index name must contain only lowercase alphanumeric characters or hyphens, and must not begin or end with a hyphen."},"description":"Detailed information about the error that occurred.","type":"object","properties":{"code":{"description":"The error code.\n\nPossible values: `OK`, `UNKNOWN`, `INVALID_ARGUMENT`, `DEADLINE_EXCEEDED`, `NOT_FOUND`, `ALREADY_EXISTS`, `PERMISSION_DENIED`, `UNAUTHENTICATED`, `RESOURCE_EXHAUSTED`, `FAILED_PRECONDITION`, `ABORTED`, `OUT_OF_RANGE`, `INTERNAL`, `FORBIDDEN`, `PAYMENT_REQUIRED`, `SERVICE_UNAVAILABLE`, `PAYLOAD_TOO_LARGE`, or `UNPROCESSABLE_ENTITY`.","x-enum":["OK","UNKNOWN","INVALID_ARGUMENT","DEADLINE_EXCEEDED","NOT_FOUND","ALREADY_EXISTS","PERMISSION_DENIED","UNAUTHENTICATED","RESOURCE_EXHAUSTED","FAILED_PRECONDITION","ABORTED","OUT_OF_RANGE","INTERNAL","FORBIDDEN","PAYMENT_REQUIRED","SERVICE_UNAVAILABLE","PAYLOAD_TOO_LARGE","UNPROCESSABLE_ENTITY"],"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"example":"Index name must contain only lowercase alphanumeric characters or hyphens, and must not begin or end with a hyphen.","description":"A human-readable description of the error","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"description":"Additional information about the error. This field is not guaranteed to be present.","type":"object","uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["status","error"],"uniqueKey":"","typeLabel":"object"},"examples":{"payment-required":{"title":"payment-required","value":{"error":{"code":"PAYMENT_REQUIRED","message":"Request failed. Pay all past due invoices to lift restrictions on your account."},"status":402}}},"exampleType":"examples"}},"exampleType":"examples"},"817b9eaf-465f-454e-b3ff-2e88b4d4f14e":{"description":"Forbidden. Possible causes: the API key lacks the permission to create indexes, the project's index quota is exhausted, or the organization is on the Starter or Builder plan, where index conversion isn't available.","content":{"application/json":{"schema":{"example":{"error":{"code":"INVALID_ARGUMENT","message":"Index name must contain only lowercase alphanumeric characters or hyphens, and must not begin or end with a hyphen."},"status":400},"description":"The response shape used for all error responses.","type":"object","properties":{"status":{"example":500,"description":"The HTTP status code of the error.","type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"error":{"example":{"code":"INVALID_ARGUMENT","message":"Index name must contain only lowercase alphanumeric characters or hyphens, and must not begin or end with a hyphen."},"description":"Detailed information about the error that occurred.","type":"object","properties":{"code":{"description":"The error code.\n\nPossible values: `OK`, `UNKNOWN`, `INVALID_ARGUMENT`, `DEADLINE_EXCEEDED`, `NOT_FOUND`, `ALREADY_EXISTS`, `PERMISSION_DENIED`, `UNAUTHENTICATED`, `RESOURCE_EXHAUSTED`, `FAILED_PRECONDITION`, `ABORTED`, `OUT_OF_RANGE`, `INTERNAL`, `FORBIDDEN`, `PAYMENT_REQUIRED`, `SERVICE_UNAVAILABLE`, `PAYLOAD_TOO_LARGE`, or `UNPROCESSABLE_ENTITY`.","x-enum":["OK","UNKNOWN","INVALID_ARGUMENT","DEADLINE_EXCEEDED","NOT_FOUND","ALREADY_EXISTS","PERMISSION_DENIED","UNAUTHENTICATED","RESOURCE_EXHAUSTED","FAILED_PRECONDITION","ABORTED","OUT_OF_RANGE","INTERNAL","FORBIDDEN","PAYMENT_REQUIRED","SERVICE_UNAVAILABLE","PAYLOAD_TOO_LARGE","UNPROCESSABLE_ENTITY"],"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"example":"Index name must contain only lowercase alphanumeric characters or hyphens, and must not begin or end with a hyphen.","description":"A human-readable description of the error","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"description":"Additional information about the error. This field is not guaranteed to be present.","type":"object","uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["status","error"],"uniqueKey":"","typeLabel":"object"},"examples":{"permission-denied":{"title":"permission-denied","value":{"error":{"code":"PERMISSION_DENIED","message":"Access denied: Permission control::index::create is required"},"status":403}},"quota-exceeded":{"title":"quota-exceeded","value":{"error":{"code":"FORBIDDEN","message":"Increase your quota or upgrade to create more indexes."},"status":403}},"plan-not-supported":{"title":"plan-not-supported","value":{"error":{"code":"PERMISSION_DENIED","message":"Index conversion isn't available on the Starter plan. Upgrade to Standard or Enterprise to convert indexes: https://app.pinecone.io/organizations/-/settings/billing/plans"},"status":403}}},"exampleType":"examples"}},"exampleType":"examples"},"5ed00197-440a-47e9-aaba-947a3e745e7f":{"description":"Index not found.","content":{"application/json":{"schema":{"example":{"error":{"code":"INVALID_ARGUMENT","message":"Index name must contain only lowercase alphanumeric characters or hyphens, and must not begin or end with a hyphen."},"status":400},"description":"The response shape used for all error responses.","type":"object","properties":{"status":{"example":500,"description":"The HTTP status code of the error.","type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"error":{"example":{"code":"INVALID_ARGUMENT","message":"Index name must contain only lowercase alphanumeric characters or hyphens, and must not begin or end with a hyphen."},"description":"Detailed information about the error that occurred.","type":"object","properties":{"code":{"description":"The error code.\n\nPossible values: `OK`, `UNKNOWN`, `INVALID_ARGUMENT`, `DEADLINE_EXCEEDED`, `NOT_FOUND`, `ALREADY_EXISTS`, `PERMISSION_DENIED`, `UNAUTHENTICATED`, `RESOURCE_EXHAUSTED`, `FAILED_PRECONDITION`, `ABORTED`, `OUT_OF_RANGE`, `INTERNAL`, `FORBIDDEN`, `PAYMENT_REQUIRED`, `SERVICE_UNAVAILABLE`, `PAYLOAD_TOO_LARGE`, or `UNPROCESSABLE_ENTITY`.","x-enum":["OK","UNKNOWN","INVALID_ARGUMENT","DEADLINE_EXCEEDED","NOT_FOUND","ALREADY_EXISTS","PERMISSION_DENIED","UNAUTHENTICATED","RESOURCE_EXHAUSTED","FAILED_PRECONDITION","ABORTED","OUT_OF_RANGE","INTERNAL","FORBIDDEN","PAYMENT_REQUIRED","SERVICE_UNAVAILABLE","PAYLOAD_TOO_LARGE","UNPROCESSABLE_ENTITY"],"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"example":"Index name must contain only lowercase alphanumeric characters or hyphens, and must not begin or end with a hyphen.","description":"A human-readable description of the error","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"description":"Additional information about the error. This field is not guaranteed to be present.","type":"object","uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["status","error"],"uniqueKey":"","typeLabel":"object"},"examples":{"index-not-found":{"title":"index-not-found","value":{"error":{"code":"NOT_FOUND","message":"Index example-index not found."},"status":404}}},"exampleType":"examples"}},"exampleType":"examples"},"008fa43b-f90f-4ac7-a1c4-ce267fb722a1":{"description":"An index with the requested `name` already exists in the project, including an index created by an earlier request to convert. Choose another name, or find the earlier job with List conversion jobs.","content":{"application/json":{"schema":{"example":{"error":{"code":"INVALID_ARGUMENT","message":"Index name must contain only lowercase alphanumeric characters or hyphens, and must not begin or end with a hyphen."},"status":400},"description":"The response shape used for all error responses.","type":"object","properties":{"status":{"example":500,"description":"The HTTP status code of the error.","type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"error":{"example":{"code":"INVALID_ARGUMENT","message":"Index name must contain only lowercase alphanumeric characters or hyphens, and must not begin or end with a hyphen."},"description":"Detailed information about the error that occurred.","type":"object","properties":{"code":{"description":"The error code.\n\nPossible values: `OK`, `UNKNOWN`, `INVALID_ARGUMENT`, `DEADLINE_EXCEEDED`, `NOT_FOUND`, `ALREADY_EXISTS`, `PERMISSION_DENIED`, `UNAUTHENTICATED`, `RESOURCE_EXHAUSTED`, `FAILED_PRECONDITION`, `ABORTED`, `OUT_OF_RANGE`, `INTERNAL`, `FORBIDDEN`, `PAYMENT_REQUIRED`, `SERVICE_UNAVAILABLE`, `PAYLOAD_TOO_LARGE`, or `UNPROCESSABLE_ENTITY`.","x-enum":["OK","UNKNOWN","INVALID_ARGUMENT","DEADLINE_EXCEEDED","NOT_FOUND","ALREADY_EXISTS","PERMISSION_DENIED","UNAUTHENTICATED","RESOURCE_EXHAUSTED","FAILED_PRECONDITION","ABORTED","OUT_OF_RANGE","INTERNAL","FORBIDDEN","PAYMENT_REQUIRED","SERVICE_UNAVAILABLE","PAYLOAD_TOO_LARGE","UNPROCESSABLE_ENTITY"],"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"example":"Index name must contain only lowercase alphanumeric characters or hyphens, and must not begin or end with a hyphen.","description":"A human-readable description of the error","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"description":"Additional information about the error. This field is not guaranteed to be present.","type":"object","uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["status","error"],"uniqueKey":"","typeLabel":"object"},"examples":{"index-name-already-exists":{"title":"index-name-already-exists","value":{"error":{"code":"ALREADY_EXISTS","message":"Index example-index-docs already exists. Choose another name. To check an earlier conversion into it, list conversion jobs."},"status":409}}},"exampleType":"examples"}},"exampleType":"examples"},"4980b923-61a3-4fe2-a2db-536a44e1b364":{"description":"The source index cannot be converted in its current state: it is not `Ready`. Wait until the index is `Ready`, then retry.","content":{"application/json":{"schema":{"example":{"error":{"code":"INVALID_ARGUMENT","message":"Index name must contain only lowercase alphanumeric characters or hyphens, and must not begin or end with a hyphen."},"status":400},"description":"The response shape used for all error responses.","type":"object","properties":{"status":{"example":500,"description":"The HTTP status code of the error.","type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"error":{"example":{"code":"INVALID_ARGUMENT","message":"Index name must contain only lowercase alphanumeric characters or hyphens, and must not begin or end with a hyphen."},"description":"Detailed information about the error that occurred.","type":"object","properties":{"code":{"description":"The error code.\n\nPossible values: `OK`, `UNKNOWN`, `INVALID_ARGUMENT`, `DEADLINE_EXCEEDED`, `NOT_FOUND`, `ALREADY_EXISTS`, `PERMISSION_DENIED`, `UNAUTHENTICATED`, `RESOURCE_EXHAUSTED`, `FAILED_PRECONDITION`, `ABORTED`, `OUT_OF_RANGE`, `INTERNAL`, `FORBIDDEN`, `PAYMENT_REQUIRED`, `SERVICE_UNAVAILABLE`, `PAYLOAD_TOO_LARGE`, or `UNPROCESSABLE_ENTITY`.","x-enum":["OK","UNKNOWN","INVALID_ARGUMENT","DEADLINE_EXCEEDED","NOT_FOUND","ALREADY_EXISTS","PERMISSION_DENIED","UNAUTHENTICATED","RESOURCE_EXHAUSTED","FAILED_PRECONDITION","ABORTED","OUT_OF_RANGE","INTERNAL","FORBIDDEN","PAYMENT_REQUIRED","SERVICE_UNAVAILABLE","PAYLOAD_TOO_LARGE","UNPROCESSABLE_ENTITY"],"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"example":"Index name must contain only lowercase alphanumeric characters or hyphens, and must not begin or end with a hyphen.","description":"A human-readable description of the error","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"description":"Additional information about the error. This field is not guaranteed to be present.","type":"object","uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["status","error"],"uniqueKey":"","typeLabel":"object"},"examples":{"source-not-ready":{"title":"source-not-ready","value":{"error":{"code":"FAILED_PRECONDITION","message":"Index example-index is Initializing. Wait until it is Ready, then retry."},"status":412}}},"exampleType":"examples"}},"exampleType":"examples"},"6c45330e-b529-40c1-8f29-1499dbdf7489":{"description":"Unprocessable entity. The request body is valid JSON but could not be deserialized into the request type, for example because it has an unknown key, a missing required key, or a value of the wrong type. The body is a plain-text message naming the problem and where it occurred, not an `ErrorResponse`.","content":{"text/plain":{"schema":{"example":"Failed to deserialize the JSON body into the target type: missing field `metric` at line 1 column 16","description":"The plain-text body of a `422` response. A request body that cannot be deserialized is rejected before the request reaches the API, so it carries the deserializer's message rather than an `ErrorResponse`.","type":"string","uniqueKey":"","typeLabel":"string"},"examples":{"missing-field":{"title":"missing-field","value":"Failed to deserialize the JSON body into the target type: missing field `metric` at line 1 column 16"},"unknown-field":{"title":"unknown-field","value":"Failed to deserialize the JSON body into the target type: schema.fields.score: unknown field `embed`, expected `description` or `filterable` at line 1 column 98"}},"exampleType":"examples"}},"exampleType":"examples"},"6ed36cf7-bac4-4014-b6a9-ec8d84b78a81":{"description":"Internal server error.","content":{"application/json":{"schema":{"example":{"error":{"code":"INVALID_ARGUMENT","message":"Index name must contain only lowercase alphanumeric characters or hyphens, and must not begin or end with a hyphen."},"status":400},"description":"The response shape used for all error responses.","type":"object","properties":{"status":{"example":500,"description":"The HTTP status code of the error.","type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"error":{"example":{"code":"INVALID_ARGUMENT","message":"Index name must contain only lowercase alphanumeric characters or hyphens, and must not begin or end with a hyphen."},"description":"Detailed information about the error that occurred.","type":"object","properties":{"code":{"description":"The error code.\n\nPossible values: `OK`, `UNKNOWN`, `INVALID_ARGUMENT`, `DEADLINE_EXCEEDED`, `NOT_FOUND`, `ALREADY_EXISTS`, `PERMISSION_DENIED`, `UNAUTHENTICATED`, `RESOURCE_EXHAUSTED`, `FAILED_PRECONDITION`, `ABORTED`, `OUT_OF_RANGE`, `INTERNAL`, `FORBIDDEN`, `PAYMENT_REQUIRED`, `SERVICE_UNAVAILABLE`, `PAYLOAD_TOO_LARGE`, or `UNPROCESSABLE_ENTITY`.","x-enum":["OK","UNKNOWN","INVALID_ARGUMENT","DEADLINE_EXCEEDED","NOT_FOUND","ALREADY_EXISTS","PERMISSION_DENIED","UNAUTHENTICATED","RESOURCE_EXHAUSTED","FAILED_PRECONDITION","ABORTED","OUT_OF_RANGE","INTERNAL","FORBIDDEN","PAYMENT_REQUIRED","SERVICE_UNAVAILABLE","PAYLOAD_TOO_LARGE","UNPROCESSABLE_ENTITY"],"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"example":"Index name must contain only lowercase alphanumeric characters or hyphens, and must not begin or end with a hyphen.","description":"A human-readable description of the error","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"description":"Additional information about the error. This field is not guaranteed to be present.","type":"object","uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["status","error"],"uniqueKey":"","typeLabel":"object"},"examples":{"internal-server-error":{"title":"internal-server-error","value":{"error":{"code":"UNKNOWN","message":"Internal server error"},"status":500}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"da7157b6-f255-45e5-9544-cc40eba5a9d4":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Api-Key","description":"An API Key is required to call Pinecone APIs. Get yours from the [console](https://app.pinecone.io/).","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"3ca75f45-7588-45d8-9fc3-6d78793c61b4":{"url":"https://api.pinecone.io","description":"Production API endpoints"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"Api-Key","description":"An API Key is required to call Pinecone APIs. Get yours from the [console](https://app.pinecone.io/).","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"Api-Key","type":"string","description":"An API Key is required to call Pinecone APIs. Get yours from the [console](https://app.pinecone.io/).","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"Api-Key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_control_2026-07.oas.yaml"},"subdomain":"pinecone","siteName":"Pinecone Docs","title":"Convert an index into a document index - Pinecone Docs","navMaps":{"firstHrefInVersion":{"2026-07 (latest)":{"href":"/reference/api/2026-07/control-plane/convert_index","matchLevel":0},"2026-04":{"href":"/reference/api/2026-04/control-plane/list_indexes","matchLevel":2},"2025-10":{"href":"/reference/api/2025-10/control-plane/list_indexes","matchLevel":2},"2025-04":{"href":"/reference/api/2025-04/control-plane/list_indexes","matchLevel":2},"2025-01":{"href":"/reference/api/2025-01/control-plane/list_indexes","matchLevel":2},"2024-10":{"href":"/reference/api/2024-10/control-plane/list_indexes","matchLevel":2},"2024-07":{"href":"/reference/api/2024-07/control-plane/list_indexes","matchLevel":2},"2024-04":{"href":"/reference/api/2024-04/control-plane/list_indexes","matchLevel":2}},"firstHrefInLanguage":{}},"lastModified":"2026-11-03T16:12:24.922Z","originalFileLocation":"reference/api/2026-07/control-plane/convert_index.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=\"Convert a serverless vector index or legacy integrated index into a new document index. The source index isn\u0026#x27;t changed, and the new index holds a snapshot of the source taken when the job starts. The request returns once the new index is created in the Initializing state. Track the job with Describe a conversion job. If the job fails or is canceled, the index is left in the InitializationFailed state with no usable data. Delete it to free its name. A job that fails because of your data is charged for the data it read, and a canceled job isn\u0026#x27;t charged. For how source records map to the schema, see Convert an index.\">\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=\"Convert an index into a document index - Pinecone Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Convert a serverless vector index or legacy integrated index into a new document index. The source index isn\u0026#x27;t changed, and the new index holds a snapshot of the source taken when the job starts. The request returns once the new index is created in the Initializing state. Track the job with Describe a conversion job. If the job fails or is canceled, the index is left in the InitializationFailed state with no usable data. Delete it to free its name. A job that fails because of your data is charged for the data it read, and a canceled job isn\u0026#x27;t charged. For how source records map to the schema, see Convert an index.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Pinecone Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.pinecone.io/reference/api/2026-07/control-plane/convert_index\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://www.pinecone.io/images/docs_og_image_v2.png\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Documentation for the trusted AI knowledge platform | Pinecone\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Guides, API references, and examples for building with Pinecone Database, Pinecone Assistant, and Pinecone Nexus.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://www.pinecone.io/images/docs_og_image_v2.png\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/pinecone/JqxxUxUkDTnX7oN2/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Pinecone Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#002BFF\">\u003cmeta data-mint-head name=\"google-site-verification\" content=\"woTBImNAcYO-gseVfFKIzQrDRUmLWzFjBWrYbYkOTlI\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.pinecone.io/reference/api/2026-07/control-plane/convert_index\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/reference/api/2026-07/control-plane/convert_index.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.pinecone.io/#organization\",\"name\":\"Pinecone Docs\",\"url\":\"https://docs.pinecone.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/pinecone/HsZKO51bNmpAasdT/logo/Pinecone-Full-Logo-Black.svg?fit=max\u0026auto=format\u0026n=HsZKO51bNmpAasdT\u0026q=85\u0026s=211d0e7bbefc29ce3b8feee1a05d76ee\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.pinecone.io#website\",\"name\":\"Pinecone Docs\",\"url\":\"https://docs.pinecone.io\",\"publisher\":{\"@id\":\"https://docs.pinecone.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.pinecone.io/reference/api/2026-07/control-plane/convert_index#webpage\",\"url\":\"https://docs.pinecone.io/reference/api/2026-07/control-plane/convert_index\",\"name\":\"Convert an index into a document index\",\"description\":\"Convert a serverless vector index or legacy integrated index into a new document index. The source index isn't changed, and the new index holds a snapshot of the source taken when the job starts. The request returns once the new index is created in the Initializing state. Track the job with Describe a conversion job. If the job fails or is canceled, the index is left in the InitializationFailed state with no usable data. Delete it to free its name. A job that fails because of your data is charged for the data it read, and a canceled job isn't charged. For how source records map to the schema, see Convert an index.\",\"dateModified\":\"2026-11-03T16:12:24.922Z\",\"isPartOf\":{\"@id\":\"https://docs.pinecone.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.pinecone.io/reference/api/2026-07/control-plane/convert_index#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.pinecone.io/reference/api/2026-07/control-plane/convert_index#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Database\",\"item\":\"https://docs.pinecone.io/reference/api/2026-07/control-plane/list_indexes\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Convert an index into a document index\",\"item\":\"https://docs.pinecone.io/reference/api/2026-07/control-plane/convert_index\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.pinecone.io/reference/api/2026-07/control-plane/convert_index#apireference\",\"headline\":\"Convert an index into a document index\",\"name\":\"Convert an index into a document index\",\"description\":\"Convert a serverless vector index or legacy integrated index into a new document index. The source index isn't changed, and the new index holds a snapshot of the source taken when the job starts. The request returns once the new index is created in the Initializing state. Track the job with Describe a conversion job. If the job fails or is canceled, the index is left in the InitializationFailed state with no usable data. Delete it to free its name. A job that fails because of your data is charged for the data it read, and a canceled job isn't charged. For how source records map to the schema, see Convert an index.\",\"url\":\"https://docs.pinecone.io/reference/api/2026-07/control-plane/convert_index\",\"mainEntityOfPage\":{\"@id\":\"https://docs.pinecone.io/reference/api/2026-07/control-plane/convert_index#webpage\"},\"image\":\"https://www.pinecone.io/images/docs_og_image_v2.png\",\"dateModified\":\"2026-11-03T16:12:24.922Z\",\"publisher\":{\"@id\":\"https://docs.pinecone.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.pinecone.io#website\"}}]}\u003c/script>","siteName":"Pinecone Docs","nav":{"global":null,"dropdowns":[{"dropdown":"Pinecone Database","icon":"database","tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/guides/get-started/overview"}]},{"tab":"Reference","versions":[{"version":"2026-07 (latest)","default":true,"groups":[{"group":"APIs","pages":[{"title":"API reference","sidebarTitle":"Introduction","href":"/reference/api/introduction"},{"title":"Pinecone API authentication","sidebarTitle":"Authentication","href":"/reference/api/authentication"},{"title":"Pinecone API versioning","sidebarTitle":"Versioning","href":"/reference/api/versioning"},{"group":"Database limits","pages":[{"title":"Pinecone Database limits overview","sidebarTitle":"Overview","href":"/reference/api/database-limits"},{"title":"Rate limits","sidebarTitle":"Rate limits","href":"/reference/api/database-limits/rate-limits"},{"title":"Object limits","sidebarTitle":"Object limits","href":"/reference/api/database-limits/object-limits"},{"title":"Operation limits","sidebarTitle":"Operation limits","href":"/reference/api/database-limits/operation-limits"},{"title":"Identifier limits","sidebarTitle":"Identifier limits","href":"/reference/api/database-limits/identifier-limits"},{"title":"Known limitations","href":"/reference/api/known-limitations"}]},{"title":"Pinecone API errors","sidebarTitle":"Errors","href":"/reference/api/errors"}]},{"group":"Database","pages":[{"group":"Indexes","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_control_2026-07.oas.yaml get /indexes","title":"List indexes","href":"/reference/api/2026-07/control-plane/list_indexes"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_control_2026-07.oas.yaml post /indexes","title":"Create an index","href":"/reference/api/2026-07/control-plane/create_index"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_control_2026-07.oas.yaml post /indexes/create-for-model","title":"Create a legacy integrated index","href":"/reference/api/2026-07/control-plane/create_for_model"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_control_2026-07.oas.yaml get /indexes/{index_name}","title":"Describe an index","href":"/reference/api/2026-07/control-plane/describe_index"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_control_2026-07.oas.yaml delete /indexes/{index_name}","title":"Delete an index","href":"/reference/api/2026-07/control-plane/delete_index"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_control_2026-07.oas.yaml patch /indexes/{index_name}","title":"Configure an index","href":"/reference/api/2026-07/control-plane/configure_index"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml post /describe_index_stats","title":"Get index stats","description":"Return statistics about the contents of an index, including the vector count per namespace, the number of dimensions, and the index fullness.\n\nServerless indexes scale automatically as needed, so index fullness is relevant only for pod-based indexes.","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","description":"List the project's conversion jobs, newest first.","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":"Namespaces","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml get /namespaces","title":"List namespaces","href":"/reference/api/2026-07/data-plane/listnamespaces"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml post /namespaces","title":"Create a namespace","href":"/reference/api/2026-07/data-plane/createnamespace"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml get /namespaces/{namespace}","title":"Describe a namespace","href":"/reference/api/2026-07/data-plane/describenamespace"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml delete /namespaces/{namespace}","title":"Delete a namespace","href":"/reference/api/2026-07/data-plane/deletenamespace"}]},{"group":"Namespace aliases","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml get /namespace-aliases","title":"List namespace aliases","href":"/reference/api/2026-07/data-plane/list_namespace_aliases"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml post /namespace-aliases","title":"Create a namespace alias","href":"/reference/api/2026-07/data-plane/create_namespace_alias"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml get /namespace-aliases/{alias_name}","title":"Describe a namespace alias","href":"/reference/api/2026-07/data-plane/describe_namespace_alias"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml patch /namespace-aliases/{alias_name}","title":"Repoint a namespace alias","href":"/reference/api/2026-07/data-plane/repoint_namespace_alias"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml delete /namespace-aliases/{alias_name}","title":"Delete a namespace alias","href":"/reference/api/2026-07/data-plane/delete_namespace_alias"}]},{"group":"Vectors","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml post /vectors/upsert","title":"Upsert records","href":"/reference/api/2026-07/data-plane/upsert"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml post /records/namespaces/{namespace}/upsert","title":"Upsert text (legacy Records API)","href":"/reference/api/2026-07/data-plane/upsert_records"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml get /vectors/fetch","title":"Fetch records","href":"/reference/api/2026-07/data-plane/fetch"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml post /vectors/fetch_by_metadata","title":"Fetch records by metadata","href":"/reference/api/2026-07/data-plane/fetch_by_metadata"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml post /vectors/update","title":"Update a record","href":"/reference/api/2026-07/data-plane/update"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml post /vectors/delete","title":"Delete records","href":"/reference/api/2026-07/data-plane/delete"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml get /vectors/list","title":"List record IDs","href":"/reference/api/2026-07/data-plane/list"}]},{"group":"Search","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml post /query","title":"Search with a vector","href":"/reference/api/2026-07/data-plane/query"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml post /records/namespaces/{namespace}/search","title":"Search with text (legacy Records API)","href":"/reference/api/2026-07/data-plane/search_records"}]},{"group":"Documents","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml post /namespaces/{namespace}/documents/upsert","title":"Upsert documents","href":"/reference/api/2026-07/data-plane/upsert_documents"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml post /namespaces/{namespace}/documents/search","title":"Search documents","href":"/reference/api/2026-07/data-plane/search_documents"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml post /namespaces/{namespace}/documents/fetch","title":"Fetch documents","href":"/reference/api/2026-07/data-plane/fetch_documents"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml post /namespaces/{namespace}/documents/list","title":"List documents","href":"/reference/api/2026-07/data-plane/list_documents"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml post /namespaces/{namespace}/documents/update","title":"Update documents","href":"/reference/api/2026-07/data-plane/update_documents"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml post /namespaces/{namespace}/documents/delete","title":"Delete documents","href":"/reference/api/2026-07/data-plane/delete_documents"}]},{"group":"Imports","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml post /bulk/imports","title":"Start import","href":"/reference/api/2026-07/data-plane/start_import"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml get /bulk/imports","title":"List imports","href":"/reference/api/2026-07/data-plane/list_imports"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml get /bulk/imports/{id}","title":"Describe an import","href":"/reference/api/2026-07/data-plane/describe_import"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml delete /bulk/imports/{id}","title":"Cancel an import","href":"/reference/api/2026-07/data-plane/cancel_import"}]},{"group":"Backups","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_control_2026-07.oas.yaml post /indexes/{index_name}/backups","title":"Create a backup of an index","href":"/reference/api/2026-07/control-plane/create_backup"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_control_2026-07.oas.yaml get /backups","title":"List backups for all indexes in a project","href":"/reference/api/2026-07/control-plane/list_project_backups"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_control_2026-07.oas.yaml get /indexes/{index_name}/backups","title":"List backups for an index","href":"/reference/api/2026-07/control-plane/list_index_backups"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_control_2026-07.oas.yaml get /backups/{backup_id}","title":"Describe a backup","href":"/reference/api/2026-07/control-plane/describe_backup"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_control_2026-07.oas.yaml delete /backups/{backup_id}","title":"Delete a backup","href":"/reference/api/2026-07/control-plane/delete_backup"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_control_2026-07.oas.yaml post /backups/{backup_id}/create-index","title":"Create an index from a backup","href":"/reference/api/2026-07/control-plane/create_index_from_backup"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_control_2026-07.oas.yaml get /restore-jobs","title":"List restore jobs","href":"/reference/api/2026-07/control-plane/list_restore_jobs"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_control_2026-07.oas.yaml get /restore-jobs/{job_id}","title":"Describe a restore job","href":"/reference/api/2026-07/control-plane/describe_restore_job"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_control_2026-07.oas.yaml get /collections","title":"List collections","href":"/reference/api/2026-07/control-plane/list_collections"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_control_2026-07.oas.yaml post /collections","title":"Create a collection","href":"/reference/api/2026-07/control-plane/create_collection"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_control_2026-07.oas.yaml get /collections/{collection_name}","title":"Describe a collection","href":"/reference/api/2026-07/control-plane/describe_collection"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_control_2026-07.oas.yaml delete /collections/{collection_name}","title":"Delete a collection","href":"/reference/api/2026-07/control-plane/delete_collection"}]},{"group":"Backup schedules","pages":[{"title":"Create backup schedule","sidebarTitle":"Create backup schedule","api":"POST https://api.pinecone.io/indexes/{index_name}/backup-schedules","href":"/reference/api/2026-07/control-plane/create_backup_schedule"},{"title":"List backup schedules","sidebarTitle":"List backup schedules","api":"GET https://api.pinecone.io/indexes/{index_name}/backup-schedules","href":"/reference/api/2026-07/control-plane/list_backup_schedules"},{"title":"Describe backup schedule","sidebarTitle":"Describe backup schedule","api":"GET https://api.pinecone.io/backup-schedules/{schedule_id}","href":"/reference/api/2026-07/control-plane/describe_backup_schedule"},{"title":"Update backup schedule","sidebarTitle":"Update backup schedule","api":"PATCH https://api.pinecone.io/backup-schedules/{schedule_id}","href":"/reference/api/2026-07/control-plane/update_backup_schedule"},{"title":"Delete backup schedule","sidebarTitle":"Delete backup schedule","api":"DELETE https://api.pinecone.io/backup-schedules/{schedule_id}","href":"/reference/api/2026-07/control-plane/delete_backup_schedule"},{"title":"List backup schedule history","sidebarTitle":"List schedule history","api":"GET https://api.pinecone.io/backup-schedules/{schedule_id}/history","href":"/reference/api/2026-07/control-plane/list_backup_schedule_history"}]}]},{"group":"Inference","pages":[{"group":"Inference","pages":[{"title":"Generate vectors","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/inference_2026-07.oas.yaml post /embed","href":"/reference/api/2026-07/inference/generate-vectors"},{"title":"Rerank results","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/inference_2026-07.oas.yaml post /rerank","href":"/reference/api/2026-07/inference/rerank-results"},{"title":"List available models","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/inference_2026-07.oas.yaml get /models","href":"/reference/api/2026-07/inference/list-available-models"},{"title":"Describe a model","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/inference_2026-07.oas.yaml get /models/{model_name}","href":"/reference/api/2026-07/inference/describe-a-model"}]}]},{"group":"Admin","pages":[{"group":"Projects","pages":[{"title":"List projects","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml get /admin/projects","href":"/reference/api/2026-07/admin/projects/list-projects"},{"title":"Create a new project","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml post /admin/projects","href":"/reference/api/2026-07/admin/projects/create-a-new-project"},{"title":"Get project details","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml get /admin/projects/{project_id}","href":"/reference/api/2026-07/admin/projects/get-project-details"},{"title":"Delete a project","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml delete /admin/projects/{project_id}","href":"/reference/api/2026-07/admin/projects/delete-a-project"},{"title":"Update a project","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml patch /admin/projects/{project_id}","href":"/reference/api/2026-07/admin/projects/update-a-project"}]},{"group":"Organizations","pages":[{"title":"List organizations","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml get /admin/organizations","href":"/reference/api/2026-07/admin/organizations/list-organizations"},{"title":"Get organization details","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml get /admin/organizations/{organization_id}","href":"/reference/api/2026-07/admin/organizations/get-organization-details"},{"title":"Delete an organization","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml delete /admin/organizations/{organization_id}","href":"/reference/api/2026-07/admin/organizations/delete-an-organization"},{"title":"Update an organization","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml patch /admin/organizations/{organization_id}","href":"/reference/api/2026-07/admin/organizations/update-an-organization"}]},{"group":"API Keys","pages":[{"title":"List API keys","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml get /admin/projects/{project_id}/api-keys","href":"/reference/api/2026-07/admin/api-keys/list-api-keys"},{"title":"Create an API key","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml post /admin/projects/{project_id}/api-keys","href":"/reference/api/2026-07/admin/api-keys/create-an-api-key"},{"title":"Get API key details","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml get /admin/api-keys/{api_key_id}","href":"/reference/api/2026-07/admin/api-keys/get-api-key-details"},{"title":"Delete an API key","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml delete /admin/api-keys/{api_key_id}","href":"/reference/api/2026-07/admin/api-keys/delete-an-api-key"},{"title":"Update an API key","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml patch /admin/api-keys/{api_key_id}","href":"/reference/api/2026-07/admin/api-keys/update-an-api-key"}]},{"group":"Users","pages":[{"title":"List users in the organization","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml get /admin/users","href":"/reference/api/2026-07/admin/users/list-users-in-the-organization"},{"title":"Get user details","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml get /admin/users/{user_id}","href":"/reference/api/2026-07/admin/users/get-user-details"},{"title":"Remove a user from the organization","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml delete /admin/users/{user_id}","href":"/reference/api/2026-07/admin/users/remove-a-user-from-the-organization"}]},{"group":"Invites","pages":[{"title":"List invites","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml get /admin/invites","href":"/reference/api/2026-07/admin/invites/list-invites"},{"title":"Invite a user to the organization","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml post /admin/invites","href":"/reference/api/2026-07/admin/invites/invite-a-user-to-the-organization"},{"title":"Get invite details","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml get /admin/invites/{invite_id}","href":"/reference/api/2026-07/admin/invites/get-invite-details"},{"title":"Delete an invite","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml delete /admin/invites/{invite_id}","href":"/reference/api/2026-07/admin/invites/delete-an-invite"},{"title":"Resend an invite email","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml post /admin/invites/{invite_id}/resend","href":"/reference/api/2026-07/admin/invites/resend-an-invite-email"}]},{"group":"Service Accounts","pages":[{"title":"List service accounts","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml get /admin/service-accounts","href":"/reference/api/2026-07/admin/service-accounts/list-service-accounts"},{"title":"Create a service account","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml post /admin/service-accounts","href":"/reference/api/2026-07/admin/service-accounts/create-a-service-account"},{"title":"Get service account details","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml get /admin/service-accounts/{service_account_id}","href":"/reference/api/2026-07/admin/service-accounts/get-service-account-details"},{"title":"Delete a service account","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml delete /admin/service-accounts/{service_account_id}","href":"/reference/api/2026-07/admin/service-accounts/delete-a-service-account"},{"title":"Update a service account","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml patch /admin/service-accounts/{service_account_id}","href":"/reference/api/2026-07/admin/service-accounts/update-a-service-account"},{"title":"Rotate a service account's OAuth client secret","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml post /admin/service-accounts/{service_account_id}/rotate-secret","href":"/reference/api/2026-07/admin/service-accounts/rotate-a-service-accounts-oauth-client-secret"}]},{"group":"Role Bindings","pages":[{"title":"List role bindings","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml get /admin/role-bindings","href":"/reference/api/2026-07/admin/role-bindings/list-role-bindings"},{"title":"Create a role binding","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml post /admin/role-bindings","href":"/reference/api/2026-07/admin/role-bindings/create-a-role-binding"},{"title":"Get role binding details","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml get /admin/role-bindings/{role_binding_id}","href":"/reference/api/2026-07/admin/role-bindings/get-role-binding-details"},{"title":"Delete a role binding","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml delete /admin/role-bindings/{role_binding_id}","href":"/reference/api/2026-07/admin/role-bindings/delete-a-role-binding"}]},{"group":"Cost Usage Exports","pages":[{"title":"List cost usage exports","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml get /admin/cost-usage-exports","href":"/reference/api/2026-07/admin/cost-usage-exports/list-cost-usage-exports"},{"title":"Create a cost usage export","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml post /admin/cost-usage-exports","href":"/reference/api/2026-07/admin/cost-usage-exports/create-a-cost-usage-export"},{"title":"Get cost usage export details","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml get /admin/cost-usage-exports/{cost_usage_export_id}","href":"/reference/api/2026-07/admin/cost-usage-exports/get-cost-usage-export-details"}]}]},{"group":"SDKs","pages":[{"title":"Pinecone SDKs overview","href":"/reference/pinecone-sdks"},{"group":"Python","pages":[{"title":"Pinecone Python SDK","sidebarTitle":"Overview","href":"/reference/sdks/python/overview"},{"title":"Reference","url":"https://sdk.pinecone.io/python/","href":"/reference/sdks/python/reference"}]},{"group":"Node.js","pages":[{"title":"Pinecone Node.js SDK","sidebarTitle":"Overview","href":"/reference/sdks/node/overview"},{"title":"Reference","url":"https://sdk.pinecone.io/typescript/","href":"/reference/sdks/node/reference"}]},{"group":"Java","pages":[{"title":"Pinecone Java SDK","sidebarTitle":"Overview","href":"/reference/sdks/java/overview"},{"title":"Reference","url":"https://github.com/pinecone-io/pinecone-java-client","href":"/reference/sdks/java/reference"},{"title":"OpenTelemetry support","sidebarTitle":"OpenTelemetry","href":"/reference/sdks/java/open-telemetry"}]},{"group":"Go","pages":[{"title":"Pinecone Go SDK","sidebarTitle":"Overview","href":"/reference/sdks/go/overview"},{"title":"Reference","url":"https://github.com/pinecone-io/go-pinecone","href":"/reference/sdks/go/reference"}]}]},{"group":"CLI","pages":[{"title":"CLI quickstart","sidebarTitle":"Quickstart","href":"/reference/cli/quickstart"},{"title":"CLI command reference","sidebarTitle":"Command reference","href":"/reference/cli/command-reference"},{"title":"CLI authentication","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/2026-04/control-plane/list_indexes"}]},{"version":"2025-10","pages":[{"title":"2025-10","href":"/reference/api/2025-10/control-plane/list_indexes"}]},{"version":"2025-04","pages":[{"title":"2025-04","href":"/reference/api/2025-04/control-plane/list_indexes"}]},{"version":"2025-01","pages":[{"title":"2025-01","href":"/reference/api/2025-01/control-plane/list_indexes"}]},{"version":"2024-10","pages":[{"title":"2024-10","href":"/reference/api/2024-10/control-plane/list_indexes"}]},{"version":"2024-07","pages":[{"title":"2024-07","href":"/reference/api/2024-07/control-plane/list_indexes"}]},{"version":"2024-04","pages":[{"title":"2024-04","href":"/reference/api/2024-04/control-plane/list_indexes"}]}]},{"tab":"Examples","pages":[{"title":"Examples","href":"/examples/notebooks"}]},{"tab":"Models","pages":[{"title":"Models","href":"/models/overview"}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/integrations/overview"}]},{"tab":"Admin","pages":[{"title":"Admin","href":"/admin/organizations/understanding-organizations"}]}]},{"dropdown":"Pinecone Assistant","icon":"comments","tabs":[{"tab":"Guides","groups":[{"group":"Get started","pages":[{"title":"Pinecone Assistant","sidebarTitle":"Overview","mode":"wide","href":"/guides/assistant/overview"},{"group":"Quickstart","pages":[{"title":"Pinecone Assistant: SDK quickstart","sidebarTitle":"SDK quickstart","href":"/guides/assistant/quickstart/sdk-quickstart"},{"title":"Pinecone Assistant: n8n quickstart","sidebarTitle":"n8n quickstart","href":"/guides/assistant/quickstart/n8n-quickstart"}]}]},{"group":"Build an assistant","pages":[{"title":"Create an assistant","mode":"wide","href":"/guides/assistant/create-assistant"},{"title":"Manage assistants","href":"/guides/assistant/manage-assistants"}]},{"group":"Upload your data","pages":[{"title":"Files in Pinecone Assistant","sidebarTitle":"Overview","href":"/guides/assistant/files-overview"},{"title":"Upload files","href":"/guides/assistant/upload-files"},{"title":"Multimodal context for assistants","sidebarTitle":"Multimodal context","href":"/guides/assistant/multimodal"},{"title":"Manage files","href":"/guides/assistant/manage-files"}]},{"group":"Chat with an assistant","pages":[{"title":"Chat through the standard interface","sidebarTitle":"Standard interface","href":"/guides/assistant/chat-with-assistant"},{"title":"Chat through the OpenAI-compatible interface","sidebarTitle":"OpenAI-compatible interface","href":"/guides/assistant/chat-through-the-openai-compatible-interface"}]},{"group":"Evaluate answers","pages":[{"title":"Evaluation overview","sidebarTitle":"Overview","href":"/guides/assistant/evaluation-overview"},{"title":"Evaluate answers","mode":"wide","href":"/guides/assistant/evaluate-answers"}]},{"group":"Retrieve context snippets","pages":[{"title":"Context snippets overview","sidebarTitle":"Overview","href":"/guides/assistant/context-snippets-overview"},{"title":"Retrieve context snippets","href":"/guides/assistant/retrieve-context-snippets"}]},{"group":"Integrate with AI agents","pages":[{"title":"Use an Assistant MCP server","sidebarTitle":"Use an MCP server","href":"/guides/assistant/mcp-server"}]},{"group":"Admin","pages":[{"title":"Pinecone Assistant pricing and limits","sidebarTitle":"Pricing and limits","href":"/guides/assistant/pricing-and-limits"},{"title":"Monitor usage and cost","href":"/guides/assistant/admin/monitor-spend-and-usage"},{"title":"Billing and access","url":"/admin/organizations/understanding-organizations","href":"/guides/assistant/admin-link"}]}]},{"tab":"Reference","versions":[{"version":"2026-07 (latest)","default":true,"groups":[{"group":"APIs","pages":[{"title":"Assistant API reference","sidebarTitle":"Introduction","href":"/reference/api/assistant/introduction"},{"title":"Pinecone Assistant API authentication","sidebarTitle":"Authentication","href":"/reference/api/assistant/authentication"},{"title":"Pinecone Assistant limits","sidebarTitle":"Limits","href":"/reference/api/assistant/assistant-limits"}]},{"group":"Assistants","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/assistant_control_2026-07.oas.yaml GET /assistants","title":"List assistants","href":"/reference/api/2026-07/assistant/list_assistants"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/assistant_control_2026-07.oas.yaml POST /assistants","title":"Create an assistant","href":"/reference/api/2026-07/assistant/create_assistant"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/assistant_control_2026-07.oas.yaml GET /assistants/{assistant_name}","title":"Check assistant status","href":"/reference/api/2026-07/assistant/describe_assistant"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/assistant_control_2026-07.oas.yaml PATCH /assistants/{assistant_name}","title":"Update an assistant","href":"/reference/api/2026-07/assistant/update_assistant"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/assistant_control_2026-07.oas.yaml DELETE /assistants/{assistant_name}","title":"Delete an assistant","href":"/reference/api/2026-07/assistant/delete_assistant"}]},{"group":"Files","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/assistant_data_2026-07.oas.yaml GET /files/{assistant_name}","title":"List Files","href":"/reference/api/2026-07/assistant/list_files"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/assistant_data_2026-07.oas.yaml POST /files/{assistant_name}","title":"Upload a file","href":"/reference/api/2026-07/assistant/upload_file"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/assistant_data_2026-07.oas.yaml PUT /files/{assistant_name}/{assistant_file_id}","title":"Upsert a file","href":"/reference/api/2026-07/assistant/upsert_file"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/assistant_data_2026-07.oas.yaml GET /files/{assistant_name}/{assistant_file_id}","title":"Describe a file","href":"/reference/api/2026-07/assistant/describe_file"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/assistant_data_2026-07.oas.yaml DELETE /files/{assistant_name}/{assistant_file_id}","title":"Delete a file","href":"/reference/api/2026-07/assistant/delete_file"}]},{"group":"Operations","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/assistant_data_2026-07.oas.yaml GET /operations/{assistant_name}","title":"List operations","href":"/reference/api/2026-07/assistant/list_operations"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/assistant_data_2026-07.oas.yaml GET /operations/{assistant_name}/{operation_id}","title":"Describe an operation","href":"/reference/api/2026-07/assistant/describe_operation"}]},{"group":"Chat","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/assistant_data_2026-07.oas.yaml POST /chat/{assistant_name}","title":"Chat with an assistant","href":"/reference/api/2026-07/assistant/chat_assistant"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/assistant_data_2026-07.oas.yaml POST /chat/{assistant_name}/chat/completions","title":"Chat through an OpenAI-compatible interface","href":"/reference/api/2026-07/assistant/chat_completion_assistant"}]},{"group":"Evaluation","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/assistant_evaluation_2026-07.oas.yaml POST /evaluation/metrics/alignment","title":"Evaluate an answer","href":"/reference/api/2026-07/assistant/metrics_alignment"}]},{"group":"Context snippets","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/assistant_data_2026-07.oas.yaml POST /chat/{assistant_name}/context","title":"Retrieve context from an assistant","href":"/reference/api/2026-07/assistant/context_assistant"}]},{"group":"Admin","pages":[{"group":"API keys","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml post /admin/projects/{project_id}/api-keys","title":"Create an API key","href":"/reference/api/2026-04/admin-assistant/create_api_key"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml get /admin/projects/{project_id}/api-keys","title":"List API keys","href":"/reference/api/2026-04/admin-assistant/list_api_keys"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml get /admin/api-keys/{api_key_id}","title":"Get API key details","href":"/reference/api/2026-04/admin-assistant/fetch_api_key"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml patch /admin/api-keys/{api_key_id}","title":"Update an API key","href":"/reference/api/2026-04/admin-assistant/update_api_key"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml delete /admin/api-keys/{api_key_id}","title":"Delete an API key","href":"/reference/api/2026-04/admin-assistant/delete_api_key"}]},{"group":"Projects","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml post /admin/projects","title":"Create a new project","href":"/reference/api/2026-04/admin-assistant/create_project"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml get /admin/projects","title":"List projects","href":"/reference/api/2026-04/admin-assistant/list_projects"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml get /admin/projects/{project_id}","title":"Get project details","href":"/reference/api/2026-04/admin-assistant/fetch_project"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml patch /admin/projects/{project_id}","title":"Update a project","href":"/reference/api/2026-04/admin-assistant/update_project"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml delete /admin/projects/{project_id}","title":"Delete a project","href":"/reference/api/2026-04/admin-assistant/delete_project"}]},{"group":"Service accounts","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/oauth_2026-04.oas.yaml post /oauth/token","title":"Create an access token","href":"/reference/api/2026-04/admin-assistant/get_token"}]}]},{"group":"Architecture","pages":[{"title":"Pinecone Assistant architecture","sidebarTitle":"Assistant architecture","href":"/reference/architecture/assistant-architecture"}]}]},{"version":"2026-04","pages":[{"title":"2026-04","href":"/reference/api/assistant/introduction"}]},{"version":"2025-10","pages":[{"title":"2025-10","href":"/reference/api/assistant/introduction"}]},{"version":"2025-04","pages":[{"title":"2025-04","href":"/reference/api/assistant/introduction"}]},{"version":"2025-01","pages":[{"title":"2025-01","href":"/reference/api/assistant/introduction"}]}]},{"tab":"Examples","pages":[{"title":"Assistant examples","href":"/examples/assistant"}]}]},{"dropdown":"Pinecone Nexus","icon":"brain-circuit","tabs":[{"tab":"Guides","groups":[{"group":"Get started","pages":[{"title":"Pinecone Nexus","sidebarTitle":"Overview","mode":"wide","href":"/guides/nexus/overview"},{"title":"Nexus quickstart","sidebarTitle":"Quickstart","href":"/guides/nexus/quickstart"},{"title":"Nexus key concepts","sidebarTitle":"Key concepts","href":"/guides/nexus/concepts"}]},{"group":"The knowledge engine","pages":[{"title":"How Nexus works","sidebarTitle":"How Nexus works","href":"/guides/nexus/how-it-works"},{"group":"Context design","pages":[{"title":"Context design overview","sidebarTitle":"Overview","href":"/guides/nexus/context-design"},{"title":"Design your own manifest","sidebarTitle":"Design your own manifest","href":"/guides/nexus/design-your-own-manifest"},{"title":"Configure artifact formats","sidebarTitle":"Configure artifact formats","href":"/guides/nexus/configure-artifact-formats"}]},{"title":"Nexus curation","sidebarTitle":"Curation","href":"/guides/nexus/how-curation-works"},{"title":"Nexus model guidance","href":"/guides/nexus/models"},{"group":"Queries and sessions","pages":[{"title":"Nexus queries","sidebarTitle":"Queries","href":"/guides/nexus/queries"},{"title":"Set session instructions","sidebarTitle":"Set session instructions","href":"/guides/nexus/set-session-instructions"},{"title":"Query tracing","sidebarTitle":"Query tracing","href":"/guides/nexus/query-tracing"}]}]},{"group":"Tools","pages":[{"title":"Pinecone Nexus MCP server","sidebarTitle":"MCP server","href":"/guides/nexus/mcp-server"}]},{"group":"Bring Your Own Cloud","pages":[{"title":"Nexus BYOC overview","sidebarTitle":"Overview","href":"/guides/nexus/byoc/overview"},{"title":"Nexus BYOC data residency and limits","sidebarTitle":"Residency and limits","href":"/guides/nexus/byoc/reference"},{"title":"Deploy Nexus BYOC","sidebarTitle":"Deploy","href":"/guides/nexus/byoc/deploy"},{"group":"Fireworks AI","pages":[{"title":"Fireworks AI with Nexus BYOC","sidebarTitle":"Overview","href":"/guides/nexus/byoc/fireworks/overview"},{"title":"Use Fireworks AI models in Nexus BYOC","sidebarTitle":"Use Fireworks models","href":"/guides/nexus/byoc/fireworks/use-models"},{"title":"Fireworks AI reference for Nexus BYOC","sidebarTitle":"Reference","href":"/guides/nexus/byoc/fireworks/reference"}]}]}]},{"tab":"Reference","groups":[{"group":"APIs","pages":[{"title":"Pinecone Nexus API","sidebarTitle":"Introduction","href":"/reference/api/nexus/introduction"},{"title":"Pinecone Nexus API authentication","sidebarTitle":"Authentication","href":"/reference/api/nexus/authentication"}]},{"group":"Control plane","pages":[{"group":"Manage Workspaces","pages":[{"title":"List workspaces","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_control_2026-07.oas.yaml get /workspaces","href":"/api-reference/manage-workspaces/list-workspaces"},{"title":"Create a workspace","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_control_2026-07.oas.yaml post /workspaces","href":"/api-reference/manage-workspaces/create-a-workspace"},{"title":"Describe a workspace","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_control_2026-07.oas.yaml get /workspaces/{workspace_name}","href":"/api-reference/manage-workspaces/describe-a-workspace"},{"title":"Delete a workspace","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_control_2026-07.oas.yaml delete /workspaces/{workspace_name}","href":"/api-reference/manage-workspaces/delete-a-workspace"}]}]},{"group":"Data plane","pages":[{"group":"Auth","pages":[{"title":"Exchange a Pinecone API key for a session token","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml post /auth/login","href":"/api-reference/auth/exchange-a-pinecone-api-key-for-a-session-token"},{"title":"Current identity (whoami)","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /auth","href":"/api-reference/auth/current-identity-whoami"}]},{"group":"Project","pages":[{"title":"Get the active project","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /project","href":"/api-reference/project/get-the-active-project"},{"title":"Project-wide task stats","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /stats","href":"/api-reference/project/project-wide-task-stats"}]},{"group":"Connectors","pages":[{"title":"List the project's linked connectors","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /connectors","href":"/api-reference/connectors/list-the-projects-linked-connectors"},{"title":"Get a connector","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /connectors/{id}","href":"/api-reference/connectors/get-a-connector"},{"title":"Unlink a connector","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml delete /connectors/{id}","href":"/api-reference/connectors/unlink-a-connector"},{"title":"Start the OAuth link flow for a provider","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /connectors/oauth/{provider}/start","href":"/api-reference/connectors/start-the-oauth-link-flow-for-a-provider"},{"title":"Link a connector with an API key","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml post /connectors/keys/{provider}","href":"/api-reference/connectors/link-a-connector-with-an-api-key"},{"title":"Browse a connector's folders/files","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /connectors/{id}/items","href":"/api-reference/connectors/browse-a-connectors-foldersfiles"},{"title":"List a context's connectors (with per-context enabled flag)","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /contexts/{slug}/connectors","href":"/api-reference/connectors/list-a-contexts-connectors-with-per-context-enabled-flag"},{"title":"Enable or disable a connector for a context","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml put /contexts/{slug}/connectors/{connector_id}","href":"/api-reference/connectors/enable-or-disable-a-connector-for-a-context"}]},{"group":"Contexts","pages":[{"title":"List contexts (newest first, with stats)","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /contexts","href":"/api-reference/contexts/list-contexts-newest-first-with-stats"},{"title":"Create a context","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml post /contexts","href":"/api-reference/contexts/create-a-context"},{"title":"Get a context","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /contexts/{slug}","href":"/api-reference/contexts/get-a-context"},{"title":"Update a context","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml put /contexts/{slug}","href":"/api-reference/contexts/update-a-context"},{"title":"Delete a context (and its Pinecone indexes)","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml delete /contexts/{slug}","href":"/api-reference/contexts/delete-a-context-and-its-pinecone-indexes"},{"title":"Per-context task statistics","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /contexts/{slug}/tasks/stats","href":"/api-reference/contexts/per-context-task-statistics"},{"title":"Trigger an on-demand self-tuning optimize","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml post /contexts/{slug}/optimize","href":"/api-reference/contexts/trigger-an-on-demand-self-tuning-optimize"},{"title":"Run the Design-flow explore agent (propose a manifest)","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml post /contexts/{slug}/explore","href":"/api-reference/contexts/run-the-design-flow-explore-agent-propose-a-manifest"},{"title":"Estimate the token + time cost of curating the in-progress manifest","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml post /contexts/{slug}/profile","href":"/api-reference/contexts/estimate-the-token-+-time-cost-of-curating-the-in-progress-manifest"}]},{"group":"Manifest","pages":[{"title":"Get the context's manifest","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /contexts/{slug}/manifest","href":"/api-reference/manifest/get-the-contexts-manifest"},{"title":"List the built-in manifest templates","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /manifest/templates","href":"/api-reference/manifest/list-the-built-in-manifest-templates"}]},{"group":"Curation","pages":[{"title":"Get the curation ledger","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /contexts/{slug}/curate","href":"/api-reference/curation/get-the-curation-ledger"},{"title":"Build or rebuild the context's index from its sources","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml post /contexts/{slug}/curate","href":"/api-reference/curation/build-or-rebuild-the-contexts-index-from-its-sources"},{"title":"Drop named sources from the index + ledger","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml post /contexts/{slug}/curate/delete-sources","href":"/api-reference/curation/drop-named-sources-from-the-index-+-ledger"}]},{"group":"Source Files","pages":[{"title":"Import source documents from a project connector","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml post /contexts/{slug}/import","href":"/api-reference/source-files/import-source-documents-from-a-project-connector"},{"title":"Upload a source file or archive","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml post /contexts/{slug}/import/upload","href":"/api-reference/source-files/upload-a-source-file-or-archive"},{"title":"List the source file tree (root)","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /contexts/{slug}/source/list","href":"/api-reference/source-files/list-the-source-file-tree-root"},{"title":"Source file/dir/size counts","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /contexts/{slug}/source/stats","href":"/api-reference/source-files/source-filedirsize-counts"},{"title":"Flat manifest of source files (path, size, last_modified)","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /contexts/{slug}/source/manifest","href":"/api-reference/source-files/flat-manifest-of-source-files-path-size-last_modified"},{"title":"List the source file tree under a path","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /contexts/{slug}/source/list/{path}","href":"/api-reference/source-files/list-the-source-file-tree-under-a-path"},{"title":"Read a source file (raw bytes)","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /contexts/{slug}/source/read/{path}","href":"/api-reference/source-files/read-a-source-file-raw-bytes"},{"title":"Delete a source file","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml delete /contexts/{slug}/source/delete/{path}","href":"/api-reference/source-files/delete-a-source-file"}]},{"group":"Knowledge","pages":[{"title":"List curated knowledge (root)","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /contexts/{slug}/knowledge/list","href":"/api-reference/knowledge/list-curated-knowledge-root"},{"title":"Knowledge file/dir/size counts","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /contexts/{slug}/knowledge/stats","href":"/api-reference/knowledge/knowledge-filedirsize-counts"},{"title":"List curated knowledge under a path","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /contexts/{slug}/knowledge/list/{path}","href":"/api-reference/knowledge/list-curated-knowledge-under-a-path"},{"title":"Read a curated knowledge file (raw bytes)","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /contexts/{slug}/knowledge/read/{path}","href":"/api-reference/knowledge/read-a-curated-knowledge-file-raw-bytes"}]},{"group":"Query","pages":[{"title":"Run one KnowQL query turn","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml post /query","href":"/api-reference/query/run-one-knowql-query-turn"},{"title":"Fetch one query (turn)","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /queries/{id}","href":"/api-reference/query/fetch-one-query-turn"},{"title":"Cancel an in-progress query turn","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml post /queries/{id}/cancel","href":"/api-reference/query/cancel-an-in-progress-query-turn"},{"title":"Fetch the recorded trace for a query turn","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /queries/{id}/trace","href":"/api-reference/query/fetch-the-recorded-trace-for-a-query-turn"},{"title":"Stream a query turn's events (SSE)","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /queries/{id}/events","href":"/api-reference/query/stream-a-query-turns-events-sse"},{"title":"Record thumbs-up/down feedback on a query turn","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml post /queries/{id}/feedback","href":"/api-reference/query/record-thumbs-updown-feedback-on-a-query-turn"},{"title":"List the selectable query models","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /models","href":"/api-reference/query/list-the-selectable-query-models"},{"title":"List project-wide query sessions (newest first)","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /sessions","href":"/api-reference/query/list-project-wide-query-sessions-newest-first"},{"title":"Get a session with its queries (conversation order)","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /sessions/{id}","href":"/api-reference/query/get-a-session-with-its-queries-conversation-order"},{"title":"Delete a session and its queries","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml delete /sessions/{id}","href":"/api-reference/query/delete-a-session-and-its-queries"}]},{"group":"Tasks","pages":[{"title":"List tasks (project-wide, paginated)","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /tasks","href":"/api-reference/tasks/list-tasks-project-wide-paginated"},{"title":"Get a task (with steps)","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /tasks/{id}","href":"/api-reference/tasks/get-a-task-with-steps"},{"title":"Cancel/terminate a task","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml delete /tasks/{id}","href":"/api-reference/tasks/cancelterminate-a-task"}]},{"group":"Task Files","pages":[{"title":"Read a task file (raw bytes)","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /tasks/{id}/files/read/{path}","href":"/api-reference/task-files/read-a-task-file-raw-bytes"},{"title":"Stat a task file","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /tasks/{id}/files/metadata/{path}","href":"/api-reference/task-files/stat-a-task-file"},{"title":"List a task's files under a path","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /tasks/{id}/files/list/{path}","href":"/api-reference/task-files/list-a-tasks-files-under-a-path"},{"title":"List a task's working-directory files","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml get /tasks/{id}/files/list","href":"/api-reference/task-files/list-a-tasks-working-directory-files"},{"title":"Delete a task file","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml delete /tasks/{id}/files/delete/{path}","href":"/api-reference/task-files/delete-a-task-file"}]}]}]}]},{"dropdown":"pg_pinecone","icon":"elephant","tabs":[{"tab":"Guides","groups":[{"group":"Get started","pages":[{"title":"pg_pinecone","sidebarTitle":"Overview","href":"/guides/pg-pinecone/overview"},{"title":"pg_pinecone quickstart","sidebarTitle":"Quickstart","href":"/guides/pg-pinecone/quickstart"}]},{"group":"Build","pages":[{"title":"pg_pinecone storage engines","sidebarTitle":"Storage engines","href":"/guides/pg-pinecone/storage-engines"},{"title":"Switch from pgvector to native","href":"/guides/pg-pinecone/switch-from-pgvector"},{"title":"Switch from native to remote","href":"/guides/pg-pinecone/switch-to-remote"},{"title":"Search a table with full-text search","href":"/guides/pg-pinecone/full-text-search"},{"title":"Migrate from pgvector","url":"https://docs.pinecone.io/guides/index-data/migrate-from-pgvector","href":"/guides/pg-pinecone/migrate-from-pgvector"}]},{"group":"Resources","pages":[{"title":"pg_pinecone SQL reference","sidebarTitle":"SQL reference","url":"https://github.com/pinecone-io/pg_pinecone/blob/main/docs/reference.md","href":"/reference/pg-pinecone/sql-reference"},{"title":"pg_pinecone operator runbook","sidebarTitle":"Operator runbook","url":"https://github.com/pinecone-io/pg_pinecone/blob/main/docs/runbook.md","href":"/reference/pg-pinecone/operator-runbook"},{"title":"pg_pinecone support","sidebarTitle":"Support","href":"/guides/pg-pinecone/support"}]}]}]},{"dropdown":"Changelog","icon":"list","pages":[{"title":"Pinecone 2026 changelog","sidebarTitle":"2026","mode":"wide","href":"/release-notes/2026"},{"title":"Pinecone 2025 changelog","sidebarTitle":"2025","mode":"wide","href":"/release-notes/2025"},{"title":"Pinecone 2024 changelog","sidebarTitle":"2024","mode":"wide","href":"/release-notes/2024"},{"title":"Pinecone 2023 changelog","sidebarTitle":"2023","mode":"wide","href":"/release-notes/2023"},{"title":"Pinecone 2022 changelog","sidebarTitle":"2022","mode":"wide","href":"/release-notes/2022"},{"title":"Pinecone feature availability","sidebarTitle":"Feature availability","mode":"wide","href":"/release-notes/feature-availability"}]}]},"basePath":"","title":"Convert an index into a document index - Pinecone Docs","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DCDCdBVX.js","utils-ME8dDnLe.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-0e84ACsd.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-wgRBj-ia.js","snippetPresets-C11Sgb-o.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-C0lapOpP.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-ZeRQV8fF.js","shallow-BupWh095.js","getApiPlaygroundDisplay-BnYQO2Ss.js","CodeSnippet-RKKOc8c_.js","CodeSnippets-Drf_m8wS.js","Page-Bevw23-4.js","getPastedJson-u6QiPzNZ.js","icon-Bb-CBSxO.js","MethodPill-F7l5AI7V.js","DuplicateIcon-IiAXkdSg.js","createIcon-FliI8EBc.js","DynamicMarkdown-B62XqCSI.js","SectionHeading-Dj31pT03.js","axios-vUo_bRtp.js","Markdown-BOgQCTwD.js","clsx-BIWXJmsZ.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DKZWslLH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-UDqbR6xh.js"]}