PINECONE_API_KEY="YOUR_API_KEY"ASSISTANT_NAME="example-assistant"curl "https://prod-1-data.ke.pinecone.io/assistant/chat/$ASSISTANT_NAME" \ -H "Api-Key: $PINECONE_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "messages": [ { "role": "user", "content": "What is the inciting incident of Pride and Prejudice?" } ], "stream": false, "model": "gpt-4o"}'
PINECONE_API_KEY="YOUR_API_KEY"ASSISTANT_NAME="example-assistant"curl "https://prod-1-data.ke.pinecone.io/assistant/chat/$ASSISTANT_NAME" \ -H "Api-Key: $PINECONE_API_KEY" \ -H "Content-Type: application/json" \ -H "X-Pinecone-Api-Version: 2026-04" \ -d '{ "messages": [ { "role": "user", "content": "What is the inciting incident of Pride and Prejudice?" } ], "stream": true, "model": "gpt-4o"}'
{ "finish_reason": "stop", "message": { "role": "assistant", "content": "The inciting incident of \"Pride and Prejudice\" occurs when Mrs. Bennet informs Mr. Bennet that Netherfield Park has been let at last, and she is eager to share the news about the new tenant, Mr. Bingley, who is wealthy and single. This sets the stage for the subsequent events of the story, including the introduction of Mr. Bingley and Mr. Darcy to the Bennet family and the ensuing romantic entanglements." }, "id": "00000000000000004ac3add5961aa757", "model": "gpt-4o-2024-05-13", "usage": { "prompt_tokens": 9736, "completion_tokens": 105, "total_tokens": 9841 }, "citations": [ { "position": 406, "references": [ { "file": { "status": "Available", "id": "ae79e447-b89e-4994-994b-3232ca52a654", "name": "Pride-and-Prejudice.pdf", "size": 2973077, "metadata": null, "updated_on": "2024-06-14T15:01:57.385425746Z", "created_on": "2024-06-14T15:01:02.910452398Z", "signed_url": "https://storage.googleapis.com/..." }, "pages": [ 1 ] } ] } ]}
Chat with an assistant and get back citations in structured form.
This is the recommended way to chat with an assistant, as it offers more functionality and control over the assistant’s responses and references than the OpenAI-compatible chat interface.
PINECONE_API_KEY="YOUR_API_KEY"ASSISTANT_NAME="example-assistant"curl "https://prod-1-data.ke.pinecone.io/assistant/chat/$ASSISTANT_NAME" \ -H "Api-Key: $PINECONE_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "messages": [ { "role": "user", "content": "What is the inciting incident of Pride and Prejudice?" } ], "stream": false, "model": "gpt-4o"}'
PINECONE_API_KEY="YOUR_API_KEY"ASSISTANT_NAME="example-assistant"curl "https://prod-1-data.ke.pinecone.io/assistant/chat/$ASSISTANT_NAME" \ -H "Api-Key: $PINECONE_API_KEY" \ -H "Content-Type: application/json" \ -H "X-Pinecone-Api-Version: 2026-04" \ -d '{ "messages": [ { "role": "user", "content": "What is the inciting incident of Pride and Prejudice?" } ], "stream": true, "model": "gpt-4o"}'
{ "finish_reason": "stop", "message": { "role": "assistant", "content": "The inciting incident of \"Pride and Prejudice\" occurs when Mrs. Bennet informs Mr. Bennet that Netherfield Park has been let at last, and she is eager to share the news about the new tenant, Mr. Bingley, who is wealthy and single. This sets the stage for the subsequent events of the story, including the introduction of Mr. Bingley and Mr. Darcy to the Bennet family and the ensuing romantic entanglements." }, "id": "00000000000000004ac3add5961aa757", "model": "gpt-4o-2024-05-13", "usage": { "prompt_tokens": 9736, "completion_tokens": 105, "total_tokens": 9841 }, "citations": [ { "position": 406, "references": [ { "file": { "status": "Available", "id": "ae79e447-b89e-4994-994b-3232ca52a654", "name": "Pride-and-Prejudice.pdf", "size": 2973077, "metadata": null, "updated_on": "2024-06-14T15:01:57.385425746Z", "created_on": "2024-06-14T15:01:02.910452398Z", "signed_url": "https://storage.googleapis.com/..." }, "pages": [ 1 ] } ] } ]}
PINECONE_API_KEY="YOUR_API_KEY"ASSISTANT_NAME="example-assistant"curl "https://prod-1-data.ke.pinecone.io/assistant/chat/$ASSISTANT_NAME" \ -H "Api-Key: $PINECONE_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "messages": [ { "role": "user", "content": "What is the inciting incident of Pride and Prejudice?" } ], "stream": false, "model": "gpt-4o"}'
PINECONE_API_KEY="YOUR_API_KEY"ASSISTANT_NAME="example-assistant"curl "https://prod-1-data.ke.pinecone.io/assistant/chat/$ASSISTANT_NAME" \ -H "Api-Key: $PINECONE_API_KEY" \ -H "Content-Type: application/json" \ -H "X-Pinecone-Api-Version: 2026-04" \ -d '{ "messages": [ { "role": "user", "content": "What is the inciting incident of Pride and Prejudice?" } ], "stream": true, "model": "gpt-4o"}'
{ "finish_reason": "stop", "message": { "role": "assistant", "content": "The inciting incident of \"Pride and Prejudice\" occurs when Mrs. Bennet informs Mr. Bennet that Netherfield Park has been let at last, and she is eager to share the news about the new tenant, Mr. Bingley, who is wealthy and single. This sets the stage for the subsequent events of the story, including the introduction of Mr. Bingley and Mr. Darcy to the Bennet family and the ensuing romantic entanglements." }, "id": "00000000000000004ac3add5961aa757", "model": "gpt-4o-2024-05-13", "usage": { "prompt_tokens": 9736, "completion_tokens": 105, "total_tokens": 9841 }, "citations": [ { "position": 406, "references": [ { "file": { "status": "Available", "id": "ae79e447-b89e-4994-994b-3232ca52a654", "name": "Pride-and-Prejudice.pdf", "size": 2973077, "metadata": null, "updated_on": "2024-06-14T15:01:57.385425746Z", "created_on": "2024-06-14T15:01:02.910452398Z", "signed_url": "https://storage.googleapis.com/..." }, "pages": [ 1 ] } ] } ]}
Controls the randomness of the model's output: lower values make responses more deterministic, while higher values increase creativity and variability. If the model does not support a temperature parameter, the parameter will be ignored.
Indicates why the chat response generation stopped. This signals the end of the response.
stop: The model finished generating the response.
length: Generation was cut off because the maximum number of tokens allowed was reached.
content_filter: Generation stopped because content was blocked by content filtering rules.
(for example, content that contains hate speech or violent material).
tool_calls: Generation stopped because a tool call was triggered.
The number of context snippets provided to the model to generate the response. This indicates how much retrieved information was available for the generation, allowing for logic to be applied if no context was found (count is 0).
Content filter results provided by the LLM, describing safety-related classifications applied to the content. The structure may vary depending on the model and the content being filtered. The spec field identifies the provider, and determines the structure of results.
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Pinecone Docs","description":"Official documentation for Pinecone's trusted AI knowledge platform, including Pinecone Database, Pinecone Assistant, and Pinecone Nexus.","colors":{"primary":"#002BFF","light":"#1E86EE","dark":"#002BFF"},"logo":{"light":"https://mintcdn.com/pinecone/HsZKO51bNmpAasdT/logo/Pinecone-Full-Logo-Black.svg?fit=max\u0026auto=format\u0026n=HsZKO51bNmpAasdT\u0026q=85\u0026s=211d0e7bbefc29ce3b8feee1a05d76ee","dark":"https://mintcdn.com/pinecone/HsZKO51bNmpAasdT/logo/Pinecone-Full-Logo-White.svg?fit=max\u0026auto=format\u0026n=HsZKO51bNmpAasdT\u0026q=85\u0026s=4839c7a50a8bee830e943705c648297c","href":"https://www.pinecone.io"},"favicon":"https://mintcdn.com/pinecone/9qvQp5nU6duJvusQ/favicon-512.png?fit=max\u0026auto=format\u0026n=9qvQp5nU6duJvusQ\u0026q=85\u0026s=a05db290834f742b6b4b5d30a8d74e90","api":{"openapi":["https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_control_2026-07.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/nexus_data_2026-07.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_control_2026-07.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/db_data_2026-07.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/admin_2026-07.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/inference_2026-07.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/assistant_control_2026-07.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/assistant_data_2026-07.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-07/assistant_evaluation_2026-07.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-01.alpha/db_control_2026-01.alpha.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-01.alpha/db_data_2026-01.alpha.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/assistant_control_2026-04.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/assistant_data_2026-04.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/assistant_evaluation_2026-04.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/oauth_2026-04.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_control_2026-04.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_data_2026-04.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/inference_2026-04.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/admin_2025-10.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/oauth_2025-10.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/assistant_control_2025-10.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/assistant_data_2025-10.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/assistant_evaluation_2025-10.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/db_control_2025-10.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/db_data_2025-10.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-10/inference_2025-10.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/admin_2025-04.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/oauth_2025-04.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/assistant_control_2025-04.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/assistant_data_2025-04.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/assistant_evaluation_2025-04.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/db_control_2025-04.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/db_data_2025-04.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/inference_2025-04.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-01/assistant_control_2025-01.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-01/assistant_data_2025-01.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-01/assistant_evaluation_2025-01.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-01/db_control_2025-01.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-01/db_data_2025-01.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-01/inference_2025-01.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-10/db_control_2024-10.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-10/db_data_2024-10.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-10/inference_2024-10.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-07/control_2024-07.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-07/data_2024-07.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-04/control_2024-04.oas.yaml","https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2024-04/data_2024-04.oas.yaml"],"playground":{"display":"simple"}},"appearance":{"default":"system","strict":false},"background":{"color":{"light":"#FBFBFC","dark":"#171717"}},"navbar":{"links":[{"href":"/guides/get-started/overview","label":"Docs"},{"href":"https://status.pinecone.io","label":"Status"},{"href":"https://app.pinecone.io/organizations/-/settings/support","label":"Support"},{"href":"https://app.pinecone.io/?sessionType=login","label":"Log in"}],"primary":{"type":"button","label":"Sign up free","href":"https://app.pinecone.io/?sessionType=signup"}},"footer":{"socials":{"x":"https://x.com/pinecone?ref_src=twsrc%5Egoogle%7Ctwcamp%5Eserp%7Ctwgr%5Eauthor","linkedin":"https://www.linkedin.com/company/pinecone-io","youtube":"https://www.youtube.com/@pinecone-io","github":"https://github.com/pinecone-io"}},"seo":{"metatags":{"og:image":"https://www.pinecone.io/images/docs_og_image_v2.png","twitter:title":"Documentation for the trusted AI knowledge platform | Pinecone","twitter:description":"Guides, API references, and examples for building with Pinecone Database, Pinecone Assistant, and Pinecone Nexus.","twitter:site":"@pinecone","twitter:image":"https://www.pinecone.io/images/docs_og_image_v2.png","google-site-verification":"woTBImNAcYO-gseVfFKIzQrDRUmLWzFjBWrYbYkOTlI"},"indexing":"all"},"integrations":{"gtm":{"tagId":"GTM-5RCSPVG"},"heap":{"appId":"3879495182"}},"banner":{"content":"🎉 Limited-time promotion: Double the embedding tokens on every model for Starter and Builder plans through December 31. [See your new limits](/reference/api/database-limits/rate-limits#monthly-usage-limits)","dismissible":true,"color":{"light":"#002BFF","dark":"#002BFF"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"pinecone","hasAudioNarration":false,"actualSubdomain":"pinecone","customDomains":["docs.pinecone.io"],"gitSource":{"type":"github","owner":"pinecone-io","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"feedback":{"thumbs":true,"issues":false,"edits":false},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aeecaebbe4829dd4e3ac884","clientVersion":"0.0.4076","searchFilterCounts":[{"language":"default","tag":"Pinecone Database","count":569},{"language":"default","tag":"Reference","count":545},{"language":"default","tag":"Database","count":244},{"language":"default","tag":"Admin","count":151},{"language":"default","tag":"Guides","count":151},{"language":"default","tag":"Pinecone Assistant","count":128},{"language":"default","tag":"Pinecone Nexus","count":81},{"language":"default","tag":"Backups","count":70},{"language":"default","tag":"Indexes","count":65},{"language":"default","tag":"Integrations","count":56}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"styles.css","content":":root{--brand-blue: #002BFF;--primary-main: #002BFF;--primary-dark: #222160;--text-contrast: #FFFFFF;--background: #FBFBFC;--paper: #FFFFFF;--surface: #F2F3F6;--divider: #D8DDDF;--secondary: #72788D;--text-primary: #1C1917;--text-body: #44403C;--text-secondary: #72788D;--border: #e7e5e4}.dark{--brand-blue: #1E86EE;--primary-main: #002BFF;--primary-dark: #222160;--text-contrast: #FFFFFF;--background: #171717;--paper: #1E1E1E;--surface: #252525;--divider: #2A2A2A;--secondary: #72788D;--text-primary: #FFFFFF;--text-body: #D4D4D4;--text-secondary: #A0A0A0;--border: #303030}.dark .dark-inverted{filter:invert(1)}#topbar-cta-button{margin-left:1rem}#topbar-cta-button>a{display:flex;align-items:center;padding:0.375rem 1rem!important;gap:0.5rem;background-color:var(--brand-blue);color:var(--text-contrast)!important;border-radius:0.25rem;font-weight:500;letter-spacing:0.4px}#topbar-cta-button a:hover{background-color:var(--primary-dark)!important}.documentation-link{color:var(--brand-blue);text-decoration:none}.documentation-link:hover{color:#000000}#navbar{background:var(--background);position:fixed}#navbar-transition{border-bottom:1px solid var(--border)}#navbar .max-w-8xl{max-width:100%}#navbar>div>div>div>div>div>div.flex-1.flex.items-center>a:first-child{min-width:209px}[aria-haspopup=\"menu\"]{border-radius:0.25rem;border:1px solid var(--border);background-color:transparent!important;color:var(--text-primary)}#navbar nav a{color:var(--text-primary);padding:0.6rem 1rem;transition:background-color 250ms cubic-bezier(0.4, 0, 0.2, 1)}#navbar nav ul li:not(:last-of-type){margin-left:0}#navbar a{color:var(--text-primary);margin:0;padding-left:0.875rem;padding-right:0.875rem}#navbar .nav-tabs{gap:0!important}#navbar div.absolute.bottom-0{display:none}#sidebar{left:0rem;padding-left:0;background:var(--background);border-right:1px solid var(--border)}#sidebar div.sticky{visibility:hidden}#sidebar-content{padding-left:0.5rem}@media (min-width: 1024px){:root{--sidebar-width: 17.5rem}div:has(>#sidebar){max-width:none;margin-left:0;padding-left:0}#navbar .lg\\:px-12{padding-left:0.625rem}#navbar div:has(>.nav-tabs){padding-left:1.5rem}#sidebar-content .sidebar-group a,#sidebar-content .sidebar-group button{padding-block:0.3125rem;line-height:1.25rem}#sidebar-content .sidebar-group-header{margin-bottom:0.5rem}#navigation-items>div:has(>.sidebar-group-header){margin-top:1.25rem}#content-container>div{justify-content:flex-end}#content-area{max-width:54rem;margin-inline:0;padding-left:3.125rem}div:has(>#sidebar[style*=\"display: none\"]){padding-inline:1.5rem}div:has(>#sidebar[style*=\"display: none\"]) #content-area{max-width:none;padding-inline:0}}@media (min-width: 1280px){#content-area:has(.sample-app-split){max-width:77.625rem}}#pc-sidebar-toggle{display:none}@media (min-width: 1024px){#pc-sidebar-toggle:not([hidden]){position:absolute;z-index:30;top:0.5625rem;right:-2rem;display:flex;align-items:center;justify-content:center;width:1.75rem;height:1.75rem;color:var(--text-secondary);cursor:pointer}#pc-sidebar-toggle:hover{color:var(--text-primary)}#pc-sidebar-toggle:focus-visible{outline:2px solid var(--brand-blue);outline-offset:2px;border-radius:0.25rem}#sidebar #navigation-items{position:relative}#sidebar-content>[data-component-part=\"scroll-area-scrollbar\"][data-orientation=\"vertical\"]{margin-top:4.5rem}#sidebar .nav-dropdown-trigger{width:calc(100% - 0.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}}#sidebar-content h5,#sidebar a,#sidebar li div{color:var(--text-primary)}#navigation-items .sidebar-group-header{color:var(--text-secondary);font-size:0.75rem;font-weight:600;letter-spacing:1px;line-height:160%;text-transform:uppercase}#navigation-items>div+div>.sidebar-group-header{padding-top:1.25rem;border-top:1px solid var(--border)}#navigation-items .sidebar-group-header:has(+.sidebar-group li[data-active=\"true\"]){color:var(--text-primary)}#navigation-items .sidebar-group li>button{flex-direction:row-reverse;justify-content:flex-end;column-gap:0.375rem;font-weight:500}#navigation-items .sidebar-group li>button>div:last-child{margin-left:-0.75rem}#navigation-items .sidebar-group li>button svg{color:var(--text-secondary)}#navigation-items .sidebar-group li>ul{position:relative}#navigation-items .sidebar-group li>ul::before{content:\"\";position:absolute;top:0;bottom:0;left:1rem;border-left:1px solid var(--border)}#table-of-contents .toc-item>ul{position:relative}#table-of-contents .toc-item>ul::before{content:\"\";position:absolute;top:0;bottom:0;left:0.25rem;border-left:1px solid var(--border)}#navigation-items>div>ul>li{margin-left:0.75rem}#navigation-items>div>ul>li a.font-semibold{font-weight:400;background-color:var(--surface)}#content-container>div{padding-top: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:0.625rem;letter-spacing:1px;line-height:160%}#header .eyebrow:empty{display:none}#header>div:first-of-type>div:nth-of-type(2){margin-top:0}#header h1{color:var(--text-primary)}.prose h2,.prose h3,.prose h4{color:var(--text-primary)}.prose p,.prose [data-as=\"p\"],.prose li{color:var(--text-body)}.prose table th,.prose table td{color:var(--text-body)!important}.prose a{color:var(--brand-blue)!important;font-weight:400}.card{box-shadow:none;border:1px solid var(--border)!important;border-radius:0.25rem;transition:box-shadow 0.3s ease;background-color:var(--paper)!important}.card:hover,.example-card:hover{box-shadow:0px 5px 5px -3px rgba(163, 169, 175, 0.20), 0px 8px 10px 1px rgba(163, 169, 175, 0.14), 0px 3px 14px 2px rgba(163, 169, 175, 0.12)!important}.dark .card:hover,.dark .example-card:hover{box-shadow:none!important}.card>div{padding:1.5rem}.card h2,.card .integration-title,.example-card h2{font-size:1.25rem}.card .integration-title{font-weight:600;line-height:1.5rem;margin-bottom:0.833rem;color:var(--text-primary)}.card p,.example-card p,.example-card span[data-as=\"p\"]{margin-top:0.625rem;font-size:0.875rem;color:var(--text-primary)}.card .integration-logo{width:3.125rem;height:3.125rem;display:flex;justify-content:center;align-items:center}.card .integration-logo-long{width:5.125rem;height:3.125rem;display:flex;justify-content:center;align-items:center}.card-grid{display:grid;gap:1.5rem}@media (min-width: 640px){.card-grid{grid-template-columns:1fr 1fr}}@media (min-width: 1024px){.card-grid{grid-template-columns:1fr 1fr 1fr}}.example-card{box-shadow:none;border:1px solid var(--border);border-radius:0.25rem;transition:box-shadow 0.3s ease;padding:1.5rem;display:flex;flex-direction:column;flex-grow:1;background-color:var(--paper)}.example-card .arrow{margin-left:auto;margin-top:auto;opacity:0;transition:opacity 0.3s ease}.example-card:hover .arrow{opacity:1}.example-card:hover{border:1px solid var(--border)!important}.example-card .tags{display:flex;flex-wrap:wrap;gap:0.75rem;margin-top:1.5rem}.example-card .card-tag{border-radius:1rem;background-color:var(--background);color:var(--text-primary);font-size:0.8125rem;line-height:138%;letter-spacing:0.16px;padding:0.1875rem 0.375rem;display:flex;gap:0.375rem;align-items:center}.examples-h2{font-size:1.25rem;margin-bottom:1.5rem}#related-articles{display:flex;flex-direction:column;width:100%}#related-articles h2{color:var(--text-primary);font-size:1.25rem;font-weight:600;letter-spacing:0.15px;line-height:150%;margin-bottom:1rem}#related-articles a{padding:1.0625rem 0;display:flex;align-items:flex-start;justify-content:space-between;gap:1rem;color:var(--text-primary);font-size:0.875rem;line-height:150%;letter-spacing:0.15px}#related-articles a:not(:last-of-type){border-bottom:1px solid var(--border)}#related-articles a:hover{opacity:0.7}#related-articles a>svg{flex-shrink:0}#back-button{display:flex;gap:0.5rem;align-items:center;color:var(--text-primary)!important;font-size:0.875rem;line-height:150%;letter-spacing:0.15px;margin-bottom:1.5rem}#back-button:hover{opacity:0.7}#back-button>svg{flex-shrink:0}.sample-app-heading{display:flex;flex-direction:column;align-items:center;text-align:center}.sample-app-heading h1{color:var(--text-primary);margin:0.5rem 0 0 0;font-size:2.125rem;font-weight:600;line-height:123.5%;letter-spacing:0.25px}.sample-app-heading p{color:var(--text-primary);margin:0.5rem 0 1.5rem 0;font-size:1.25rem;font-weight:600;line-height:150%;letter-spacing:0.15px}.sample-app-split{display:flex;flex-direction:column;gap:3rem}.sample-app-split .sidebar a:not(.connect-with-pinecone){font-size:0.875rem;color:var(--text-primary)!important;border-bottom:none}.sample-app-split .toc-list{display:flex;flex-direction:column;gap:1rem}.sample-app-split .toc-list a.bold{font-weight:700;margin-top:0.5rem}.sample-app-split .toc-list a:not(.bold,.connect-with-pinecone){position:relative;padding-left:1rem}.sample-app-split .toc-list a:not(.bold,.connect-with-pinecone)::before{content:\"\";position:absolute;top:0;bottom:0;left:0.25rem;border-left:1px solid var(--border)}.sample-app-split .toc-list a:not(.bold,.connect-with-pinecone)+a:not(.bold)::before{top:-1rem}.connect-with-pinecone{border:1px solid var(--border);border-radius:0.25rem;padding:0.5rem 1rem;display:inline-flex;align-items:center;gap:0.5rem;font-size:0.875rem;font-weight:500;line-height:1.5rem;letter-spacing:0.4px;color:var(--text-primary)!important;text-decoration:none;align-self:flex-start}@media (min-width: 1280px){.sample-app-split{flex-direction:row}.sample-app-split :is(.content,.mint-content){overflow-x:auto}.sample-app-split .sidebar{width:20.625rem;flex-shrink:0}}p>code{font-size:0.75rem;line-height:150%;letter-spacing:0.5px;border-radius:0.25rem;padding:0.125rem 0.5rem;background-color:var(--paper)!important;color:var(--text-primary)!important;border:none}code .api-key.set{color:orange}.pinecone-connect-connected{width:100%;max-width:31.25rem;background-color:var(--paper);transition:box-shadow 300ms cubic-bezier(0.4, 0, 0.2, 1) 0ms;border-radius:0.25rem;padding:1.5rem;margin:1.5rem 0;border:1px solid var(--border)}.pinecone-connect-connected img{height:1.875rem;margin:0}.pinecone-connect-connected p{color:var(--text-primary)!important}.pinecone-connect-connected p:last-of-type{margin-top:0.75rem}.remove-api-key{display:flex;width:100%;max-width:31.25rem;margin-top:-1.25rem}.remove-api-key>button{font-size:0.8125rem;font-weight:500;color:var(--brand-blue);margin-left:auto}.connect-widget-skeleton{margin-block:45px;width:100%;max-width:31.25rem;height:180px;background:var(--paper);border-radius:4px;overflow:hidden;position:relative;border:1px solid var(--border)}.skeleton-content{width:100%;max-width:450px;height:180px;background:linear-gradient(90deg,\n rgba(255, 255, 255, 0) 0%,\n rgba(255, 255, 255, 0.6) 50%,\n rgba(255, 255, 255, 0) 100%);animation:shimmer 1.5s infinite;position:absolute;top:0;left:0}@keyframes shimmer{0%{transform:translateX(-100%)}100%{transform:translateX(100%)}}.model-gallery-header{display:flex;flex-wrap:wrap;align-items:flex-end;justify-content:space-between;gap:1rem;margin-bottom:1.5rem}.model-gallery-header h1{margin:0;color:var(--text-primary);font-size:2.125rem;font-weight:700;line-height:1.25}.model-gallery-header p{margin:0.5rem 0 0;color:var(--text-secondary);font-size:1rem;line-height:1.5}.tabs:has(.model-table){position:relative}.tabs:has(.model-table)>[role=\"tablist\"]{padding-right:22rem}.model-table~[data-table-wrapper]{margin-top:0!important;padding-top:0!important}.model-tab-count{font-weight:400}.model-table-controls{position:absolute;top:0;right:0;display:flex;align-items:center;justify-content:flex-end;gap:1rem;height:2.75rem}@media (max-width: 767px){.tabs:has(.model-table)>[role=\"tablist\"]{column-gap:1rem;padding-right:0}.tabs:has(.model-table) [data-component-part=\"tab-button\"]{font-size:0.8125rem}.model-table-controls{position:static;height:auto;margin-bottom:0.75rem}.model-table-controls{flex-wrap:wrap;justify-content:flex-start;gap:0.5rem 1rem}.model-search-wrap{order:-1;flex:1 1 100%;width:auto}}.model-filter-chips{display:none}@media (max-width: 767px){.model-filter-chips{display:flex;flex-wrap:wrap;gap:0.5rem}}.model-filter-chip{display:inline-flex;align-items:center;gap:0.25rem;height:2rem;padding:0 0.625rem;border:1px solid var(--border);border-radius:4px;background:var(--paper);color:var(--text-primary);font-size:0.8125rem;white-space:nowrap;cursor:pointer}.model-filter-chip svg{color:var(--text-secondary)}.model-filter-chip.active{border-color:var(--brand-blue);color:var(--brand-blue)}.model-filter-chip:focus-visible{outline:2px solid var(--brand-blue);outline-offset:1px}.model-clear{color:var(--brand-blue);font-size:0.8125rem;white-space:nowrap;cursor:pointer}.model-clear:hover{text-decoration:underline;text-underline-offset:2px}.model-search-wrap{position:relative;display:flex;align-items:center;width:16.25rem}.model-search-wrap svg{position:absolute;left:0.625rem;color:var(--text-secondary);pointer-events:none}.model-search{width:100%;height:2rem;padding:0 0.625rem 0 2rem;border:1px solid var(--border);border-radius:4px;background:var(--paper);color:var(--text-primary);font-size:0.8125rem}.model-search::placeholder{color:var(--text-secondary)}.model-search:focus{outline:none;border-color:var(--brand-blue);box-shadow:inset 0 0 0 1px var(--brand-blue)}.model-filter-button{display:inline-flex;align-items:center;justify-content:center;width:1.5rem;height:1.5rem;margin-left:0.125rem;border-radius:4px;color:var(--text-secondary);opacity:0.7;vertical-align:middle;cursor:pointer}.model-filter-button:hover,.model-filter-button[aria-expanded=\"true\"]{background:rgb(115 143 171 / 0.12);opacity:1}.model-filter-button.active{color:var(--brand-blue);opacity:1}.model-filter-button:focus-visible,.model-clear:focus-visible,.model-filter-menu input:focus-visible{outline:2px solid var(--brand-blue);outline-offset:1px}.model-filter-count{display:inline-block;min-width:0.5rem;color:var(--brand-blue);font-size:0.6875rem;font-weight:500}.model-filter-menu{position:fixed;z-index:50;min-width:12.5rem;padding:0.375rem 0;border:1px solid var(--border);border-radius:4px;background:var(--paper);box-shadow:0 8px 10px -5px rgb(18 17 66 / 0.12), 0 16px 24px 2px rgb(18 17 66 / 0.09), 0 6px 30px 5px rgb(18 17 66 / 0.07)}.model-filter-menu label{display:flex;align-items:center;gap:0.625rem;padding:0.5rem 0.875rem;color:var(--text-primary);font-size:0.875rem;white-space:nowrap;cursor:pointer}.model-filter-menu label:hover{background:rgb(60 114 255 / 0.06)}.model-filter-menu input{width:1rem;height:1rem;margin:0;accent-color:var(--brand-blue)}.model-filter-menu svg{color:var(--text-secondary)}table.model-table-ready{border:1px solid var(--border);border-radius:6px;border-collapse:separate;border-spacing:0;overflow:clip;background:var(--paper);font-size:0.875rem}.model-table-ready th,.model-table-ready td{min-width:0!important}.model-table-ready .model-col-folded{display:none}.model-table-ready thead th{height:3rem;padding:0 0.75rem!important;background:var(--paper);color:var(--text-secondary);font-size:0.875rem;font-weight:400;text-align:left;vertical-align:middle;white-space:nowrap}.model-table-ready thead th a{border-bottom:none!important;color:inherit!important;font-weight:inherit;text-decoration:none}.model-table-ready thead th a::after{content:\"\";display:inline-block;width:0.75em;height:0.75em;margin-left:0.25em;background-color:currentColor;mask:url(\"data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 12 12' fill='none' stroke='black' stroke-width='1.5' stroke-linecap='round' stroke-linejoin='round'%3E%3Cpath d='M4 3h5v5M9 3L3 9'/%3E%3C/svg%3E\") no-repeat center / contain;vertical-align:-0.05em}.model-table-ready thead th a:hover{color:var(--brand-blue)!important}.model-table-ready tbody td{padding:0.75rem!important;border-top:1px solid var(--border);color:var(--text-secondary);vertical-align:middle}.model-table-ready tbody td code{padding:0;border:0;background:none;color:inherit;font-size:0.75rem;white-space:nowrap}.model-table-ready tbody tr:hover td{background:rgb(60 114 255 / 0.04)}.model-cell{display:flex;align-items:center;gap:0.625rem;white-space:nowrap}.model-table-ready tbody td:first-child a{border-bottom:none!important;color:var(--brand-blue)!important;font-family:paperMono, ui-monospace, SFMono-Regular, Menlo, monospace;font-size:0.8125rem;font-weight:500;text-decoration:none}.model-table-ready tbody td:first-child a:hover{text-decoration:underline;text-underline-offset:2px}.model-table-ready tbody td:last-child{text-align:right;white-space:nowrap}.model-table-ready tbody td:last-child a{border-bottom:none!important;color:var(--brand-blue);font-size:0.8125rem;font-weight:500;text-decoration:none}.model-table-ready tbody td:last-child a:hover{text-decoration:underline;text-underline-offset:2px}.model-table-ready tbody td:nth-child(3){white-space:nowrap}.model-table-ready tbody tr.model-table-empty td{padding:2rem 1rem!important;color:var(--text-secondary);text-align:center}.model-table-ready tbody tr.model-table-empty:hover td{background:none}.model-logo{display:flex;flex:0 0 auto;align-items:center;justify-content:center;width:1.5rem;height:1.5rem}.model-logo img{width:1.375rem;height:1.375rem;margin:0!important;border-radius:4px;object-fit:contain}.model-name{display:flex;flex-direction:column}.model-name-line{display:flex;align-items:center;gap:0.5rem}.model-company-name{color:var(--text-secondary);font-size:0.75rem;line-height:1.125rem}.model-plan-badge{padding:0 0.375rem;border:1px solid var(--border);border-radius:4px;color:var(--text-secondary);font-size:0.625rem;line-height:1rem;white-space:nowrap}.model-deprecated-badge{border-color:rgb(217 119 6 / 0.5);color:rgb(180 83 9)}.dark .model-deprecated-badge{color:rgb(251 191 36)}.model-input-icons{display:inline-flex;gap:0.375rem;color:var(--text-primary);vertical-align:middle}.model-cell-muted{color:var(--text-secondary);opacity:0.7}.model-input-text{display:none}@media (min-width: 768px) and (max-width: 1279px){.model-table-ready thead th:first-child,.model-table-ready tbody td:first-child{position:sticky;left:0;z-index:1;background:var(--paper);box-shadow:inset -1px 0 0 var(--border)}.model-table-ready tbody tr:hover td:first-child{background:linear-gradient(rgb(60 114 255 / 0.04), rgb(60 114 255 / 0.04)), var(--paper)}}@media (max-width: 767px){table.model-table-ready{display:block;width:100%!important;border:0;background:none}.model-table-ready thead{display:none}.model-table-ready tbody{display:flex;flex-direction:column;gap:0.75rem}.model-table-ready tbody tr{display:block;padding:0.75rem 1rem;border:1px solid var(--border);border-radius:6px;background:var(--paper)}.model-table-ready tbody td{display:grid;grid-template-columns:8.5rem minmax(0, 1fr);gap:0.75rem;padding:0.25rem 0!important;border-top:0;text-align:left!important;white-space:normal!important}.model-table-ready tbody td::before{content:attr(data-label);color:var(--text-secondary);font-size:0.75rem}.model-table-ready tbody td:first-child,.model-table-ready tbody td:last-child{display:block}.model-table-ready tbody td:first-child::before,.model-table-ready tbody td:last-child::before,.model-table-ready tbody tr.model-table-empty td::before{content:none}.model-table-ready tbody td:first-child{margin-bottom:0.375rem;padding-bottom:0.75rem!important;border-bottom:1px solid var(--border)}.model-table-ready tbody td:last-child{padding-top:0.5rem!important}.model-table-ready tbody td.model-cell-muted,.model-table-ready tbody td.model-cell-empty{display:none}.model-table-ready tbody tr:hover td{background:none}.model-table-ready tbody tr.model-table-empty{padding:0}.model-table-ready tbody tr.model-table-empty td{display:block;border-bottom:0}.model-input-icons{display:none}.model-input-text{display:inline}}html:has(.model-table){overflow-y:scroll}#content-area:has(.model-table) .feedback-toolbar{padding-bottom:0}.model-table-notes{display:grid;grid-template-columns:max-content minmax(0, 1fr);gap:0.25rem 1rem;max-width:55rem;margin-top:1rem;color:var(--text-secondary);font-size:0.75rem;line-height:1.25rem}.model-table-notes>span:nth-child(odd){color:var(--text-primary);font-weight:500}.model-table-notes code{font-size:0.75rem}.model-table-notes a code{padding:0;border:0;background:none;color:inherit}@media (max-width: 767px){.model-table-notes{grid-template-columns:minmax(0, 1fr)}.model-table-notes>span:nth-child(even){margin-bottom:0.5rem}}#content-container,#content-area,main{overflow:visible!important}.outlined-button{display:flex;flex-shrink:0;flex-direction:column;justify-content:center;align-items:center;width:176px;height:40px;padding:4px;border-radius:4px;border:1px solid var(--border);text-decoration:none;font-size:15px;text-align:center;color:var(--text-primary);font-weight:500;transition:background-color 0.3s ease, border 0.3s ease, color 0.3s ease}.outlined-button:hover{background-color:var(--paper);border:1px solid var(--brand-blue);color:var(--text-primary)}.mdx-content:has(.model-page-card){display:grid;grid-template-columns:minmax(0, 1fr)}.mdx-content:has(.model-page-card)>.not-prose,.model-page-card{display:contents}.model-page-back{display:inline-flex;align-items:center;gap:0.25rem;justify-self:start;margin-bottom:1.5rem;border-bottom:none!important;color:var(--brand-blue)!important;font-size:0.8125rem;font-weight:500;text-decoration:none}.model-page-back:hover{text-decoration:underline;text-underline-offset:2px}.model-page-head{display:flex;flex-wrap:wrap;align-items:flex-start;justify-content:space-between;gap:1.5rem;margin-bottom:2rem;padding-bottom:2rem;border-bottom:1px solid var(--border)}.model-page-title{display:flex;flex:1 1 30rem;align-items:flex-start;gap:1rem;min-width:0}.model-page-logo{display:flex;flex:0 0 auto;align-items:center;justify-content:center;width:3rem;height:3rem;border:1px solid var(--border);border-radius:4px}.model-page-logo img{width:2rem;height:2rem;object-fit:contain}.model-page-title h1{margin:0;color:var(--text-primary);font-family:paperMono, ui-monospace, SFMono-Regular, Menlo, monospace;font-size:2rem;font-weight:700;line-height:1.3;letter-spacing:-0.02em;overflow-wrap:anywhere}.model-page-meta{display:flex;flex-wrap:wrap;align-items:center;gap:0.5rem;margin-top:0.5rem;color:var(--text-secondary);font-size:0.8125rem}.model-page-meta>span:not(.model-plan-badge)+span:not(.model-plan-badge)::before{content:\"·\";margin-right:0.5rem;opacity:0.6}.model-page-actions{display:flex;flex-wrap:wrap;gap:0.5rem}.model-page-button{display:inline-flex;align-items:center;height:2.5rem;padding:0 1rem;border:1px solid var(--border);border-radius:4px;background:var(--paper);color:var(--brand-blue)!important;font-size:0.875rem;font-weight:500;white-space:nowrap;text-decoration:none;cursor:pointer}.model-page-button:hover{border-color:var(--brand-blue)}.model-page-button.primary{border-color:var(--brand-blue);background:var(--brand-blue);color:#ffffff!important}.dark .model-page-button.primary{color:#1c1917!important}.model-page-button.primary:hover{opacity:0.9}.model-page-button:focus-visible{outline:2px solid var(--brand-blue);outline-offset:2px}.model-page-specs{display:flex;flex-direction:column;gap:1.5rem;margin-bottom:2.5rem}.model-page-specs-card{padding:1.25rem;border:1px solid var(--border);border-radius:4px;background:var(--paper)}.model-page-eyebrow{display:block;margin-bottom:0.75rem;color:var(--text-secondary);font-size:0.625rem;letter-spacing:0.1em;text-transform:uppercase}.model-page-specs dl{display:grid;grid-template-columns:7rem minmax(0, 1fr);gap:0.625rem 0.75rem;margin:0;font-size:0.8125rem;line-height:1.25rem}.model-page-specs dt{color:var(--text-secondary)}.model-page-specs dd{margin:0;color:var(--text-primary)}.model-page-compare{display:flex;flex-direction:column;gap:0.5rem}.model-page-compare .model-page-eyebrow{margin-bottom:0}.model-page-compare a{display:flex;align-items:center;gap:0.75rem;padding:0.75rem;border:1px solid var(--border);border-radius:4px;color:var(--text-primary)!important;text-decoration:none}.model-page-compare a:hover{border-color:var(--brand-blue)}.model-page-compare a>span:last-child{display:flex;flex-direction:column;min-width:0}.model-page-compare-id{font-family:paperMono, ui-monospace, SFMono-Regular, Menlo, monospace;font-size:0.8125rem;font-weight:500;overflow-wrap:anywhere}.model-page-compare-note{color:var(--text-secondary);font-size:0.75rem}.model-page-content>[data-as=\"p\"]{display:block;margin:1.25rem 0}.model-page-content>:first-child{margin-top:0}.model-page-content h2{margin-top:2.5rem;font-size:1.25rem}.model-page-content h3{font-size:1rem}.model-page-content pre{white-space:pre-wrap}@media (max-width: 767px){.model-page-title h1{font-size:1.5rem}}.model-page-sidebar{display:none}.model-page-widget{order:1;margin-top:2.5rem}.model-page-widget iframe{display:block;width:100%;border:0}@media (min-width: 1080px){.mdx-content:has(.model-page-card){grid-template-columns:minmax(0, 1fr) 20rem;grid-template-rows:auto auto auto 1fr;column-gap:3rem}.model-page-widget{order:0;grid-row:4;grid-column:2;align-self:start;margin-top:1.5rem}.model-page-back,.model-page-head{grid-column:1 / -1}.model-page-specs{grid-row:3;grid-column:2;align-self:start;margin-bottom:0}.model-page-guides{grid-row:3 / span 2;grid-column:1;min-width:0}}#pinecone-connect-widget iframe{width:100%!important;max-width:500px!important}@media (max-width: 576px){#pinecone-connect-widget{scale:0.95!important;transform-origin:top left}.connect-widget-skeleton{height:180px;margin-block:30px}.skeleton-content{height:180px}#pinecone-connect-widget,#pinecone-connect-widget>div,#pinecone-connect-widget iframe{width:100%!important;min-width:0!important;max-width:100%!important}div[style*=\"min-width\"]{min-width:0!important;width:100%!important}}.pinecone-console-embed{#navbar img {\n display: none;\n }\n\n /* Hide top part of navbar */\n #navbar .relative:first-of-type > div:first-of-type {\n height: 0 !important;\n }\n\n /* Hide navbar links */\n #navbar nav {\n display: none;\n }\n\n /* Hide dark mode toggle */\n #navbar [aria-label=\"Toggle dark mode\"] {\n display: none;\n }\n\n /* Move API version selector to the right edge */\n #navbar button[aria-haspopup=\"menu\"] {\n position: absolute;\n top: 12px;\n right: 0px;\n }\n\n /* Move content up to account for smaller navbar */\n #content-container,\n #sidebar {\n margin-top: -4rem;\n }\n\n /* Hide mobile and desktop search button */\n #search-bar-entry-mobile,\n #search-bar-entry {\n display: none;\n }\n\n /* Hide actions menu */\n button[aria-label='More actions'] {\n display: none;\n }\n\n /* Move header link action to the right edge */\n h2 > .absolute:first-of-type,\n h3 > .absolute:first-of-type,\n h4 > .absolute:first-of-type {\n right: -12px;\n }}#page-context-menu-button{border-start-start-radius:0.25rem!important;border-end-start-radius:0.25rem!important}#page-context-menu button:last-child{border-radius:0!important;border-start-end-radius:0.25rem!important;border-end-end-radius:0.25rem!important}.agent-tool{border-left:4px solid var(--brand-blue, #002BFF);padding:1rem 1.25rem;border-radius:0.375rem;background-color:#f0f4ff;margin:0.5rem 0 1rem 0}.agent-tool>p:first-child{margin-top:0;font-size:0.875rem;letter-spacing:0.025em}.dark .agent-tool{background-color:rgba(0, 43, 255, 0.08);border-left-color:#4d6fff}#changelog-filters{display:none!important}#pc-cl-filters{margin-top:1.5rem;padding-top:1.25rem;border-top:1px solid var(--divider);display:flex;flex-direction:column;gap:0.5rem}.pc-cl-heading{margin:0 0 0.25rem;font-size:0.8125rem;font-weight:600;color:var(--text-primary)}.pc-cl-search{width:100%;padding:0.375rem 0.625rem;font-size:0.8125rem;line-height:1.5;color:inherit;background-color:transparent;border:1px solid var(--divider);border-radius:0.5rem;appearance:none}.pc-cl-search::placeholder{color:var(--text-secondary)}.pc-cl-search:focus{outline:none;border-color:var(--brand-blue)}.pc-cl-dd-toggle{width:100%;display:flex;align-items:center;justify-content:space-between;gap:0.5rem;padding:0.375rem 0.625rem;font-size:0.8125rem;line-height:1.5;text-align:left;color:inherit;cursor:pointer;background-color:transparent;border:1px solid var(--divider);border-radius:0.5rem}.pc-cl-dd-toggle:hover{background-color:var(--surface)}.pc-cl-dd.is-active .pc-cl-dd-toggle{border-color:var(--brand-blue);font-weight:500}.pc-cl-dd-caret{flex:none;width:0.75rem;height:0.75rem;opacity:0.6}.pc-cl-dd-toggle[aria-expanded=\"true\"] .pc-cl-dd-caret{transform:rotate(180deg)}.pc-cl-dd-menu{position:fixed;z-index:50;margin:0;padding:0.25rem;overflow-y:auto;list-style:none;background-color:var(--paper);border:1px solid var(--divider);border-radius:0.5rem;box-shadow:0 8px 24px rgba(0, 0, 0, 0.08)}.dark .pc-cl-dd-menu{box-shadow:0 8px 24px rgba(0, 0, 0, 0.4)}.pc-cl-dd-menu li{margin:0;padding:0;list-style:none}.pc-cl-dd-menu li::marker,.pc-cl-dd-menu li::before{content:none;display:none}.pc-cl-dd-menu button{width:100%;padding:0.3125rem 0.5rem;font-size:0.8125rem;line-height:1.4;text-align:left;color:inherit;cursor:pointer;background-color:transparent;border:0;border-radius:0.375rem}.pc-cl-dd-menu button:hover{background-color:var(--surface)}.pc-cl-clear{align-self:flex-start;padding:0;font-size:0.8125rem;color:var(--brand-blue);cursor:pointer;background:none;border:0}.pc-cl-clear:hover{text-decoration:underline}.pc-cl-count{margin:0;font-size:0.75rem;color:var(--text-secondary)}.pc-cl-empty{color:var(--text-secondary)}[class*=\"flex-wrap\"][class*=\"gap-2\"][class*=\"text-secondary\"]>span[class*=\"rounded-lg\"][class*=\"font-medium\"]{padding:0.1875rem 0.625rem;border-radius:9999px;border:1px solid var(--divider);background:transparent}.pc-mermaid-action rect{fill:var(--brand-blue)!important;stroke:var(--brand-blue)!important}.pc-mermaid-action .nodeLabel,.pc-mermaid-action .nodeLabel *{color:var(--text-contrast)!important}.pc-mermaid-item rect,.cluster.pc-mermaid-group rect{fill:transparent!important;stroke:var(--brand-blue)!important}.cluster.pc-mermaid-frame rect{fill:transparent!important;stroke:var(--secondary)!important}"}],"page":{"pagePath":"reference/api/2026-04/assistant/chat_assistant","slug":"/reference/api/2026-04/assistant/chat_assistant","pageMetadata":{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/assistant_data_2026-04.oas.yaml POST /chat/{assistant_name}","title":"Chat with an assistant","description":"Chat with an assistant and get back citations in structured form. \n\nThis is the recommended way to chat with an assistant, as it offers more functionality and control over the assistant's responses and references than the OpenAI-compatible chat interface.\n\nFor guidance and examples, see [Chat with an assistant](https://docs.pinecone.io/guides/assistant/chat-with-assistant).","href":"/reference/api/2026-04/assistant/chat_assistant"},"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 p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Chat with an assistant and get back citations in structured form.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"This is the recommended way to chat with an assistant, as it offers more functionality and control over the assistant’s responses and references than the OpenAI-compatible chat interface.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"For guidance and examples, see \", _jsx(_components.a, {\n href: \"https://docs.pinecone.io/guides/assistant/chat-with-assistant\",\n children: \"Chat with an assistant\"\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-04/assistant_data_2026-04.oas.yaml POST /chat/{assistant_name}","title":"Chat with an assistant","description":"Chat with an assistant and get back citations in structured form. \n\nThis is the recommended way to chat with an assistant, as it offers more functionality and control over the assistant's responses and references than the OpenAI-compatible chat interface.\n\nFor guidance and examples, see [Chat with an assistant](https://docs.pinecone.io/guides/assistant/chat-with-assistant).","href":"/reference/api/2026-04/assistant/chat_assistant"}}},"mdxSourceWithNoJs":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,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,ResponseExample}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!RequestExample)_missingMdxReference(`RequestExample`,true);if(!ResponseExample)_missingMdxReference(`ResponseExample`,true);return _jsxs(_Fragment,{children:[_jsxs(RequestExample,{children:[_jsx(CodeBlock,{filename:`curl | Default`,numberOfLines:`16`,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:`16`,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`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`ASSISTANT_NAME`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"example-assistant\"`})]}),`\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://prod-1-data.ke.pinecone.io/assistant/chat/`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$ASSISTANT_NAME`}),_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:` \"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:` \"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:` \"messages\": [`})}),`\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:` \"role\": \"user\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"content\": \"What is the inciting incident of Pride and Prejudice?\"`})}),`\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:` \"stream\": false,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"model\": \"gpt-4o\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`}'`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`curl | Streaming`,numberOfLines:`17`,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:`17`,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`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`ASSISTANT_NAME`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"example-assistant\"`})]}),`\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://prod-1-data.ke.pinecone.io/assistant/chat/`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$ASSISTANT_NAME`}),_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:` \"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:` \"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:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"X-Pinecone-Api-Version: 2026-04\"`}),_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:` \"messages\": [`})}),`\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:` \"role\": \"user\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"content\": \"What is the inciting incident of Pride and Prejudice?\"`})}),`\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:` \"stream\": true,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"model\": \"gpt-4o\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`}'`})}),`\n`]})})})]}),`\n`,_jsxs(ResponseExample,{children:[_jsx(CodeBlock,{filename:`Default response`,numberOfLines:`37`,language:`json`,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:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`37`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"finish_reason\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"stop\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"message\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"role\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"assistant\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"content\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"The inciting incident of `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`Pride and Prejudice`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` occurs when Mrs. Bennet informs Mr. Bennet that Netherfield Park has been let at last, and she is eager to share the news about the new tenant, Mr. Bingley, who is wealthy and single. This sets the stage for the subsequent events of the story, including the introduction of Mr. Bingley and Mr. Darcy to the Bennet family and the ensuing romantic entanglements.\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"00000000000000004ac3add5961aa757\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"model\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"gpt-4o-2024-05-13\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"usage\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"prompt_tokens\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`9736`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"completion_tokens\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`105`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"total_tokens\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`9841`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"citations\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"position\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`406`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"references\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"file\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Available\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"ae79e447-b89e-4994-994b-3232ca52a654\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Pride-and-Prejudice.pdf\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"size\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`2973077`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"metadata\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"updated_on\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2024-06-14T15:01:57.385425746Z\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"created_on\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2024-06-14T15:01:02.910452398Z\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"signed_url\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://storage.googleapis.com/...\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"pages\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:` 1`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`]})})}),_jsx(CodeBlock,{filename:`Streaming response`,numberOfLines:`61`,language:`text`,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:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`61`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`data:{`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"type\":\"message_start\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"id\":\"0000000000000000111b35de85e8a8f9\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"model\":\"gpt-4o-2024-05-13\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"role\":\"assistant\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`}`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`data:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`{`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"type\":\"content_chunk\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"id\":\"0000000000000000111b35de85e8a8f9\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"model\":\"gpt-4o-2024-05-13\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"delta\":`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"content\":\"The\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`}`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`...`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`data:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`{`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"type\":\"citation\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"id\":\"0000000000000000111b35de85e8a8f9\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"model\":\"gpt-4o-2024-05-13\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"citation\":`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"position\":406,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"references\":`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` [`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"file\":{`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"status\":\"Available\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"id\":\"ae79e447-b89e-4994-994b-3232ca52a654\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"name\":\"Pride-and-Prejudice.pdf\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"size\":2973077,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"metadata\":null,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"updated_on\":\"2024-06-14T15:01:57.385425746Z\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"created_on\":\"2024-06-14T15:01:02.910452398Z\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"signed_url\":\"https://storage.googleapis.com/...\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"pages\":[1]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`}`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`data:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`{`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"type\":\"message_end\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"id\":\"0000000000000000111b35de85e8a8f9\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"model\":\"gpt-4o-2024-05-13\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"finish_reason\":\"stop\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"usage\":`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"prompt_tokens\":9736,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"completion_tokens\":102,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"total_tokens\":9838`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`}`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})})]})]})}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-04/assistant_data_2026-04.oas.yaml POST /chat/{assistant_name}","title":"Chat with an assistant","description":"Chat with an assistant and get back citations in structured form. \n\nThis is the recommended way to chat with an assistant, as it offers more functionality and control over the assistant's responses and references than the OpenAI-compatible chat interface.\n\nFor guidance and examples, see [Chat with an assistant](https://docs.pinecone.io/guides/assistant/chat-with-assistant).","href":"/reference/api/2026-04/assistant/chat_assistant"}}}},"mdxExtracts":{"tableOfContents":[],"codeExamples":{"request":{"type":"RequestExample","children":[{"filename":"curl | Default","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=\"16\">\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\">\u003cspan style=\"color:#1F2328;--shiki-dark:#9CDCFE\">ASSISTANT_NAME\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D4D4D4\">=\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"example-assistant\"\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://prod-1-data.ke.pinecone.io/assistant/chat/\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#9CDCFE\">$ASSISTANT_NAME\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\"> \"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\"> \"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\"> \"messages\": [\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\"> \"role\": \"user\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"content\": \"What is the inciting incident of Pride and Prejudice?\"\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\"> \"stream\": false,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"model\": \"gpt-4o\"\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":"curl | Streaming","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=\"17\">\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\">\u003cspan style=\"color:#1F2328;--shiki-dark:#9CDCFE\">ASSISTANT_NAME\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D4D4D4\">=\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"example-assistant\"\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://prod-1-data.ke.pinecone.io/assistant/chat/\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#9CDCFE\">$ASSISTANT_NAME\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\"> \"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\"> \"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\"> -H\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"X-Pinecone-Api-Version: 2026-04\"\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\"> \"messages\": [\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\"> \"role\": \"user\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"content\": \"What is the inciting incident of Pride and Prejudice?\"\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\"> \"stream\": true,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"model\": \"gpt-4o\"\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":[]},"response":{"type":"ResponseExample","children":[{"filename":"Default response","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=\"json\">\u003ccode language=\"json\" numberOfLines=\"37\">\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"finish_reason\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"stop\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"message\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"role\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"assistant\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"content\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"The inciting incident of \u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">Pride and Prejudice\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> occurs when Mrs. Bennet informs Mr. Bennet that Netherfield Park has been let at last, and she is eager to share the news about the new tenant, Mr. Bingley, who is wealthy and single. This sets the stage for the subsequent events of the story, including the introduction of Mr. Bingley and Mr. Darcy to the Bennet family and the ensuing romantic entanglements.\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"00000000000000004ac3add5961aa757\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"model\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"gpt-4o-2024-05-13\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"usage\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"prompt_tokens\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">9736\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"completion_tokens\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">105\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"total_tokens\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">9841\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"citations\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: [\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"position\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">406\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"references\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: [\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"file\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"status\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Available\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"ae79e447-b89e-4994-994b-3232ca52a654\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"name\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Pride-and-Prejudice.pdf\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"size\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">2973077\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"metadata\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\">null\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"updated_on\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"2024-06-14T15:01:57.385425746Z\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"created_on\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"2024-06-14T15:01:02.910452398Z\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"signed_url\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"https://storage.googleapis.com/...\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"pages\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: [\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\"> 1\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> ]\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> ]\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> ]\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003c/span>\n\u003c/code>\u003c/pre>"},{"filename":"Streaming response","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=\"text\">\u003ccode language=\"text\" numberOfLines=\"61\">\u003cspan class=\"line\">\u003cspan>data:{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> \"type\":\"message_start\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> \"id\":\"0000000000000000111b35de85e8a8f9\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> \"model\":\"gpt-4o-2024-05-13\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> \"role\":\"assistant\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan>}\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan>\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan>data:\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan>{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> \"type\":\"content_chunk\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> \"id\":\"0000000000000000111b35de85e8a8f9\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> \"model\":\"gpt-4o-2024-05-13\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> \"delta\":\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> \"content\":\"The\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan>}\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan>\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan>...\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan>\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan>data:\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan>{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> \"type\":\"citation\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> \"id\":\"0000000000000000111b35de85e8a8f9\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> \"model\":\"gpt-4o-2024-05-13\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> \"citation\":\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> \"position\":406,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> \"references\":\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> [\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> \"file\":{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> \"status\":\"Available\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> \"id\":\"ae79e447-b89e-4994-994b-3232ca52a654\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> \"name\":\"Pride-and-Prejudice.pdf\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> \"size\":2973077,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> \"metadata\":null,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> \"updated_on\":\"2024-06-14T15:01:57.385425746Z\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> \"created_on\":\"2024-06-14T15:01:02.910452398Z\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> \"signed_url\":\"https://storage.googleapis.com/...\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> \"pages\":[1]\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> ]\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan>}\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan>\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan>data:\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan>{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> \"type\":\"message_end\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> \"id\":\"0000000000000000111b35de85e8a8f9\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> \"model\":\"gpt-4o-2024-05-13\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> \"finish_reason\":\"stop\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> \"usage\":\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> \"prompt_tokens\":9736,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> \"completion_tokens\":102,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> \"total_tokens\":9838\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan>}\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan>\u003c/span>\u003c/span>\u003c/code>\u003c/pre>"}],"attributes":[]}}},"jsLinks":["/_mintlify/custom/pinecone/345ae6b85c58f0d4/console-iframe.js","/_mintlify/custom/pinecone/195d6f844f2a1df8/script.js","/_mintlify/custom/pinecone/4d30bdf131035051/inkeep.js"],"openApiReferenceData":{"operation":{"tags":["Manage Assistants"],"summary":"Chat with an assistant","description":"Chat with an assistant and get back citations in structured form. \n\nThis is the recommended way to chat with an assistant, as it offers more functionality and control over the assistant's responses and references than the OpenAI-compatible chat interface.\n\nFor guidance and examples, see [Chat with an assistant](https://docs.pinecone.io/guides/assistant/chat-with-assistant).","operationId":"chat_assistant","parameters":["6293a4f9-ea78-40b6-b976-6cbf58b55f09","c8d93f87-78f8-45ec-9f35-6c5b8b80730c"],"requestBody":"dbf7023d-9c5b-41a9-a503-620919c458bb","responses":{"200":"e084eb33-89a4-459e-a3d5-11a4ad8c5edf","400":"136d7f7d-bf12-42bc-b598-408c2b90562e","401":"7e24b62e-633f-4e59-ab1b-9da494826481","404":"f7a40be3-8a99-4bfd-b90f-d9169eea7f66","500":"e746f8e2-5b7a-40d6-b98e-80e12f620f47"},"method":"post","type":"path","servers":["8990c6ba-63c3-4e74-b7d1-c56170c36a2c"],"security":["683e0452-3173-4caf-84f2-4835f89e4e9c"],"path":"/chat/{assistant_name}","baseUrlOptions":["https://{assistant_host}"],"title":"Chat with an assistant","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":"16","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":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#9CDCFE"},"children":"ASSISTANT_NAME"}},{"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":"\"example-assistant\""}}]}},"\n",{"type":"span","key":"4","ref":null,"props":{"className":"line","children":null}},"\n",{"type":"span","key":"6","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://prod-1-data.ke.pinecone.io/assistant/chat/"}},{"type":"span","key":"2","ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#9CDCFE"},"children":"$ASSISTANT_NAME"}},{"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":" \"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":"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":" \"messages\": ["}}}},"\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":" {"}}}},"\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":" \"role\": \"user\","}}}},"\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":" \"content\": \"What is the inciting incident of Pride and Prejudice?\""}}}},"\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":" }"}}}},"\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":" ],"}}}},"\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":" \"stream\": false,"}}}},"\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":" \"model\": \"gpt-4o\""}}}},"\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"]}}}},"filename":"curl | Default"},{"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":"17","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":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#9CDCFE"},"children":"ASSISTANT_NAME"}},{"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":"\"example-assistant\""}}]}},"\n",{"type":"span","key":"4","ref":null,"props":{"className":"line","children":null}},"\n",{"type":"span","key":"6","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://prod-1-data.ke.pinecone.io/assistant/chat/"}},{"type":"span","key":"2","ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#9CDCFE"},"children":"$ASSISTANT_NAME"}},{"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":" \"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":"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":" -H"}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" \"X-Pinecone-Api-Version: 2026-04\""}},{"type":"span","key":"2","ref":null,"props":{"style":{"color":"#CF222E","--shiki-dark":"#D7BA7D"},"children":" \\"}}]}},"\n",{"type":"span","key":"14","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":"16","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" \"messages\": ["}}}},"\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":" {"}}}},"\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":" \"role\": \"user\","}}}},"\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":" \"content\": \"What is the inciting incident of Pride and Prejudice?\""}}}},"\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":" }"}}}},"\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":" ],"}}}},"\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":" \"stream\": true,"}}}},"\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":" \"model\": \"gpt-4o\""}}}},"\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"]}}}},"filename":"curl | Streaming"}],"requestExampleType":"mdx","responseExamples":[{"dropdown":false,"language":"json","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":"json","children":{"type":"code","key":null,"ref":null,"props":{"language":"json","numberOfLines":"37","children":[{"type":"span","key":"0","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":"{"}}}},"\n",{"type":"span","key":"2","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#116329","--shiki-dark":"#9CDCFE"},"children":" \"finish_reason\""}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":": "}},{"type":"span","key":"2","ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":"\"stop\""}},{"type":"span","key":"3","ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":","}}]}},"\n",{"type":"span","key":"4","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#116329","--shiki-dark":"#9CDCFE"},"children":" \"message\""}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":": {"}}]}},"\n",{"type":"span","key":"6","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#116329","--shiki-dark":"#9CDCFE"},"children":" \"role\""}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":": "}},{"type":"span","key":"2","ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":"\"assistant\""}},{"type":"span","key":"3","ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":","}}]}},"\n",{"type":"span","key":"8","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#116329","--shiki-dark":"#9CDCFE"},"children":" \"content\""}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":": "}},{"type":"span","key":"2","ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":"\"The inciting incident of "}},{"type":"span","key":"3","ref":null,"props":{"style":{"color":"#CF222E","--shiki-dark":"#D7BA7D"},"children":"\\\""}},{"type":"span","key":"4","ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":"Pride and Prejudice"}},{"type":"span","key":"5","ref":null,"props":{"style":{"color":"#CF222E","--shiki-dark":"#D7BA7D"},"children":"\\\""}},{"type":"span","key":"6","ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" occurs when Mrs. Bennet informs Mr. Bennet that Netherfield Park has been let at last, and she is eager to share the news about the new tenant, Mr. Bingley, who is wealthy and single. This sets the stage for the subsequent events of the story, including the introduction of Mr. Bingley and Mr. Darcy to the Bennet family and the ensuing romantic entanglements.\""}}]}},"\n",{"type":"span","key":"10","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":" },"}}}},"\n",{"type":"span","key":"12","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#116329","--shiki-dark":"#9CDCFE"},"children":" \"id\""}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":": "}},{"type":"span","key":"2","ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":"\"00000000000000004ac3add5961aa757\""}},{"type":"span","key":"3","ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":","}}]}},"\n",{"type":"span","key":"14","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#116329","--shiki-dark":"#9CDCFE"},"children":" \"model\""}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":": "}},{"type":"span","key":"2","ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":"\"gpt-4o-2024-05-13\""}},{"type":"span","key":"3","ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":","}}]}},"\n",{"type":"span","key":"16","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#116329","--shiki-dark":"#9CDCFE"},"children":" \"usage\""}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":": {"}}]}},"\n",{"type":"span","key":"18","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#116329","--shiki-dark":"#9CDCFE"},"children":" \"prompt_tokens\""}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":": "}},{"type":"span","key":"2","ref":null,"props":{"style":{"color":"#0550AE","--shiki-dark":"#B5CEA8"},"children":"9736"}},{"type":"span","key":"3","ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":","}}]}},"\n",{"type":"span","key":"20","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#116329","--shiki-dark":"#9CDCFE"},"children":" \"completion_tokens\""}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":": "}},{"type":"span","key":"2","ref":null,"props":{"style":{"color":"#0550AE","--shiki-dark":"#B5CEA8"},"children":"105"}},{"type":"span","key":"3","ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":","}}]}},"\n",{"type":"span","key":"22","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#116329","--shiki-dark":"#9CDCFE"},"children":" \"total_tokens\""}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":": "}},{"type":"span","key":"2","ref":null,"props":{"style":{"color":"#0550AE","--shiki-dark":"#B5CEA8"},"children":"9841"}}]}},"\n",{"type":"span","key":"24","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":" },"}}}},"\n",{"type":"span","key":"26","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#116329","--shiki-dark":"#9CDCFE"},"children":" \"citations\""}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":": ["}}]}},"\n",{"type":"span","key":"28","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":" {"}}}},"\n",{"type":"span","key":"30","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#116329","--shiki-dark":"#9CDCFE"},"children":" \"position\""}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":": "}},{"type":"span","key":"2","ref":null,"props":{"style":{"color":"#0550AE","--shiki-dark":"#B5CEA8"},"children":"406"}},{"type":"span","key":"3","ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":","}}]}},"\n",{"type":"span","key":"32","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#116329","--shiki-dark":"#9CDCFE"},"children":" \"references\""}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":": ["}}]}},"\n",{"type":"span","key":"34","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":" {"}}}},"\n",{"type":"span","key":"36","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#116329","--shiki-dark":"#9CDCFE"},"children":" \"file\""}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":": {"}}]}},"\n",{"type":"span","key":"38","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#116329","--shiki-dark":"#9CDCFE"},"children":" \"status\""}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":": "}},{"type":"span","key":"2","ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":"\"Available\""}},{"type":"span","key":"3","ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":","}}]}},"\n",{"type":"span","key":"40","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#116329","--shiki-dark":"#9CDCFE"},"children":" \"id\""}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":": "}},{"type":"span","key":"2","ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":"\"ae79e447-b89e-4994-994b-3232ca52a654\""}},{"type":"span","key":"3","ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":","}}]}},"\n",{"type":"span","key":"42","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#116329","--shiki-dark":"#9CDCFE"},"children":" \"name\""}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":": "}},{"type":"span","key":"2","ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":"\"Pride-and-Prejudice.pdf\""}},{"type":"span","key":"3","ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":","}}]}},"\n",{"type":"span","key":"44","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#116329","--shiki-dark":"#9CDCFE"},"children":" \"size\""}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":": "}},{"type":"span","key":"2","ref":null,"props":{"style":{"color":"#0550AE","--shiki-dark":"#B5CEA8"},"children":"2973077"}},{"type":"span","key":"3","ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":","}}]}},"\n",{"type":"span","key":"46","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#116329","--shiki-dark":"#9CDCFE"},"children":" \"metadata\""}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":": "}},{"type":"span","key":"2","ref":null,"props":{"style":{"color":"#0550AE","--shiki-dark":"#569CD6"},"children":"null"}},{"type":"span","key":"3","ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":","}}]}},"\n",{"type":"span","key":"48","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#116329","--shiki-dark":"#9CDCFE"},"children":" \"updated_on\""}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":": "}},{"type":"span","key":"2","ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":"\"2024-06-14T15:01:57.385425746Z\""}},{"type":"span","key":"3","ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":","}}]}},"\n",{"type":"span","key":"50","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#116329","--shiki-dark":"#9CDCFE"},"children":" \"created_on\""}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":": "}},{"type":"span","key":"2","ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":"\"2024-06-14T15:01:02.910452398Z\""}},{"type":"span","key":"3","ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":","}}]}},"\n",{"type":"span","key":"52","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#116329","--shiki-dark":"#9CDCFE"},"children":" \"signed_url\""}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":": "}},{"type":"span","key":"2","ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":"\"https://storage.googleapis.com/...\""}}]}},"\n",{"type":"span","key":"54","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":" },"}}}},"\n",{"type":"span","key":"56","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#116329","--shiki-dark":"#9CDCFE"},"children":" \"pages\""}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":": ["}}]}},"\n",{"type":"span","key":"58","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"style":{"color":"#0550AE","--shiki-dark":"#B5CEA8"},"children":" 1"}}}},"\n",{"type":"span","key":"60","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":" ]"}}}},"\n",{"type":"span","key":"62","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":" }"}}}},"\n",{"type":"span","key":"64","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":" ]"}}}},"\n",{"type":"span","key":"66","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":" }"}}}},"\n",{"type":"span","key":"68","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":" ]"}}}},"\n",{"type":"span","key":"70","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":"}"}}}},"\n",{"type":"span","key":"72","ref":null,"props":{"className":"line","children":null}},"\n"]}}}},"filename":"Default response"},{"dropdown":false,"language":"text","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":"text","children":{"type":"code","key":null,"ref":null,"props":{"language":"text","numberOfLines":"61","children":[{"type":"span","key":"0","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":"data:{"}}}},"\n",{"type":"span","key":"2","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":" \"type\":\"message_start\","}}}},"\n",{"type":"span","key":"4","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":" \"id\":\"0000000000000000111b35de85e8a8f9\","}}}},"\n",{"type":"span","key":"6","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":" \"model\":\"gpt-4o-2024-05-13\","}}}},"\n",{"type":"span","key":"8","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":" \"role\":\"assistant\""}}}},"\n",{"type":"span","key":"10","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":"}"}}}},"\n",{"type":"span","key":"12","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":null}}}},"\n",{"type":"span","key":"14","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":"data:"}}}},"\n",{"type":"span","key":"16","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":"{"}}}},"\n",{"type":"span","key":"18","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":" \"type\":\"content_chunk\","}}}},"\n",{"type":"span","key":"20","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":" \"id\":\"0000000000000000111b35de85e8a8f9\","}}}},"\n",{"type":"span","key":"22","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":" \"model\":\"gpt-4o-2024-05-13\","}}}},"\n",{"type":"span","key":"24","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":" \"delta\":"}}}},"\n",{"type":"span","key":"26","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":" {"}}}},"\n",{"type":"span","key":"28","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":" \"content\":\"The\""}}}},"\n",{"type":"span","key":"30","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":" }"}}}},"\n",{"type":"span","key":"32","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":"}"}}}},"\n",{"type":"span","key":"34","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":null}}}},"\n",{"type":"span","key":"36","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":"..."}}}},"\n",{"type":"span","key":"38","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":null}}}},"\n",{"type":"span","key":"40","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":"data:"}}}},"\n",{"type":"span","key":"42","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":"{"}}}},"\n",{"type":"span","key":"44","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":" \"type\":\"citation\","}}}},"\n",{"type":"span","key":"46","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":" \"id\":\"0000000000000000111b35de85e8a8f9\","}}}},"\n",{"type":"span","key":"48","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":" \"model\":\"gpt-4o-2024-05-13\","}}}},"\n",{"type":"span","key":"50","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":" \"citation\":"}}}},"\n",{"type":"span","key":"52","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":" {"}}}},"\n",{"type":"span","key":"54","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":" \"position\":406,"}}}},"\n",{"type":"span","key":"56","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":" \"references\":"}}}},"\n",{"type":"span","key":"58","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":" ["}}}},"\n",{"type":"span","key":"60","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":" {"}}}},"\n",{"type":"span","key":"62","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":" \"file\":{"}}}},"\n",{"type":"span","key":"64","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":" \"status\":\"Available\","}}}},"\n",{"type":"span","key":"66","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":" \"id\":\"ae79e447-b89e-4994-994b-3232ca52a654\","}}}},"\n",{"type":"span","key":"68","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":" \"name\":\"Pride-and-Prejudice.pdf\","}}}},"\n",{"type":"span","key":"70","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":" \"size\":2973077,"}}}},"\n",{"type":"span","key":"72","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":" \"metadata\":null,"}}}},"\n",{"type":"span","key":"74","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":" \"updated_on\":\"2024-06-14T15:01:57.385425746Z\","}}}},"\n",{"type":"span","key":"76","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":" \"created_on\":\"2024-06-14T15:01:02.910452398Z\","}}}},"\n",{"type":"span","key":"78","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":" \"signed_url\":\"https://storage.googleapis.com/...\""}}}},"\n",{"type":"span","key":"80","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":" },"}}}},"\n",{"type":"span","key":"82","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":" \"pages\":[1]"}}}},"\n",{"type":"span","key":"84","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":" }"}}}},"\n",{"type":"span","key":"86","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":" ]"}}}},"\n",{"type":"span","key":"88","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":" }"}}}},"\n",{"type":"span","key":"90","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":"}"}}}},"\n",{"type":"span","key":"92","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":null}}}},"\n",{"type":"span","key":"94","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":"data:"}}}},"\n",{"type":"span","key":"96","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":"{"}}}},"\n",{"type":"span","key":"98","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":" \"type\":\"message_end\","}}}},"\n",{"type":"span","key":"100","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":" \"id\":\"0000000000000000111b35de85e8a8f9\","}}}},"\n",{"type":"span","key":"102","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":" \"model\":\"gpt-4o-2024-05-13\","}}}},"\n",{"type":"span","key":"104","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":" \"finish_reason\":\"stop\","}}}},"\n",{"type":"span","key":"106","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":" \"usage\":"}}}},"\n",{"type":"span","key":"108","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":" {"}}}},"\n",{"type":"span","key":"110","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":" \"prompt_tokens\":9736,"}}}},"\n",{"type":"span","key":"112","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":" \"completion_tokens\":102,"}}}},"\n",{"type":"span","key":"114","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":" \"total_tokens\":9838"}}}},"\n",{"type":"span","key":"116","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":" }"}}}},"\n",{"type":"span","key":"118","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":"}"}}}},"\n",{"type":"span","key":"120","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"children":null}}}}]}}}},"filename":"Streaming response"}],"responseExampleType":"mdx"},"dependencies":{"parameters":{"6293a4f9-ea78-40b6-b976-6cbf58b55f09":{"in":"header","name":"X-Pinecone-Api-Version","description":"Required date-based version header","required":true,"schema":{"default":"2026-04","type":"string","isRequired":true,"description":"Required date-based version header","uniqueKey":"","typeLabel":"string"},"style":"simple"},"c8d93f87-78f8-45ec-9f35-6c5b8b80730c":{"in":"path","name":"assistant_name","description":"The name of the assistant to be described.","required":true,"schema":{"type":"string","isRequired":true,"description":"The name of the assistant to be described.","uniqueKey":"","typeLabel":"string"},"example":"test-assistant","style":"simple"}},"requestBody":{"description":"The desired configuration to chat with an assistant.","content":{"application/json":{"schema":{"description":"Represents a request to chat with an assistant.","type":"object","properties":{"messages":{"description":"The list of messages sent to the assistant, used for context retrieval and generating response with the LLM.","type":"array","items":{"description":"Describes the format of a message in a chat.","type":"object","properties":{"role":{"description":"The role of the message author, it can be `user`, `assistant`, or `system`.","type":"string","uniqueKey":"messages.items.[INDEX].role","typeLabel":"string"},"content":{"description":"The textual content of this partial message.","type":"string","uniqueKey":"messages.items.[INDEX].content","typeLabel":"string"}},"uniqueKey":"messages.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"messages","typeLabel":"object[]"},"stream":{"description":"If `false`, the assistant returns a single JSON response. If `true`, the assistant returns a stream of responses.","default":false,"type":"boolean","uniqueKey":"stream","typeLabel":"boolean"},"model":{"description":"The large language model used to generate responses.","default":"gpt-4o","x-enum":["gpt-4o","gpt-4.1","gpt-5","o4-mini","claude-sonnet-4-5","gemini-2.5-pro"],"type":"string","uniqueKey":"model","typeLabel":"string"},"temperature":{"description":"Controls the randomness of the model's output: lower values make responses more deterministic, while higher values increase creativity and variability. If the model does not support a temperature parameter, the parameter will be ignored.","default":0,"type":"number","format":"float","uniqueKey":"temperature","typeLabel":"number\u003cfloat>"},"filter":{"example":{"genre":{"$ne":"documentary"}},"description":"Optional metadata-based filter to restrict which documents are retrieved for the assistant's response context.","type":"object","uniqueKey":"filter","typeLabel":"object"},"json_response":{"description":"If `true`, instructs the assistant to return a JSON-formatted response. Cannot be used together with streaming mode.","default":false,"type":"boolean","uniqueKey":"json_response","typeLabel":"boolean"},"include_highlights":{"description":"If `true`, instructs the assistant to include highlights from the referenced documents that support its response.","default":false,"type":"boolean","uniqueKey":"include_highlights","typeLabel":"boolean"},"context_options":{"description":"Controls the context snippets sent to the LLM.","type":"object","properties":{"top_k":{"example":20,"description":"The maximum number of context snippets to use. Default is 16. Maximum is 64.","type":"integer","uniqueKey":"context_options.top_k","typeLabel":"integer"},"snippet_size":{"example":4096,"description":"The maximum context snippet size. Default is 2048 tokens. Minimum is 512 tokens. Maximum is 8192 tokens.","type":"integer","uniqueKey":"context_options.snippet_size","typeLabel":"integer"},"multimodal":{"description":"Whether or not to send image-related context snippets to the LLM. If `false`, only text context snippets are sent.","default":true,"type":"boolean","uniqueKey":"context_options.multimodal","typeLabel":"boolean"},"include_binary_content":{"description":"If image-related context snippets are sent to the LLM, this field determines whether or not they should include base64 image data. If `false`, only the image caption is sent. Only available when `multimodal=true`.","default":true,"type":"boolean","uniqueKey":"context_options.include_binary_content","typeLabel":"boolean"}},"uniqueKey":"context_options","typeLabel":"object"}},"required":["messages"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"messages":[{"role":"\u003cstring>","content":"\u003cstring>"}],"stream":false,"model":"gpt-4o","temperature":0,"filter":{"genre":{"$ne":"documentary"}},"json_response":false,"include_highlights":false,"context_options":{"top_k":20,"snippet_size":4096,"multimodal":true,"include_binary_content":true}}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"e084eb33-89a4-459e-a3d5-11a4ad8c5edf":{"description":"Search request successful.","content":{"application/json":{"schema":{"description":"Describes the response format of a chat request.","type":"object","properties":{"id":{"description":"A unique identifier for this chat response.","type":"string","uniqueKey":"id","typeLabel":"string"},"finish_reason":{"description":"Indicates why the chat response generation stopped. This signals the end of the response.\n- `stop`: The model finished generating the response. \n- `length`: Generation was cut off because the maximum number of tokens allowed was reached.\n- `content_filter`: Generation stopped because content was blocked by content filtering rules. \n (for example, content that contains hate speech or violent material).\n\n- `tool_calls`: Generation stopped because a tool call was triggered.","x-enum":["stop","length","content_filter","tool_calls"],"type":"string","uniqueKey":"finish_reason","typeLabel":"string"},"message":{"description":"Describes the format of a message in a chat.","type":"object","properties":{"role":{"description":"The role of the message author, it can be `user`, `assistant`, or `system`.","type":"string","uniqueKey":"message.role","typeLabel":"string"},"content":{"description":"The textual content of this partial message.","type":"string","uniqueKey":"message.content","typeLabel":"string"}},"uniqueKey":"message","typeLabel":"object"},"model":{"description":"The name or identifier of the model used to generate this chat response.","type":"string","uniqueKey":"model","typeLabel":"string"},"citations":{"description":"Citations supporting the information in the response.","type":"array","items":{"description":"Describes a single citation included in a chat response, pointing to one or more referenced sources.","type":"object","properties":{"position":{"description":"The index position of the citation in the complete text response.","type":"integer","uniqueKey":"citations.items.[INDEX].position","typeLabel":"integer"},"references":{"description":"A list of file references that this citation points to.","type":"array","items":{"description":"Describes a single reference in a citation.","type":"object","properties":{"file":{"description":"The response format for a successful file upload request.","type":"object","properties":{"name":{"description":"The name of the uploaded file.","type":"string","isRequired":true,"uniqueKey":"citations.items.[INDEX].references.items.[INDEX].file.name","typeLabel":"string"},"id":{"description":"The unique identifier for the uploaded file. This may be a user-provided identifier or a system-generated ID.","type":"string","isRequired":true,"uniqueKey":"citations.items.[INDEX].references.items.[INDEX].file.id","typeLabel":"string"},"size":{"example":1048576,"description":"The size of the uploaded file, in bytes.","type":"integer","format":"int64","uniqueKey":"citations.items.[INDEX].references.items.[INDEX].file.size","typeLabel":"integer\u003cint64>"},"metadata":{"oneOf":[{"example":{"created_by":"Jane Doe","published":"2025-10-01T00:00:00.000Z","tags":["report","Q4","analytics"]},"description":"Optional metadata associated with the file. This metadata can be used to filter files when listing them or to restrict search results when querying the assistant.","type":"object","uniqueKey":"citations.items.[INDEX].references.items.[INDEX].file.metadata.oneOf.0","typeLabel":"object"},{"example":{"created_by":"Jane Doe","published":"2025-10-01T00:00:00.000Z","tags":["report","Q4","analytics"]},"description":"Optional metadata associated with the file. This metadata can be used to filter files when listing them or to restrict search results when querying the assistant.","type":"null","uniqueKey":"citations.items.[INDEX].references.items.[INDEX].file.metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"citations.items.[INDEX].references.items.[INDEX].file.metadata","typeLabel":"object | null"},"created_on":{"example":"2025-10-01T12:30:00.000Z","description":"The timestamp when the file was uploaded, in ISO 8601 format (`YYYY-MM-DDTHH:MM:SSZ`).","type":"string","format":"date-time","uniqueKey":"citations.items.[INDEX].references.items.[INDEX].file.created_on","typeLabel":"string\u003cdate-time>"},"updated_on":{"example":"2025-10-01T12:45:00.000Z","description":"The timestamp of the most recent update to the file, in ISO 8601 format (`YYYY-MM-DDTHH:MM:SSZ`).","type":"string","format":"date-time","uniqueKey":"citations.items.[INDEX].references.items.[INDEX].file.updated_on","typeLabel":"string\u003cdate-time>"},"status":{"description":"The current state of the uploaded file. Possible values:\n- `Processing`: File is being processed (parsed, chunked, embedded)\n- `Available`: Processing completed successfully; file is ready for use\n- `Deleting`: Deletion has been initiated but not yet completed\n- `ProcessingFailed`: Processing failed with an error\n\nNote: Once a file is deleted, the API returns 404 Not Found instead of a file object.","x-enum":["Processing","Available","Deleting","ProcessingFailed"],"type":"string","uniqueKey":"citations.items.[INDEX].references.items.[INDEX].file.status","typeLabel":"string"},"signed_url":{"oneOf":[{"example":"https://storage.googleapis.com/bucket/file.pdf?...","description":"A [signed URL](https://cloud.google.com/storage/docs/access-control/signed-urls) that provides temporary, read-only access to the file. Anyone with the link can access the file, so treat it as sensitive data. Expires after a short time.","type":"string","uniqueKey":"citations.items.[INDEX].references.items.[INDEX].file.signed_url.oneOf.0","typeLabel":"string"},{"example":"https://storage.googleapis.com/bucket/file.pdf?...","description":"A [signed URL](https://cloud.google.com/storage/docs/access-control/signed-urls) that provides temporary, read-only access to the file. Anyone with the link can access the file, so treat it as sensitive data. Expires after a short time.","type":"null","uniqueKey":"citations.items.[INDEX].references.items.[INDEX].file.signed_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"citations.items.[INDEX].references.items.[INDEX].file.signed_url","typeLabel":"string | null"},"multimodal":{"description":"Indicates whether the file was processed as multimodal.","type":"boolean","uniqueKey":"citations.items.[INDEX].references.items.[INDEX].file.multimodal","typeLabel":"boolean"}},"required":["id","name"],"uniqueKey":"citations.items.[INDEX].references.items.[INDEX].file","typeLabel":"object"},"pages":{"description":"A list of page numbers in the referenced document that contain the relevant content.","type":"array","items":{"type":"integer","uniqueKey":"citations.items.[INDEX].references.items.[INDEX].pages.items.[INDEX]","typeLabel":"integer"},"uniqueKey":"citations.items.[INDEX].references.items.[INDEX].pages","typeLabel":"integer[]"},"highlight":{"oneOf":[{"description":"Represents a portion of a referenced document that directly supports or is relevant to the response.","type":"object","properties":{"type":{"description":"The type of the highlight. Only `text` is supported.","type":"string","isRequired":true,"uniqueKey":"citations.items.[INDEX].references.items.[INDEX].highlight.oneOf.0.type","typeLabel":"string"},"content":{"description":"The text content of the highlighted portion from the referenced document.","type":"string","isRequired":true,"uniqueKey":"citations.items.[INDEX].references.items.[INDEX].highlight.oneOf.0.content","typeLabel":"string"}},"required":["type","content"],"uniqueKey":"citations.items.[INDEX].references.items.[INDEX].highlight.oneOf.0","typeLabel":"object"},{"description":"Represents a portion of a referenced document that directly supports or is relevant to the response.","type":"null","properties":{"type":{"description":"The type of the highlight. Only `text` is supported.","type":"string"},"content":{"description":"The text content of the highlighted portion from the referenced document.","type":"string"}},"required":["type","content"],"uniqueKey":"citations.items.[INDEX].references.items.[INDEX].highlight.oneOf.1","typeLabel":"null"}],"uniqueKey":"citations.items.[INDEX].references.items.[INDEX].highlight","typeLabel":"object | null"}},"uniqueKey":"citations.items.[INDEX].references.items.[INDEX]","typeLabel":"object"},"uniqueKey":"citations.items.[INDEX].references","typeLabel":"object[]"}},"uniqueKey":"citations.items.[INDEX]","typeLabel":"object"},"uniqueKey":"citations","typeLabel":"object[]"},"usage":{"description":"Describes the token usage associated with interactions with an assistant.","type":"object","properties":{"prompt_tokens":{"description":"For chat interactions, the number of tokens in the LLM request (message, context snippets, and system prompt).\nFor context retrieval, the number of tokens in the LLM request used to generate search queries from the messages, plus the tokens in the retrieved context snippets.","type":"integer","uniqueKey":"usage.prompt_tokens","typeLabel":"integer"},"completion_tokens":{"description":"For chat interactions, the number of tokens in the assistant's response. \nFor context retrieval, this is always 0.","type":"integer","uniqueKey":"usage.completion_tokens","typeLabel":"integer"},"total_tokens":{"description":"The total number of tokens used, equal to the sum of `prompt_tokens` and `completion_tokens`.","type":"integer","uniqueKey":"usage.total_tokens","typeLabel":"integer"}},"uniqueKey":"usage","typeLabel":"object"},"context_snippet_count":{"description":"The number of context snippets provided to the model to generate the response. This indicates how much retrieved information was available for the generation, allowing for logic to be applied if no context was found (count is 0).","type":"integer","uniqueKey":"context_snippet_count","typeLabel":"integer"},"content_filter_results":{"description":"Content filter results provided by the LLM, describing safety-related classifications applied to the content. The structure may vary depending on the model and the content being filtered. The `spec` field identifies the provider, and determines the structure of `results`.","type":"object","properties":{"spec":{"description":"Identifier of the model provider.","x-enum":["openai","gemini"],"type":"string","uniqueKey":"content_filter_results.spec","typeLabel":"string"},"results":{"description":"Content filter results returned by the provider. The structure depend on the `spec` value.","uniqueKey":"content_filter_results.results","typeLabel":"any"}},"uniqueKey":"content_filter_results","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","finish_reason":"\u003cstring>","message":{"role":"\u003cstring>","content":"\u003cstring>"},"model":"\u003cstring>","citations":[{"position":123,"references":[{"file":{"name":"\u003cstring>","id":"\u003cstring>","size":1048576,"metadata":{"created_by":"Jane Doe","published":"2025-10-01T00:00:00.000Z","tags":["report","Q4","analytics"]},"created_on":"2025-10-01T12:30:00.000Z","updated_on":"2025-10-01T12:45:00.000Z","status":"\u003cstring>","signed_url":"https://storage.googleapis.com/bucket/file.pdf?...","multimodal":true},"pages":[123],"highlight":{"type":"\u003cstring>","content":"\u003cstring>"}}]}],"usage":{"prompt_tokens":123,"completion_tokens":123,"total_tokens":123},"context_snippet_count":123,"content_filter_results":{"spec":"\u003cstring>","results":"\u003cunknown>"}}}},"exampleType":"generated"},"text/event-stream":{"schema":{"oneOf":[{"type":"object","title":"Message start stream chunk","description":"The start message of a stream chat response. This chunk initializes the response by providing the unique identifier, the model, and the role of the author. It also provides the count of retrieved context snippets available to the model before any content is sent, allowing for decisions on how to handle cases where no relevant context was found.","required":["type","id","model","role"],"example":{"context_snippet_count":16,"id":"00000000000000002fe0c02e20be1c6a","model":"gpt-4o-2024-11-20","role":"assistant","type":"message_start"},"properties":{"type":{"description":"The type of stream chunk. Always `message_start`.","type":"string","isRequired":true,"uniqueKey":"oneOf.0.type","typeLabel":"string"},"id":{"description":"A unique identifier for this chat response.","type":"string","isRequired":true,"uniqueKey":"oneOf.0.id","typeLabel":"string"},"model":{"description":"The name or identifier of the model used to generate this chat response.","type":"string","isRequired":true,"uniqueKey":"oneOf.0.model","typeLabel":"string"},"role":{"description":"The role of the message author, it can be `user`, `assistant`, or `system`.","type":"string","isRequired":true,"uniqueKey":"oneOf.0.role","typeLabel":"string"},"context_snippet_count":{"description":"The number of context snippets provided to the model to generate the response. This indicates how much retrieved information was available for the generation, allowing for logic to be applied if no context was found (count is 0).","type":"integer","uniqueKey":"oneOf.0.context_snippet_count","typeLabel":"integer"},"content_filter_results":{"description":"Content filter results provided by the LLM, describing safety-related classifications applied to the content. The structure may vary depending on the model and the content being filtered. The `spec` field identifies the provider, and determines the structure of `results`.","type":"object","properties":{"spec":{"description":"Identifier of the model provider.","x-enum":["openai","gemini"],"type":"string","uniqueKey":"oneOf.0.content_filter_results.spec","typeLabel":"string"},"results":{"description":"Content filter results returned by the provider. The structure depend on the `spec` value.","uniqueKey":"oneOf.0.content_filter_results.results","typeLabel":"any"}},"uniqueKey":"oneOf.0.content_filter_results","typeLabel":"object"}},"uniqueKey":"oneOf.0","typeLabel":"Message start stream chunk · object"},{"type":"object","title":"Content stream chunk","description":"A content chunk in a stream chat response that contains a partial segment of the assistant's response. The `delta.content` property provides a string fragment that should be appended to the previously received fragments to construct the complete message.","required":["type","id","model","delta"],"example":{"delta":{"content":"Hello"},"id":"00000000000000002fe0c02e20be1c6a","model":"gpt-4o-2024-11-20","type":"content_chunk"},"properties":{"type":{"description":"The type of stream chunk. Always `content_chunk`.","type":"string","isRequired":true,"uniqueKey":"oneOf.1.type","typeLabel":"string"},"id":{"description":"A unique identifier for this chat response.","type":"string","isRequired":true,"uniqueKey":"oneOf.1.id","typeLabel":"string"},"model":{"description":"The name or identifier of the model used to generate this chat response.","type":"string","isRequired":true,"uniqueKey":"oneOf.1.model","typeLabel":"string"},"delta":{"description":"The format of this partial message. For example, if the response is \"Hello world\", the first chunk's `delta.content` might contain \"Hello\" and the second chunk's `delta.content` might contain \" world\".","type":"object","properties":{"content":{"description":"The text content of this partial message.","type":"string","isRequired":true,"uniqueKey":"oneOf.1.delta.content","typeLabel":"string"}},"required":["content"],"isRequired":true,"uniqueKey":"oneOf.1.delta","typeLabel":"object"},"content_filter_results":{"description":"Content filter results provided by the LLM, describing safety-related classifications applied to the content. The structure may vary depending on the model and the content being filtered. The `spec` field identifies the provider, and determines the structure of `results`.","type":"object","properties":{"spec":{"description":"Identifier of the model provider.","x-enum":["openai","gemini"],"type":"string","uniqueKey":"oneOf.1.content_filter_results.spec","typeLabel":"string"},"results":{"description":"Content filter results returned by the provider. The structure depend on the `spec` value.","uniqueKey":"oneOf.1.content_filter_results.results","typeLabel":"any"}},"uniqueKey":"oneOf.1.content_filter_results","typeLabel":"object"}},"uniqueKey":"oneOf.1","typeLabel":"Content stream chunk · object"},{"type":"object","title":"Citation stream chunk","description":"A citation chunk in a stream chat response that identifies the documents used to justify a specific claim or section of the assistant's response. It maps a character offset (`position`) within the accumulated message to specific references, allowing the client to render footnotes or links at the exact point of the claim to ensure the response is grounded in the provided files.","required":["type","id","model","citation"],"example":{"citation":{"position":53,"references":[{"file":{"created_on":"2025-01-01T00:00:00.000Z","id":"ae79e447-b89e-4994-994b-3232ca52a654","multimodal":false,"name":"my_file.pdf","signed_url":"https://storage.googleapis.com/...","size":25000,"status":"Available","updated_on":"2025-01-01T00:01:00.000Z"},"pages":[1,2]}]},"id":"00000000000000002fe0c02e20be1c6a","model":"gpt-4o-2024-11-20","type":"citation"},"properties":{"type":{"description":"The type of stream chunk. Always `citation`.","type":"string","isRequired":true,"uniqueKey":"oneOf.2.type","typeLabel":"string"},"id":{"description":"A unique identifier for this chat response.","type":"string","isRequired":true,"uniqueKey":"oneOf.2.id","typeLabel":"string"},"model":{"description":"The name or identifier of the model used to generate this chat response.","type":"string","isRequired":true,"uniqueKey":"oneOf.2.model","typeLabel":"string"},"citation":{"description":"Describes a single citation included in a chat response, pointing to one or more referenced sources.","type":"object","properties":{"position":{"description":"The index position of the citation in the complete text response.","type":"integer","uniqueKey":"oneOf.2.citation.position","typeLabel":"integer"},"references":{"description":"A list of file references that this citation points to.","type":"array","items":{"description":"Describes a single reference in a citation.","type":"object","properties":{"file":{"description":"The response format for a successful file upload request.","type":"object","properties":{"name":{"description":"The name of the uploaded file.","type":"string","isRequired":true,"uniqueKey":"oneOf.2.citation.references.items.[INDEX].file.name","typeLabel":"string"},"id":{"description":"The unique identifier for the uploaded file. This may be a user-provided identifier or a system-generated ID.","type":"string","isRequired":true,"uniqueKey":"oneOf.2.citation.references.items.[INDEX].file.id","typeLabel":"string"},"size":{"example":1048576,"description":"The size of the uploaded file, in bytes.","type":"integer","format":"int64","uniqueKey":"oneOf.2.citation.references.items.[INDEX].file.size","typeLabel":"integer\u003cint64>"},"metadata":{"oneOf":[{"example":{"created_by":"Jane Doe","published":"2025-10-01T00:00:00.000Z","tags":["report","Q4","analytics"]},"description":"Optional metadata associated with the file. This metadata can be used to filter files when listing them or to restrict search results when querying the assistant.","type":"object","uniqueKey":"oneOf.2.citation.references.items.[INDEX].file.metadata.oneOf.0","typeLabel":"object"},{"example":{"created_by":"Jane Doe","published":"2025-10-01T00:00:00.000Z","tags":["report","Q4","analytics"]},"description":"Optional metadata associated with the file. This metadata can be used to filter files when listing them or to restrict search results when querying the assistant.","type":"null","uniqueKey":"oneOf.2.citation.references.items.[INDEX].file.metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.2.citation.references.items.[INDEX].file.metadata","typeLabel":"object | null"},"created_on":{"example":"2025-10-01T12:30:00.000Z","description":"The timestamp when the file was uploaded, in ISO 8601 format (`YYYY-MM-DDTHH:MM:SSZ`).","type":"string","format":"date-time","uniqueKey":"oneOf.2.citation.references.items.[INDEX].file.created_on","typeLabel":"string\u003cdate-time>"},"updated_on":{"example":"2025-10-01T12:45:00.000Z","description":"The timestamp of the most recent update to the file, in ISO 8601 format (`YYYY-MM-DDTHH:MM:SSZ`).","type":"string","format":"date-time","uniqueKey":"oneOf.2.citation.references.items.[INDEX].file.updated_on","typeLabel":"string\u003cdate-time>"},"status":{"description":"The current state of the uploaded file. Possible values:\n- `Processing`: File is being processed (parsed, chunked, embedded)\n- `Available`: Processing completed successfully; file is ready for use\n- `Deleting`: Deletion has been initiated but not yet completed\n- `ProcessingFailed`: Processing failed with an error\n\nNote: Once a file is deleted, the API returns 404 Not Found instead of a file object.","x-enum":["Processing","Available","Deleting","ProcessingFailed"],"type":"string","uniqueKey":"oneOf.2.citation.references.items.[INDEX].file.status","typeLabel":"string"},"signed_url":{"oneOf":[{"example":"https://storage.googleapis.com/bucket/file.pdf?...","description":"A [signed URL](https://cloud.google.com/storage/docs/access-control/signed-urls) that provides temporary, read-only access to the file. Anyone with the link can access the file, so treat it as sensitive data. Expires after a short time.","type":"string","uniqueKey":"oneOf.2.citation.references.items.[INDEX].file.signed_url.oneOf.0","typeLabel":"string"},{"example":"https://storage.googleapis.com/bucket/file.pdf?...","description":"A [signed URL](https://cloud.google.com/storage/docs/access-control/signed-urls) that provides temporary, read-only access to the file. Anyone with the link can access the file, so treat it as sensitive data. Expires after a short time.","type":"null","uniqueKey":"oneOf.2.citation.references.items.[INDEX].file.signed_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.2.citation.references.items.[INDEX].file.signed_url","typeLabel":"string | null"},"multimodal":{"description":"Indicates whether the file was processed as multimodal.","type":"boolean","uniqueKey":"oneOf.2.citation.references.items.[INDEX].file.multimodal","typeLabel":"boolean"}},"required":["id","name"],"uniqueKey":"oneOf.2.citation.references.items.[INDEX].file","typeLabel":"object"},"pages":{"description":"A list of page numbers in the referenced document that contain the relevant content.","type":"array","items":{"type":"integer","uniqueKey":"oneOf.2.citation.references.items.[INDEX].pages.items.[INDEX]","typeLabel":"integer"},"uniqueKey":"oneOf.2.citation.references.items.[INDEX].pages","typeLabel":"integer[]"},"highlight":{"oneOf":[{"description":"Represents a portion of a referenced document that directly supports or is relevant to the response.","type":"object","properties":{"type":{"description":"The type of the highlight. Only `text` is supported.","type":"string","isRequired":true,"uniqueKey":"oneOf.2.citation.references.items.[INDEX].highlight.oneOf.0.type","typeLabel":"string"},"content":{"description":"The text content of the highlighted portion from the referenced document.","type":"string","isRequired":true,"uniqueKey":"oneOf.2.citation.references.items.[INDEX].highlight.oneOf.0.content","typeLabel":"string"}},"required":["type","content"],"uniqueKey":"oneOf.2.citation.references.items.[INDEX].highlight.oneOf.0","typeLabel":"object"},{"description":"Represents a portion of a referenced document that directly supports or is relevant to the response.","type":"null","properties":{"type":{"description":"The type of the highlight. Only `text` is supported.","type":"string"},"content":{"description":"The text content of the highlighted portion from the referenced document.","type":"string"}},"required":["type","content"],"uniqueKey":"oneOf.2.citation.references.items.[INDEX].highlight.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.2.citation.references.items.[INDEX].highlight","typeLabel":"object | null"}},"uniqueKey":"oneOf.2.citation.references.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.2.citation.references","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"oneOf.2.citation","typeLabel":"object"}},"uniqueKey":"oneOf.2","typeLabel":"Citation stream chunk · object"},{"type":"object","title":"Message end stream chunk","description":"The end message in a stream chat response. This chunk signals that the assistant has finished sending the response and provides the reason generation stopped along with the token consumption for the interaction.","required":["type","id","model","finish_reason"],"example":{"finish_reason":"stop","id":"00000000000000002fe0c02e20be1c6a","model":"gpt-4o-2024-11-20","type":"message_end","usage":{"completion_tokens":135,"prompt_tokens":2506,"total_tokens":2641}},"properties":{"type":{"description":"The type of stream chunk. Always `message_end`.","type":"string","isRequired":true,"uniqueKey":"oneOf.3.type","typeLabel":"string"},"id":{"description":"A unique identifier for this chat response.","type":"string","isRequired":true,"uniqueKey":"oneOf.3.id","typeLabel":"string"},"model":{"description":"The name or identifier of the model used to generate this chat response.","type":"string","isRequired":true,"uniqueKey":"oneOf.3.model","typeLabel":"string"},"finish_reason":{"description":"Indicates why the chat response generation stopped. This signals the end of the stream and no further chunks will be sent for this response.\n- `stop`: The model finished generating the response. \n- `length`: Generation was cut off because the maximum number of tokens allowed was reached.\n- `content_filter`: Generation stopped because content was blocked by content filtering rules. \n (for example, content that contains hate speech or violent material).\n\n- `tool_calls`: Generation stopped because a tool call was triggered.","x-enum":["stop","length","content_filter","tool_calls"],"type":"string","isRequired":true,"uniqueKey":"oneOf.3.finish_reason","typeLabel":"string"},"usage":{"description":"Describes the token usage associated with interactions with an assistant.","type":"object","properties":{"prompt_tokens":{"description":"For chat interactions, the number of tokens in the LLM request (message, context snippets, and system prompt).\nFor context retrieval, the number of tokens in the LLM request used to generate search queries from the messages, plus the tokens in the retrieved context snippets.","type":"integer","uniqueKey":"oneOf.3.usage.prompt_tokens","typeLabel":"integer"},"completion_tokens":{"description":"For chat interactions, the number of tokens in the assistant's response. \nFor context retrieval, this is always 0.","type":"integer","uniqueKey":"oneOf.3.usage.completion_tokens","typeLabel":"integer"},"total_tokens":{"description":"The total number of tokens used, equal to the sum of `prompt_tokens` and `completion_tokens`.","type":"integer","uniqueKey":"oneOf.3.usage.total_tokens","typeLabel":"integer"}},"uniqueKey":"oneOf.3.usage","typeLabel":"object"},"content_filter_results":{"description":"Content filter results provided by the LLM, describing safety-related classifications applied to the content. The structure may vary depending on the model and the content being filtered. The `spec` field identifies the provider, and determines the structure of `results`.","type":"object","properties":{"spec":{"description":"Identifier of the model provider.","x-enum":["openai","gemini"],"type":"string","uniqueKey":"oneOf.3.content_filter_results.spec","typeLabel":"string"},"results":{"description":"Content filter results returned by the provider. The structure depend on the `spec` value.","uniqueKey":"oneOf.3.content_filter_results.results","typeLabel":"any"}},"uniqueKey":"oneOf.3.content_filter_results","typeLabel":"object"}},"uniqueKey":"oneOf.3","typeLabel":"Message end stream chunk · object"}],"uniqueKey":"","typeLabel":"Message start stream chunk · object | Content stream chunk · object | Citation stream chunk · object | Message end stream chunk · object"},"examples":{"Example":{"title":"Example","value":{"context_snippet_count":16,"id":"00000000000000002fe0c02e20be1c6a","model":"gpt-4o-2024-11-20","role":"assistant","type":"message_start"}}},"exampleType":"generated"}},"exampleType":"generated"},"136d7f7d-bf12-42bc-b598-408c2b90562e":{"description":"Bad request. The request body included invalid request parameters.","content":{"application/json":{"schema":{"example":{"error":{"code":"TOO_MANY_REQUESTS","message":"Too many get or list assistant requests, try again later"},"status":429},"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":"Invalid region: Valid options are us, eu"},"description":"Detailed information about the error that occurred.","type":"object","properties":{"code":{"description":"The status code associated with the error.","x-enum":["OK","UNKNOWN","INVALID_ARGUMENT","DEADLINE_EXCEEDED","QUOTA_EXCEEDED","NOT_FOUND","ALREADY_EXISTS","PERMISSION_DENIED","UNAUTHENTICATED","RESOURCE_EXHAUSTED","FAILED_PRECONDITION","ABORTED","OUT_OF_RANGE","UNIMPLEMENTED","INTERNAL","UNAVAILABLE","DATA_LOSS","FORBIDDEN","TOO_MANY_REQUESTS"],"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"example":"Message content cannot be empty","description":"A message providing details about 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":{"files-validation-error":{"title":"files-validation-error","value":{"error":{"code":"INVALID_ARGUMENT","message":"Uploaded file can only currently be either a pdf or txt file"},"status":400}}},"exampleType":"examples"}},"exampleType":"examples"},"7e24b62e-633f-4e59-ab1b-9da494826481":{"description":"Unauthorized. Possible causes: Invalid API key.","content":{"application/json":{"schema":{"example":{"error":{"code":"TOO_MANY_REQUESTS","message":"Too many get or list assistant requests, try again later"},"status":429},"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":"Invalid region: Valid options are us, eu"},"description":"Detailed information about the error that occurred.","type":"object","properties":{"code":{"description":"The status code associated with the error.","x-enum":["OK","UNKNOWN","INVALID_ARGUMENT","DEADLINE_EXCEEDED","QUOTA_EXCEEDED","NOT_FOUND","ALREADY_EXISTS","PERMISSION_DENIED","UNAUTHENTICATED","RESOURCE_EXHAUSTED","FAILED_PRECONDITION","ABORTED","OUT_OF_RANGE","UNIMPLEMENTED","INTERNAL","UNAVAILABLE","DATA_LOSS","FORBIDDEN","TOO_MANY_REQUESTS"],"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"example":"Message content cannot be empty","description":"A message providing details about 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":{"unauthorized":{"title":"unauthorized","value":{"error":{"code":"UNAUTHENTICATED","message":"Invalid API key."},"status":401}}},"exampleType":"examples"}},"exampleType":"examples"},"f7a40be3-8a99-4bfd-b90f-d9169eea7f66":{"description":"Assistant not found.","content":{"application/json":{"schema":{"example":{"error":{"code":"TOO_MANY_REQUESTS","message":"Too many get or list assistant requests, try again later"},"status":429},"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":"Invalid region: Valid options are us, eu"},"description":"Detailed information about the error that occurred.","type":"object","properties":{"code":{"description":"The status code associated with the error.","x-enum":["OK","UNKNOWN","INVALID_ARGUMENT","DEADLINE_EXCEEDED","QUOTA_EXCEEDED","NOT_FOUND","ALREADY_EXISTS","PERMISSION_DENIED","UNAUTHENTICATED","RESOURCE_EXHAUSTED","FAILED_PRECONDITION","ABORTED","OUT_OF_RANGE","UNIMPLEMENTED","INTERNAL","UNAVAILABLE","DATA_LOSS","FORBIDDEN","TOO_MANY_REQUESTS"],"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"example":"Message content cannot be empty","description":"A message providing details about 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":{"assistant-not-found":{"title":"assistant-not-found","value":{"error":{"code":"NOT_FOUND","message":"Assistant \"example-assistant\" not found."},"status":404}}},"exampleType":"examples"}},"exampleType":"examples"},"e746f8e2-5b7a-40d6-b98e-80e12f620f47":{"description":"Internal server error.","content":{"application/json":{"schema":{"example":{"error":{"code":"TOO_MANY_REQUESTS","message":"Too many get or list assistant requests, try again later"},"status":429},"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":"Invalid region: Valid options are us, eu"},"description":"Detailed information about the error that occurred.","type":"object","properties":{"code":{"description":"The status code associated with the error.","x-enum":["OK","UNKNOWN","INVALID_ARGUMENT","DEADLINE_EXCEEDED","QUOTA_EXCEEDED","NOT_FOUND","ALREADY_EXISTS","PERMISSION_DENIED","UNAUTHENTICATED","RESOURCE_EXHAUSTED","FAILED_PRECONDITION","ABORTED","OUT_OF_RANGE","UNIMPLEMENTED","INTERNAL","UNAVAILABLE","DATA_LOSS","FORBIDDEN","TOO_MANY_REQUESTS"],"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"example":"Message content cannot be empty","description":"A message providing details about 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":{"683e0452-3173-4caf-84f2-4835f89e4e9c":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Api-Key","description":"Pinecone API Key","scopes":[]}}},"servers":{"8990c6ba-63c3-4e74-b7d1-c56170c36a2c":{"url":"https://{assistant_host}","variables":{"assistant_host":{"default":"unknown","description":"The host of the created assistant"}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"Api-Key","description":"Pinecone API Key","scopes":[]},"schema":{"title":"Api-Key","type":"string","description":"Pinecone API Key","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-04/assistant_data_2026-04.oas.yaml"},"subdomain":"pinecone","siteName":"Pinecone Docs","title":"Chat with an assistant - Pinecone Docs","navMaps":{"firstHrefInVersion":{"2026-07 (latest)":{"href":"/reference/api/2026-07/assistant/chat_assistant","matchLevel":1},"2026-04":{"href":"/reference/api/2026-04/assistant/chat_assistant","matchLevel":0},"2025-10":{"href":"/reference/api/2025-10/assistant/chat_assistant","matchLevel":1},"2025-04":{"href":"/reference/api/2025-04/assistant/chat_assistant","matchLevel":1},"2025-01":{"href":"/reference/api/2025-01/assistant/chat_assistant","matchLevel":1},"2024-10":{"href":"/reference/api/introduction","matchLevel":4},"2024-07":{"href":"/reference/api/introduction","matchLevel":4},"2024-04":{"href":"/reference/api/introduction","matchLevel":4}},"firstHrefInLanguage":{}},"lastModified":"2026-03-29T17:45:36.877Z","originalFileLocation":"reference/api/2026-04/assistant/chat_assistant.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=\"Chat with an assistant and get back citations in structured form. This is the recommended way to chat with an assistant, as it offers more functionality and control over the assistant\u0026#x27;s responses and references than the OpenAI-compatible chat interface. For guidance and examples, see Chat with an assistant.\">\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=\"Chat with an assistant - Pinecone Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Chat with an assistant and get back citations in structured form. This is the recommended way to chat with an assistant, as it offers more functionality and control over the assistant\u0026#x27;s responses and references than the OpenAI-compatible chat interface. For guidance and examples, see Chat with an assistant.\">\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-04/assistant/chat_assistant\">\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-04/assistant/chat_assistant\">\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-04/assistant/chat_assistant.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-04/assistant/chat_assistant#webpage\",\"url\":\"https://docs.pinecone.io/reference/api/2026-04/assistant/chat_assistant\",\"name\":\"Chat with an assistant\",\"description\":\"Chat with an assistant and get back citations in structured form. This is the recommended way to chat with an assistant, as it offers more functionality and control over the assistant's responses and references than the OpenAI-compatible chat interface. For guidance and examples, see Chat with an assistant.\",\"dateModified\":\"2026-03-29T17:45:36.877Z\",\"isPartOf\":{\"@id\":\"https://docs.pinecone.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.pinecone.io/reference/api/2026-04/assistant/chat_assistant#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.pinecone.io/reference/api/2026-04/assistant/chat_assistant#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Pinecone Docs\",\"item\":\"https://docs.pinecone.io\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Chat with an assistant\",\"item\":\"https://docs.pinecone.io/reference/api/2026-04/assistant/chat_assistant\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.pinecone.io/reference/api/2026-04/assistant/chat_assistant#apireference\",\"headline\":\"Chat with an assistant\",\"name\":\"Chat with an assistant\",\"description\":\"Chat with an assistant and get back citations in structured form. This is the recommended way to chat with an assistant, as it offers more functionality and control over the assistant's responses and references than the OpenAI-compatible chat interface. For guidance and examples, see Chat with an assistant.\",\"url\":\"https://docs.pinecone.io/reference/api/2026-04/assistant/chat_assistant\",\"mainEntityOfPage\":{\"@id\":\"https://docs.pinecone.io/reference/api/2026-04/assistant/chat_assistant#webpage\"},\"image\":\"https://www.pinecone.io/images/docs_og_image_v2.png\",\"dateModified\":\"2026-03-29T17:45:36.877Z\",\"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","groups":[{"group":"Get started","pages":[{"title":"Pinecone Database","sidebarTitle":"Overview","mode":"wide","href":"/guides/get-started/overview"},{"group":"Quickstart","pages":[{"title":"Pinecone quickstart","sidebarTitle":"Overview","href":"/guides/get-started/quickstart"},{"title":"Ingest your own files","href":"/guides/get-started/quickstart/ingest-files"},{"title":"Bring your own vectors","href":"/guides/get-started/quickstart/bring-your-own-vectors"},{"title":"Try full-text search","href":"/guides/get-started/quickstart/full-text-search"}]},{"title":"Pinecone key terms","sidebarTitle":"Key terms","href":"/guides/get-started/key-terms"},{"title":"Pinecone architecture","sidebarTitle":"Architecture","href":"/guides/get-started/architecture"}]},{"group":"Indexes","pages":[{"title":"Index data overview","sidebarTitle":"Overview","href":"/guides/indexes/index-data-overview"},{"title":"Move to the Documents API","sidebarTitle":"Move to the Documents API","href":"/guides/indexes/move-to-the-documents-api"},{"group":"Create and configure","pages":[{"title":"Create an index","sidebarTitle":"Create an index","href":"/guides/indexes/create-an-index"},{"title":"Convert an index to a document index","sidebarTitle":"Convert an index","href":"/guides/indexes/convert-an-index"},{"title":"Index configuration","sidebarTitle":"Index configuration","href":"/guides/indexes/index-configuration"},{"title":"Processing locations","href":"/guides/indexes/processing-locations"},{"title":"Configure metadata indexing","href":"/guides/indexes/configure-metadata-indexing"},{"title":"Manage serverless indexes","sidebarTitle":"Manage indexes","href":"/guides/indexes/manage-indexes"}]},{"title":"Target an index","href":"/guides/indexes/target-an-index"},{"title":"Data modeling","href":"/guides/indexes/data-modeling"},{"group":"Backups","pages":[{"title":"Backups overview","href":"/guides/indexes/backups-overview"},{"title":"Back up an index","href":"/guides/indexes/back-up-an-index"},{"title":"Restore an index","href":"/guides/indexes/restore-an-index"}]}]},{"group":"Data","pages":[{"group":"Ingestion","pages":[{"title":"Data ingestion overview","sidebarTitle":"Overview","href":"/guides/data/data-ingestion-overview"},{"title":"Upsert data","href":"/guides/data/upsert-data"},{"title":"Import data","href":"/guides/data/import-data"},{"group":"Integrate with cloud storage","pages":[{"title":"Integrate with Amazon S3","icon":"aws","sidebarTitle":"Amazon S3","href":"/guides/storage-integrations/integrate-with-amazon-s3"},{"title":"Integrate with Google Cloud Storage","icon":"google","sidebarTitle":"Google Cloud Storage (GCS)","href":"/guides/storage-integrations/integrate-with-google-cloud-storage"},{"title":"Integrate with Azure Blob Storage","icon":"microsoft","sidebarTitle":"Azure Blob Storage","href":"/guides/storage-integrations/integrate-with-azure-blob-storage"},{"title":"Manage storage integrations","href":"/guides/storage-integrations/manage-storage-integrations"}]},{"title":"Migrate from pgvector","href":"/guides/data/migrate-from-pgvector"},{"title":"Check data freshness","href":"/guides/data/check-data-freshness"}]},{"group":"Namespaces","pages":[{"title":"Manage namespaces","href":"/guides/data/manage-namespaces"},{"group":"Aliases","pages":[{"title":"Namespace aliases overview","sidebarTitle":"Overview","href":"/guides/data/namespace-aliases/overview"},{"title":"Swap a namespace without downtime","sidebarTitle":"Swap a namespace","href":"/guides/data/namespace-aliases/swap-a-namespace"},{"title":"Manage namespace aliases","sidebarTitle":"Manage aliases","href":"/guides/data/namespace-aliases/manage-aliases"}]}]},{"group":"Multitenancy","pages":[{"title":"Design for multitenancy","sidebarTitle":"Design","href":"/guides/data/design-for-multitenancy"},{"title":"Implement multitenancy","sidebarTitle":"Implement","href":"/guides/data/implement-multitenancy"}]},{"group":"Documents and records","pages":[{"title":"Fetch data","href":"/guides/data/fetch-data"},{"title":"List IDs","href":"/guides/data/list-record-ids"},{"title":"Update data","href":"/guides/data/update-data"},{"title":"Delete data","href":"/guides/data/delete-data"},{"title":"Manage document chunks","href":"/guides/data/manage-document-chunks"}]}]},{"group":"Search","pages":[{"title":"Search overview","sidebarTitle":"Overview","href":"/guides/search/search-overview"},{"group":"Full-text search","pages":[{"title":"Full-text search overview","sidebarTitle":"Overview","href":"/guides/search/full-text-search"},{"title":"Full-text search query syntax","sidebarTitle":"Query syntax","href":"/guides/search/full-text-search/query-syntax"},{"title":"Full-text search text processing","sidebarTitle":"Text processing","href":"/guides/search/full-text-search/text-processing"}]},{"title":"Semantic search","href":"/guides/search/semantic-search"},{"group":"Hybrid search","pages":[{"title":"Hybrid search overview","sidebarTitle":"Overview","href":"/guides/search/hybrid-search"},{"title":"Reciprocal rank fusion","href":"/guides/search/reciprocal-rank-fusion"}]},{"title":"Sparse-vector search","href":"/guides/search/sparse-vector-search"},{"title":"Integrated embedding","href":"/guides/search/integrated-embedding"},{"title":"Filter by metadata","href":"/guides/search/filter-by-metadata"},{"title":"Rerank results","href":"/guides/search/rerank-results"}]},{"group":"Optimize","pages":[{"title":"Increase search relevance","sidebarTitle":"Increase relevance","href":"/guides/optimize/increase-relevance"},{"title":"Diagnose poor search results","href":"/guides/optimize/debug-recall"},{"title":"Increase throughput","href":"/guides/optimize/increase-throughput"},{"title":"Decrease latency","href":"/guides/optimize/decrease-latency"},{"title":"Test Pinecone at scale","sidebarTitle":"Test at scale","href":"/guides/optimize/test-at-scale"},{"group":"Dedicated read nodes","pages":[{"title":"Dedicated read nodes overview","sidebarTitle":"Overview","href":"/guides/optimize/dedicated-read-nodes/overview"},{"title":"Dedicated read nodes concepts","sidebarTitle":"Concepts","href":"/guides/optimize/dedicated-read-nodes/concepts"},{"title":"Create a dedicated read nodes index","sidebarTitle":"Create","href":"/guides/optimize/dedicated-read-nodes/create"},{"title":"Migrate to dedicated read nodes","sidebarTitle":"Migrate","href":"/guides/optimize/dedicated-read-nodes/migrate"},{"title":"Size and test a dedicated read nodes index","sidebarTitle":"Size and test","href":"/guides/optimize/dedicated-read-nodes/size-and-test"},{"title":"Tune queries on dedicated read nodes","sidebarTitle":"Tune queries","href":"/guides/optimize/dedicated-read-nodes/tune-queries"},{"title":"Scale a dedicated read nodes index","sidebarTitle":"Scale","href":"/guides/optimize/dedicated-read-nodes/scale"},{"title":"Manage a dedicated read nodes index","sidebarTitle":"Manage","href":"/guides/optimize/dedicated-read-nodes/manage"}]}]},{"group":"Cost","pages":[{"title":"Understand Pinecone cost","href":"/guides/cost/understand-cost"},{"title":"Save on Pinecone costs","href":"/guides/cost/save-on-costs"},{"title":"Set monthly spend alerts","href":"/guides/cost/set-spend-alerts"},{"title":"Check usage per request","href":"/guides/cost/check-usage-per-request"},{"title":"Download a usage report","url":"/admin/billing/download-usage-report","href":"/guides/cost/download-usage-report-link"}]},{"group":"Production","pages":[{"title":"Production checklist","sidebarTitle":"Overview","href":"/guides/production/production-checklist"},{"group":"Bring Your Own Cloud (BYOC)","pages":[{"title":"Bring Your Own Cloud (BYOC) overview","sidebarTitle":"Overview","href":"/guides/production/bring-your-own-cloud"},{"title":"Deploy BYOC","sidebarTitle":"Deploy","href":"/guides/production/bring-your-own-cloud/deploy"},{"title":"Create an index in BYOC","sidebarTitle":"Create an index","href":"/guides/production/bring-your-own-cloud/create-an-index"},{"title":"Connect to and manage BYOC","sidebarTitle":"Connect and manage","href":"/guides/production/bring-your-own-cloud/connect-and-manage"}]},{"group":"Data security","pages":[{"title":"Configure customer-managed encryption keys","sidebarTitle":"Configure CMEK","href":"/guides/production/configure-cmek"},{"title":"Configure private endpoints","sidebarTitle":"Configure private endpoints","href":"/guides/production/configure-private-endpoints"},{"title":"Data deletion on Pinecone","sidebarTitle":"Data deletion policy","href":"/guides/production/data-deletion"}]},{"title":"Error handling","href":"/guides/production/error-handling"},{"title":"Mock the Pinecone API for testing","sidebarTitle":"Mock the API for testing","href":"/guides/production/mock-the-api"},{"title":"Monitor performance","href":"/guides/production/monitor-performance"}]},{"group":"Agents","pages":[{"title":"Use the Pinecone MCP server","sidebarTitle":"Use the MCP server","href":"/guides/agents/mcp-server"},{"title":"Build a knowledge retrieval agent","href":"/guides/agents/build-a-knowledge-agent"}]},{"group":"Legacy","pages":[{"group":"Vectors API","pages":[{"title":"Create a legacy vector index","sidebarTitle":"Create a vector index","href":"/guides/legacy/vectors-api/create-a-vector-index"},{"title":"Upsert vectors into a legacy vector index","sidebarTitle":"Upsert vectors","href":"/guides/legacy/vectors-api/upsert-vectors"},{"title":"Import vectors into a legacy vector index","sidebarTitle":"Import vectors","href":"/guides/legacy/vectors-api/import-vectors"},{"title":"Query a legacy vector index","sidebarTitle":"Query vectors","href":"/guides/legacy/vectors-api/query-vectors"},{"title":"Fetch vectors from a legacy vector index","sidebarTitle":"Fetch vectors","href":"/guides/legacy/vectors-api/fetch-vectors"},{"title":"Update vectors in a legacy vector index","sidebarTitle":"Update vectors","href":"/guides/legacy/vectors-api/update-vectors"},{"title":"Delete vectors from a legacy vector index","sidebarTitle":"Delete vectors","href":"/guides/legacy/vectors-api/delete-vectors"},{"title":"List vector IDs in a legacy vector index","sidebarTitle":"List vector IDs","href":"/guides/legacy/vectors-api/list-vector-ids"},{"title":"Manage chunked records in a legacy index","sidebarTitle":"Manage chunked records","href":"/guides/legacy/vectors-api/manage-chunked-records"},{"title":"Run hybrid search on a legacy vector index","sidebarTitle":"Hybrid search on a single index","href":"/guides/legacy/vectors-api/hybrid-search-single-index"},{"title":"Run hybrid search on two legacy vector indexes","sidebarTitle":"Hybrid search on separate indexes","href":"/guides/legacy/vectors-api/hybrid-search-separate-indexes"}]},{"group":"Records API","pages":[{"title":"Create a legacy integrated index","sidebarTitle":"Create an integrated index","href":"/guides/legacy/records-api/create-an-integrated-index"},{"title":"Upsert text into a legacy integrated index","sidebarTitle":"Upsert text","href":"/guides/legacy/records-api/upsert-text"},{"title":"Search a legacy integrated index with text","sidebarTitle":"Search with text","href":"/guides/legacy/records-api/search-with-text"}]},{"group":"Pod-based indexes","pages":[{"title":"Understanding pod-based indexes","sidebarTitle":"Overview","href":"/guides/legacy/pod-based-indexes/understanding-pod-based-indexes"},{"title":"Migrate a pod-based index to serverless","href":"/guides/legacy/pod-based-indexes/migrate-a-pod-based-index-to-serverless"},{"title":"Choose a pod type and size","sidebarTitle":"Choose a pod type","href":"/guides/legacy/pod-based-indexes/choose-a-pod-type-and-size"},{"title":"Create a pod-based index","href":"/guides/legacy/pod-based-indexes/create-a-pod-based-index"},{"title":"Manage pod-based indexes","href":"/guides/legacy/pod-based-indexes/manage-pod-based-indexes"},{"title":"Scale pod-based indexes","href":"/guides/legacy/pod-based-indexes/scale-pod-based-indexes"},{"group":"Backups","pages":[{"title":"Understanding collections","href":"/guides/legacy/pod-based-indexes/understanding-collections"},{"title":"Back up a pod-based index","href":"/guides/legacy/pod-based-indexes/back-up-a-pod-based-index"},{"title":"Restore a pod-based index","href":"/guides/legacy/pod-based-indexes/restore-a-pod-based-index"}]}]}]}]},{"tab":"Reference","versions":[{"version":"2026-07 (latest)","default":true,"pages":[{"title":"2026-07 (latest)","href":"/reference/api/introduction"}]},{"version":"2026-04","groups":[{"group":"APIs","pages":[{"title":"API reference","sidebarTitle":"Introduction","href":"/reference/api/introduction"},{"title":"Pinecone API authentication","sidebarTitle":"Authentication","href":"/reference/api/authentication"},{"title":"Pinecone API versioning","sidebarTitle":"Versioning","href":"/reference/api/versioning"},{"group":"Database limits","pages":[{"title":"Pinecone Database limits overview","sidebarTitle":"Overview","href":"/reference/api/database-limits"},{"title":"Rate limits","sidebarTitle":"Rate limits","href":"/reference/api/database-limits/rate-limits"},{"title":"Object limits","sidebarTitle":"Object limits","href":"/reference/api/database-limits/object-limits"},{"title":"Operation limits","sidebarTitle":"Operation limits","href":"/reference/api/database-limits/operation-limits"},{"title":"Identifier limits","sidebarTitle":"Identifier limits","href":"/reference/api/database-limits/identifier-limits"},{"title":"Known limitations","href":"/reference/api/known-limitations"}]},{"title":"Pinecone API errors","sidebarTitle":"Errors","href":"/reference/api/errors"}]},{"group":"Database","pages":[{"group":"Indexes","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_control_2026-04.oas.yaml get /indexes","title":"List indexes","href":"/reference/api/2026-04/control-plane/list_indexes"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_control_2026-04.oas.yaml post /indexes","title":"Create an index","href":"/reference/api/2026-04/control-plane/create_index"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_control_2026-04.oas.yaml post /indexes/create-for-model","title":"Create an index with integrated embedding","href":"/reference/api/2026-04/control-plane/create_for_model"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_control_2026-04.oas.yaml get /indexes/{index_name}","title":"Describe an index","href":"/reference/api/2026-04/control-plane/describe_index"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_control_2026-04.oas.yaml delete /indexes/{index_name}","title":"Delete an index","href":"/reference/api/2026-04/control-plane/delete_index"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_control_2026-04.oas.yaml patch /indexes/{index_name}","title":"Configure an index","href":"/reference/api/2026-04/control-plane/configure_index"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_data_2026-04.oas.yaml post /describe_index_stats","title":"Get index stats","href":"/reference/api/2026-04/data-plane/describeindexstats"}]},{"group":"Namespaces","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_data_2026-04.oas.yaml get /namespaces","title":"List namespaces","href":"/reference/api/2026-04/data-plane/listnamespaces"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_data_2026-04.oas.yaml post /namespaces","title":"Create a namespace","href":"/reference/api/2026-04/data-plane/createnamespace"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_data_2026-04.oas.yaml get /namespaces/{namespace}","title":"Describe a namespace","href":"/reference/api/2026-04/data-plane/describenamespace"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_data_2026-04.oas.yaml delete /namespaces/{namespace}","title":"Delete a namespace","href":"/reference/api/2026-04/data-plane/deletenamespace"}]},{"group":"Vectors","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_data_2026-04.oas.yaml post /vectors/upsert","title":"Upsert records","href":"/reference/api/2026-04/data-plane/upsert"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_data_2026-04.oas.yaml post /records/namespaces/{namespace}/upsert","title":"Upsert text","href":"/reference/api/2026-04/data-plane/upsert_records"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_data_2026-04.oas.yaml get /vectors/fetch","title":"Fetch records","href":"/reference/api/2026-04/data-plane/fetch"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_data_2026-04.oas.yaml post /vectors/fetch_by_metadata","title":"Fetch records by metadata","href":"/reference/api/2026-04/data-plane/fetch_by_metadata"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_data_2026-04.oas.yaml post /vectors/update","title":"Update a record","href":"/reference/api/2026-04/data-plane/update"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_data_2026-04.oas.yaml post /vectors/delete","title":"Delete records","href":"/reference/api/2026-04/data-plane/delete"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_data_2026-04.oas.yaml get /vectors/list","title":"List record IDs","href":"/reference/api/2026-04/data-plane/list"}]},{"group":"Search","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_data_2026-04.oas.yaml post /query","title":"Search with a vector","href":"/reference/api/2026-04/data-plane/query"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_data_2026-04.oas.yaml post /records/namespaces/{namespace}/search","title":"Search with text","href":"/reference/api/2026-04/data-plane/search_records"}]},{"group":"Imports","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_data_2026-04.oas.yaml post /bulk/imports","title":"Start import","href":"/reference/api/2026-04/data-plane/start_import"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_data_2026-04.oas.yaml get /bulk/imports","title":"List imports","href":"/reference/api/2026-04/data-plane/list_imports"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_data_2026-04.oas.yaml get /bulk/imports/{id}","title":"Describe an import","href":"/reference/api/2026-04/data-plane/describe_import"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_data_2026-04.oas.yaml delete /bulk/imports/{id}","title":"Cancel an import","href":"/reference/api/2026-04/data-plane/cancel_import"}]},{"group":"Backups","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_control_2026-04.oas.yaml post /indexes/{index_name}/backups","title":"Create a backup of an index","href":"/reference/api/2026-04/control-plane/create_backup"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_control_2026-04.oas.yaml get /backups","title":"List backups for all indexes in a project","href":"/reference/api/2026-04/control-plane/list_project_backups"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_control_2026-04.oas.yaml get /indexes/{index_name}/backups","title":"List backups for an index","href":"/reference/api/2026-04/control-plane/list_index_backups"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_control_2026-04.oas.yaml get /backups/{backup_id}","title":"Describe a backup","href":"/reference/api/2026-04/control-plane/describe_backup"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_control_2026-04.oas.yaml delete /backups/{backup_id}","title":"Delete a backup","href":"/reference/api/2026-04/control-plane/delete_backup"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_control_2026-04.oas.yaml post /backups/{backup_id}/create-index","title":"Create an index from a backup","href":"/reference/api/2026-04/control-plane/create_index_from_backup"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_control_2026-04.oas.yaml get /restore-jobs","title":"List restore jobs","href":"/reference/api/2026-04/control-plane/list_restore_jobs"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_control_2026-04.oas.yaml get /restore-jobs/{job_id}","title":"Describe a restore job","href":"/reference/api/2026-04/control-plane/describe_restore_job"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_control_2026-04.oas.yaml get /collections","title":"List collections","href":"/reference/api/2026-04/control-plane/list_collections"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_control_2026-04.oas.yaml post /collections","title":"Create a collection","href":"/reference/api/2026-04/control-plane/create_collection"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_control_2026-04.oas.yaml get /collections/{collection_name}","title":"Describe a collection","href":"/reference/api/2026-04/control-plane/describe_collection"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/db_control_2026-04.oas.yaml delete /collections/{collection_name}","title":"Delete a collection","href":"/reference/api/2026-04/control-plane/delete_collection"}]},{"group":"Backup schedules","pages":[{"title":"Create backup schedule","sidebarTitle":"Create backup schedule","api":"POST https://api.pinecone.io/indexes/{index_name}/backup-schedules","href":"/reference/api/2026-04/control-plane/create_backup_schedule"},{"title":"List backup schedules","sidebarTitle":"List backup schedules","api":"GET https://api.pinecone.io/indexes/{index_name}/backup-schedules","href":"/reference/api/2026-04/control-plane/list_backup_schedules"},{"title":"Describe backup schedule","sidebarTitle":"Describe backup schedule","api":"GET https://api.pinecone.io/backup-schedules/{schedule_id}","href":"/reference/api/2026-04/control-plane/describe_backup_schedule"},{"title":"Update backup schedule","sidebarTitle":"Update backup schedule","api":"PATCH https://api.pinecone.io/backup-schedules/{schedule_id}","href":"/reference/api/2026-04/control-plane/update_backup_schedule"},{"title":"Delete backup schedule","sidebarTitle":"Delete backup schedule","api":"DELETE https://api.pinecone.io/backup-schedules/{schedule_id}","href":"/reference/api/2026-04/control-plane/delete_backup_schedule"},{"title":"List backup schedule history","sidebarTitle":"List schedule history","api":"GET https://api.pinecone.io/backup-schedules/{schedule_id}/history","href":"/reference/api/2026-04/control-plane/list_backup_schedule_history"}]}]},{"group":"Inference","pages":[{"group":"Embed","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/inference_2026-04.oas.yaml post /embed","title":"Generate vectors","href":"/reference/api/2026-04/inference/generate-embeddings"}]},{"group":"Rerank","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/inference_2026-04.oas.yaml post /rerank","title":"Rerank results","href":"/reference/api/2026-04/inference/rerank"}]},{"group":"Models","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/inference_2026-04.oas.yaml get /models","title":"List available models","href":"/reference/api/2026-04/inference/list_models"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/inference_2026-04.oas.yaml get /models/{model_name}","title":"Describe a model","href":"/reference/api/2026-04/inference/describe_model"}]}]},{"group":"Admin","pages":[{"group":"API keys","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml post /admin/projects/{project_id}/api-keys","title":"Create an API key","href":"/reference/api/2026-04/admin/create_api_key"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml get /admin/projects/{project_id}/api-keys","title":"List API keys","href":"/reference/api/2026-04/admin/list_api_keys"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml get /admin/api-keys/{api_key_id}","title":"Get API key details","href":"/reference/api/2026-04/admin/fetch_api_key"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml patch /admin/api-keys/{api_key_id}","title":"Update an API key","href":"/reference/api/2026-04/admin/update_api_key"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml delete /admin/api-keys/{api_key_id}","title":"Delete an API key","href":"/reference/api/2026-04/admin/delete_api_key"}]},{"group":"Projects","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml post /admin/projects","title":"Create a new project","href":"/reference/api/2026-04/admin/create_project"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml get /admin/projects","title":"List projects","href":"/reference/api/2026-04/admin/list_projects"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml get /admin/projects/{project_id}","title":"Get project details","href":"/reference/api/2026-04/admin/fetch_project"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml patch /admin/projects/{project_id}","title":"Update a project","href":"/reference/api/2026-04/admin/update_project"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml delete /admin/projects/{project_id}","title":"Delete a project","href":"/reference/api/2026-04/admin/delete_project"}]},{"group":"Service accounts","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml post /admin/service-accounts","title":"Create a service account","href":"/reference/api/2026-04/admin/create_service_account"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml get /admin/service-accounts","title":"List service accounts","href":"/reference/api/2026-04/admin/list_service_accounts"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml get /admin/service-accounts/{service_account_id}","title":"Get service account details","href":"/reference/api/2026-04/admin/fetch_service_account"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml patch /admin/service-accounts/{service_account_id}","title":"Update a service account","href":"/reference/api/2026-04/admin/update_service_account"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml delete /admin/service-accounts/{service_account_id}","title":"Delete a service account","href":"/reference/api/2026-04/admin/delete_service_account"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml post /admin/service-accounts/{service_account_id}/rotate-secret","title":"Rotate a service account's OAuth client secret","href":"/reference/api/2026-04/admin/rotate_service_account_secret"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/oauth_2026-04.oas.yaml post /oauth/token","title":"Create an access token","href":"/reference/api/2026-04/admin/get_token"}]},{"group":"Users","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml get /admin/users","title":"List users in the organization","href":"/reference/api/2026-04/admin/list_users"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml get /admin/users/{user_id}","title":"Get user details","href":"/reference/api/2026-04/admin/fetch_user"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml delete /admin/users/{user_id}","title":"Remove a user from the organization","href":"/reference/api/2026-04/admin/delete_user"}]},{"group":"Invites","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml post /admin/invites","title":"Invite a user to the organization","href":"/reference/api/2026-04/admin/create_invite"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml get /admin/invites","title":"List invites","href":"/reference/api/2026-04/admin/list_invites"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml get /admin/invites/{invite_id}","title":"Get invite details","href":"/reference/api/2026-04/admin/fetch_invite"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml delete /admin/invites/{invite_id}","title":"Delete an invite","href":"/reference/api/2026-04/admin/delete_invite"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml post /admin/invites/{invite_id}/resend","title":"Resend an invite email","href":"/reference/api/2026-04/admin/resend_invite"}]},{"group":"Role bindings","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml post /admin/role-bindings","title":"Create a role binding","href":"/reference/api/2026-04/admin/create_role_binding"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml get /admin/role-bindings","title":"List role bindings","href":"/reference/api/2026-04/admin/list_role_bindings"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml get /admin/role-bindings/{role_binding_id}","title":"Get role binding details","href":"/reference/api/2026-04/admin/fetch_role_binding"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml delete /admin/role-bindings/{role_binding_id}","title":"Delete a role binding","href":"/reference/api/2026-04/admin/delete_role_binding"}]}]},{"group":"SDKs","pages":[{"title":"Pinecone SDKs overview","href":"/reference/pinecone-sdks"},{"group":"Python","pages":[{"title":"Pinecone Python SDK","sidebarTitle":"Overview","href":"/reference/sdks/python/overview"},{"title":"Reference","url":"https://sdk.pinecone.io/python/","href":"/reference/sdks/python/reference"}]},{"group":"Node.js","pages":[{"title":"Pinecone Node.js SDK","sidebarTitle":"Overview","href":"/reference/sdks/node/overview"},{"title":"Reference","url":"https://sdk.pinecone.io/typescript/","href":"/reference/sdks/node/reference"}]},{"group":"Java","pages":[{"title":"Pinecone Java SDK","sidebarTitle":"Overview","href":"/reference/sdks/java/overview"},{"title":"Reference","url":"https://github.com/pinecone-io/pinecone-java-client","href":"/reference/sdks/java/reference"},{"title":"OpenTelemetry support","sidebarTitle":"OpenTelemetry","href":"/reference/sdks/java/open-telemetry"}]},{"group":"Go","pages":[{"title":"Pinecone Go SDK","sidebarTitle":"Overview","href":"/reference/sdks/go/overview"},{"title":"Reference","url":"https://github.com/pinecone-io/go-pinecone","href":"/reference/sdks/go/reference"}]}]},{"group":"CLI","pages":[{"title":"CLI quickstart","sidebarTitle":"Quickstart","href":"/reference/cli/quickstart"},{"title":"CLI command reference","sidebarTitle":"Command reference","href":"/reference/cli/command-reference"},{"title":"CLI authentication","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":"2025-10","pages":[{"title":"2025-10","href":"/reference/api/introduction"}]},{"version":"2025-04","pages":[{"title":"2025-04","href":"/reference/api/introduction"}]},{"version":"2025-01","pages":[{"title":"2025-01","href":"/reference/api/introduction"}]},{"version":"2024-10","pages":[{"title":"2024-10","href":"/reference/api/introduction"}]},{"version":"2024-07","pages":[{"title":"2024-07","href":"/reference/api/introduction"}]},{"version":"2024-04","pages":[{"title":"2024-04","href":"/reference/api/introduction"}]}]},{"tab":"Examples","groups":[{"group":"Examples","pages":[{"title":"Notebooks","href":"/examples/notebooks"},{"title":"Sample apps","href":"/examples/sample-apps"},{"title":"Reference architectures","href":"/examples/reference-architectures"}]}]},{"tab":"Models","groups":[{"group":"Models","pages":[{"title":"Model gallery","href":"/models/overview"}]}]},{"tab":"Integrations","groups":[{"group":"Connect an integration","pages":[{"title":"Integrations overview","sidebarTitle":"All integrations","href":"/integrations/overview"},{"group":"AI coding tools","pages":[{"title":"AI coding tools","sidebarTitle":"Overview","href":"/integrations/ai-coding-tools"},{"title":"Agent Skills","href":"/integrations/agent-skills"},{"title":"Claude Code plugin","href":"/integrations/claude-code"},{"title":"Codex plugin","href":"/integrations/codex"},{"title":"Cursor plugin","href":"/integrations/cursor"}]},{"group":"Data sources","pages":[{"title":"Airbyte","href":"/integrations/airbyte"},{"title":"Apify","href":"/integrations/apify"},{"title":"Aryn","href":"/integrations/aryn"},{"title":"Box","href":"/integrations/box"},{"title":"Confluent","href":"/integrations/confluent"},{"title":"Databricks","href":"/integrations/databricks"},{"title":"Estuary","href":"/integrations/estuary"},{"title":"Fleak","href":"/integrations/fleak"},{"title":"FlowiseAI","href":"/integrations/flowise"},{"title":"Gathr","href":"/integrations/gathr"},{"title":"Matillion","href":"/integrations/matillion"},{"title":"Nexla","href":"/integrations/nexla"},{"title":"Redpanda","href":"/integrations/redpanda"},{"title":"Snowflake Openflow","href":"/integrations/snowflake-openflow"},{"title":"StreamNative","href":"/integrations/streamnative"},{"title":"Unstructured","href":"/integrations/unstructured"}]},{"group":"Frameworks","pages":[{"title":"AI Engine","href":"/integrations/ai-engine"},{"title":"Amazon Bedrock","href":"/integrations/amazon-bedrock"},{"title":"Amazon SageMaker","href":"/integrations/amazon-sagemaker"},{"title":"Cloudera AI","href":"/integrations/cloudera"},{"title":"Context Data","href":"/integrations/context-data"},{"title":"Genkit","href":"/integrations/genkit"},{"title":"Haystack","href":"/integrations/haystack"},{"title":"Instill AI","href":"/integrations/instill"},{"title":"LangChain","href":"/integrations/langchain"},{"title":"LlamaIndex","href":"/integrations/llamaindex"},{"title":"n8n","href":"/integrations/n8n"},{"title":"Progress Agentic RAG","href":"/integrations/progress-agentic-rag"},{"title":"VoltAgent","href":"/integrations/voltagent"}]},{"group":"Infrastructure","pages":[{"title":"AWS Marketplace","href":"/integrations/aws-marketplace"},{"title":"Google Cloud Marketplace","href":"/integrations/google-cloud-marketplace"},{"title":"Microsoft Marketplace","href":"/integrations/microsoft-marketplace"},{"title":"Pulumi","href":"/integrations/pulumi"},{"title":"Terraform","href":"/integrations/terraform"},{"title":"Vercel","href":"/integrations/vercel"},{"title":"Zapier","href":"/integrations/zapier"}]},{"group":"Models","pages":[{"title":"Cohere","href":"/integrations/cohere"},{"title":"Voyage AI","href":"/integrations/voyage"},{"title":"Hugging Face Inference Endpoints","href":"/integrations/hugging-face-inference-endpoints"},{"title":"Jina AI","href":"/integrations/jina"},{"title":"OpenAI","href":"/integrations/openai"},{"title":"Twelve Labs","href":"/integrations/twelve-labs"}]},{"group":"Observability","pages":[{"title":"Datadog","href":"/integrations/datadog"},{"title":"HoneyHive","href":"/integrations/honeyhive"},{"title":"New Relic","href":"/integrations/new-relic"},{"title":"Traceloop","href":"/integrations/traceloop"},{"title":"TruLens","href":"/integrations/trulens"}]}]},{"group":"Build an integration","pages":[{"title":"Integration ecosystem","href":"/integrations/build-integration/integration-ecosystem"},{"title":"Attribute usage to your integration","href":"/integrations/build-integration/attribute-usage-to-your-integration"},{"title":"Connect your users to Pinecone","href":"/integrations/build-integration/connect-your-users-to-pinecone"}]}]},{"tab":"Admin","groups":[{"group":"Organizations","pages":[{"title":"Organizations overview","sidebarTitle":"Overview","href":"/admin/organizations/organizations-overview"},{"title":"Manage organization members","sidebarTitle":"Manage members","href":"/admin/organizations/manage-organization-members"},{"title":"Manage organization service accounts","sidebarTitle":"Manage service accounts","href":"/admin/organizations/manage-service-accounts"},{"title":"Delete your organization","href":"/admin/organizations/delete-your-organization"}]},{"group":"Projects","pages":[{"title":"Projects overview","sidebarTitle":"Overview","href":"/admin/projects/projects-overview"},{"title":"Create a project","mode":"wide","href":"/admin/projects/create-a-project"},{"title":"Manage projects","href":"/admin/projects/manage-projects"},{"title":"Manage project members","href":"/admin/projects/manage-project-members"},{"title":"Manage API keys","href":"/admin/projects/manage-api-keys"},{"title":"Manage project service accounts","sidebarTitle":"Manage service accounts","href":"/admin/projects/manage-service-accounts"}]},{"group":"Billing","pages":[{"title":"Upgrade your billing plan","href":"/admin/billing/upgrade-billing-plan"},{"title":"Redeem a promo code","href":"/admin/billing/redeem-a-promo-code"},{"title":"Change your payment method","href":"/admin/billing/change-payment-method"},{"title":"Account deactivation for non-payment","href":"/admin/billing/non-payment-account-deactivation"},{"title":"Downgrade your billing plan","href":"/admin/billing/downgrade-billing-plan"},{"title":"Download a usage report","href":"/admin/billing/download-usage-report"},{"title":"Access your invoices","href":"/admin/billing/access-your-invoices"},{"title":"Pinecone Standard plan trial","href":"/admin/billing/standard-trial"},{"title":"Billing disputes and refunds","href":"/admin/billing/billing-disputes-and-refunds"}]},{"group":"Security","pages":[{"title":"Security overview","sidebarTitle":"Overview","href":"/admin/security/security-overview"},{"title":"Manage roles and access","sidebarTitle":"Manage roles and access","href":"/admin/security/manage-rbac"},{"group":"Single sign-on","pages":[{"title":"Configure SSO with Okta","href":"/admin/security/configure-single-sign-on/okta"},{"title":"Manage roles with Okta","sidebarTitle":"Manage roles with Okta","href":"/admin/security/configure-single-sign-on/okta-role-management"},{"title":"SCIM provisioning with Okta","sidebarTitle":"SCIM provisioning with Okta","href":"/admin/security/configure-single-sign-on/okta-scim-provisioning"}]},{"title":"Configure audit logs","href":"/admin/security/configure-audit-logs"}]},{"group":"Account and support","pages":[{"title":"Get help with Pinecone","sidebarTitle":"Get help","href":"/admin/support/contact-support"},{"title":"Support plans and SLAs","href":"/admin/support/pinecone-support-slas"},{"title":"Login code issues","href":"/admin/account/login-code-issues"},{"title":"Custom data processing agreements","href":"/admin/account/custom-data-processing-agreements"},{"title":"Delete your account","href":"/admin/account/delete-your-account"}]}]}]},{"dropdown":"Pinecone Assistant","icon":"comments","tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/guides/assistant/overview"}]},{"tab":"Reference","versions":[{"version":"2026-07 (latest)","default":true,"pages":[{"title":"2026-07 (latest)","href":"/reference/api/2026-07/assistant/chat_assistant"}]},{"version":"2026-04","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-04/assistant_control_2026-04.oas.yaml GET /assistants","title":"List assistants","href":"/reference/api/2026-04/assistant/list_assistants"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/assistant_control_2026-04.oas.yaml POST /assistants","title":"Create an assistant","href":"/reference/api/2026-04/assistant/create_assistant"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/assistant_control_2026-04.oas.yaml GET /assistants/{assistant_name}","title":"Check assistant status","href":"/reference/api/2026-04/assistant/describe_assistant"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/assistant_control_2026-04.oas.yaml PATCH /assistants/{assistant_name}","title":"Update an assistant","href":"/reference/api/2026-04/assistant/update_assistant"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/assistant_control_2026-04.oas.yaml DELETE /assistants/{assistant_name}","title":"Delete an assistant","href":"/reference/api/2026-04/assistant/delete_assistant"}]},{"group":"Files","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/assistant_data_2026-04.oas.yaml GET /files/{assistant_name}","title":"List Files","href":"/reference/api/2026-04/assistant/list_files"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/assistant_data_2026-04.oas.yaml POST /files/{assistant_name}","title":"Upload a file","href":"/reference/api/2026-04/assistant/upload_file"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/assistant_data_2026-04.oas.yaml PUT /files/{assistant_name}/{assistant_file_id}","title":"Upsert a file","href":"/reference/api/2026-04/assistant/upsert_file"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/assistant_data_2026-04.oas.yaml GET /files/{assistant_name}/{assistant_file_id}","title":"Describe a file","href":"/reference/api/2026-04/assistant/describe_file"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/assistant_data_2026-04.oas.yaml DELETE /files/{assistant_name}/{assistant_file_id}","title":"Delete a file","href":"/reference/api/2026-04/assistant/delete_file"}]},{"group":"Operations","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/assistant_data_2026-04.oas.yaml GET /operations/{assistant_name}","title":"List operations","href":"/reference/api/2026-04/assistant/list_operations"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/assistant_data_2026-04.oas.yaml GET /operations/{assistant_name}/{operation_id}","title":"Describe an operation","description":"Get the status of an operation.\n","href":"/reference/api/2026-04/assistant/describe_operation"}]},{"group":"Chat","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/assistant_data_2026-04.oas.yaml POST /chat/{assistant_name}","title":"Chat with an assistant","href":"/reference/api/2026-04/assistant/chat_assistant"},{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/assistant_data_2026-04.oas.yaml POST /chat/{assistant_name}/chat/completions","title":"Chat through an OpenAI-compatible interface","description":"Chat with an assistant. This endpoint is based on the OpenAI Chat Completion API, a commonly used and adopted API. \n\nIt is useful if you need inline citations or OpenAI-compatible responses, but has limited functionality compared to the standard chat interface.\n\nFor guidance and examples, see [Chat with an assistant](https://docs.pinecone.io/guides/assistant/chat-with-assistant).","href":"/reference/api/2026-04/assistant/chat_completion_assistant"}]},{"group":"Evaluation","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/assistant_evaluation_2026-04.oas.yaml POST /evaluation/metrics/alignment","title":"Evaluate an answer","href":"/reference/api/2026-04/assistant/metrics_alignment"}]},{"group":"Context snippets","pages":[{"openapi":"https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/assistant_data_2026-04.oas.yaml POST /chat/{assistant_name}/context","title":"Retrieve context from an assistant","href":"/reference/api/2026-04/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":"2025-10","pages":[{"title":"2025-10","href":"/reference/api/2025-10/assistant/chat_assistant"}]},{"version":"2025-04","pages":[{"title":"2025-04","href":"/reference/api/2025-04/assistant/chat_assistant"}]},{"version":"2025-01","pages":[{"title":"2025-01","href":"/reference/api/2025-01/assistant/chat_assistant"}]}]},{"tab":"Examples","pages":[{"title":"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 terms","sidebarTitle":"Key terms","href":"/guides/nexus/concepts"},{"title":"Nexus architecture","sidebarTitle":"Architecture","href":"/guides/nexus/how-it-works"}]},{"group":"Build contexts","pages":[{"title":"Nexus context design","sidebarTitle":"Context design","href":"/guides/nexus/context-design"},{"title":"Nexus curation","sidebarTitle":"Curation","href":"/guides/nexus/how-curation-works"},{"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 models","sidebarTitle":"Models","href":"/guides/nexus/models"}]},{"group":"Query contexts","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":"Nexus query traces","sidebarTitle":"Query traces","href":"/guides/nexus/query-tracing"},{"title":"Connect an MCP client to Pinecone Nexus","sidebarTitle":"Connect an MCP client","href":"/guides/nexus/mcp-server"}]},{"group":"Bring Your Own Cloud","pages":[{"title":"Nexus BYOC overview","sidebarTitle":"Overview","href":"/guides/nexus/byoc/overview"},{"title":"Deploy Nexus BYOC","sidebarTitle":"Deploy","href":"/guides/nexus/byoc/deploy"},{"title":"Nexus BYOC data residency and limits","sidebarTitle":"Residency and limits","href":"/guides/nexus/byoc/reference"},{"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/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":"Chat with an assistant - Pinecone Docs","buildId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","deploymentId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","dynamics":["10e4515597","c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["BannerMarkdown-BcDCEkh6.js","dist-CwjSCXIK.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","clsx-eKJ4rcii.js","html-void-elements-mCSPHezU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","OpenApiReferenceProvider-i2a3QZ8E.js","utils-ChLwp8m0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DRktVTDc.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CA2pEs4T.js","snippetPresets-ClQ6XrKD.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Ct_Lv36y.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Cn2PYw9e.js","shallow-rkyymjXQ.js","getApiPlaygroundDisplay-BB9vkXtE.js","CodeSnippet-Bm5RU7m1.js","CodeSnippets-BgU9Deuz.js","Page-BUDYNlhG.js","getPastedJson-BD-6NNum.js","icon-8Z6tud2e.js","MethodPill-Tuzr4g3V.js","DuplicateIcon-0ceWFYhN.js","createIcon-FBXow_ST.js","DynamicMarkdown-CD8713Yy.js","SectionHeading-7zgzQbH-.js","axios-vUo_bRtp.js","Markdown-D7Ofw1oz.js","AssistantPageLink-9EK5IAXV.js"]}