This endpoint can be used to get realtime chat completions. It can also be used
with the Task API processors to get structured, research outputs via a chat
interface.
Interaction ID from a previous chat completion to use as context.
Response
Returns a ChatCompletion object for non-streaming requests (application/json), or a stream of ChatCompletionResponseChunk objects for streaming requests (text/event-stream) when stream=true is set in the request.
Identifier for this interaction. Pass as previous_interaction_id for follow-ups.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Parallel","description":"Parallel's web APIs (Search, Extract, Task/Deep Research, Responses, FindAll, and Monitor) give AI agents and developers high-quality, low-latency access to the web for research, content extraction, entity discovery, and continuous monitoring. For Search and Extract, use /v1/search and /v1/extract for all new integrations and agent tool calls; use /v1beta/search and /v1beta/extract only when maintaining an existing integration that already uses them. The request bodies changed too: on /v1/extract, full_content, fetch_policy and excerpt_settings go inside advanced_settings, and sending the v1beta top-level excerpts, full_content and fetch_policy to /v1/extract returns a 422. Do not substitute /v1 for the documented FindAll or Ingest endpoint paths.","colors":{"primary":"#FB631B","light":"#fcfcfa","dark":"#1d1b16"},"logo":{"light":"https://mintcdn.com/parallel-6fabab31-mtje7p526we/ODrEI5O3l6nnvEZD/logo/wordmark_light.svg?fit=max\u0026auto=format\u0026n=ODrEI5O3l6nnvEZD\u0026q=85\u0026s=955d1146a212bea2279ca4ee6916b8ae","dark":"https://mintcdn.com/parallel-6fabab31-mtje7p526we/ODrEI5O3l6nnvEZD/logo/wordmark_dark.svg?fit=max\u0026auto=format\u0026n=ODrEI5O3l6nnvEZD\u0026q=85\u0026s=0039edb690a1759b9276a8691e19bf84"},"favicon":"https://mintcdn.com/parallel-6fabab31-mtje7p526we/dsxqJ8pzmudWCd39/favicon.svg?fit=max\u0026auto=format\u0026n=dsxqJ8pzmudWCd39\u0026q=85\u0026s=41982ed7e9fa034a1be0b73fb7294e48","api":{"playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["python","typescript","java","curl"]}},"appearance":{"default":"light"},"navbar":{"primary":{"type":"button","label":"API Playground","href":"https://platform.parallel.ai"}},"footer":{"socials":{"x":"https://x.com/p0","github":"https://github.com/parallel-web/parallel-cookbook","linkedin":"https://www.linkedin.com/company/parallel-web/about"},"links":[{"header":"Privacy","items":[{"label":"Cookie preferences","href":"#cookie-preferences"}]}]},"styling":{"eyebrows":"section","codeblocks":"system","latex":true},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"navigation":{"global":{"anchors":[{"anchor":"Get API Key","icon":"key","href":"https://platform.parallel.ai"},{"anchor":"OpenAPI Spec","icon":"file-code","href":"https://docs.parallel.ai/public-openapi.json"},{"anchor":"Python SDK","icon":"python","href":"https://pypi.org/project/parallel-web/"},{"anchor":"TypeScript SDK","icon":"js","href":"https://www.npmjs.com/package/parallel-web"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"parallel-6fabab31-mtje7p526we","hasAudioNarration":false,"actualSubdomain":"parallel-6fabab31-mtje7p526we","customDomains":["docs.parallel.ai"],"gitSource":{"type":"github","owner":"shapleyai","repo":"documentation","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6aebc6f5b16011e5809657e0","collectionId":"61ece71d-8940-4bed-a0fa-d87437c1cc7b","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aebc6f5b16011e5809657e0"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aebc6f5b16011e5809657e0","clientVersion":"0.0.4067","searchFilterCounts":[{"language":"default","tag":"Documentation","count":121},{"language":"default","tag":"Web Agents","count":45},{"language":"default","tag":"API Reference","count":38},{"language":"default","tag":"Features","count":23},{"language":"default","tag":"FindAll","count":22},{"language":"default","tag":"Web Tools","count":18},{"language":"default","tag":"Developer Tools","count":18},{"language":"default","tag":"Task","count":17},{"language":"default","tag":"Additional Resources","count":15},{"language":"default","tag":"Platform Integrations","count":14}]},"assistantConfig":{"enableAskAiButton":true,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"support@parallel.ai"}},"basePath":"","hasChatPermissions":true,"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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"@font-face{font-family:'Gerstner Programm';src:url('https://assets.p0web.com/Gerstner-ProgrammRegular.woff2') format('woff2');font-weight:400;font-style:normal;font-display:swap}@font-face{font-family:'Gerstner Programm';src:url('https://assets.p0web.com/Gerstner-ProgrammMedium.woff2') format('woff2');font-weight:500;font-style:normal;font-display:swap}body,html{font-family:'Gerstner Programm', -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Oxygen, Ubuntu, Cantarell, sans-serif}@font-face{font-family:'FT System Mono';src:url('https://assets.p0web.com/FTSystemMono-Regular.woff2') format('woff2');font-weight:400;font-style:normal;font-display:swap}@font-face{font-family:'FT System Mono';src:url('https://assets.p0web.com/FTSystemMono-Medium.woff2') format('woff2');font-weight:500;font-style:normal;font-display:swap}code,pre,.code,[class*=\"language-\"],kbd,samp,tt{font-family:'FT System Mono', monospace!important}h1,h2,h3,h4,h5,h6{font-weight:500!important}h1,h2,h3,h4,h5,h6{background:none!important;background-color:transparent!important;background-image:none!important}h1 mark,h2 mark,h3 mark,h4 mark,h5 mark,h6 mark{background:none!important;background-color:transparent!important;color:inherit!important}.font-normal h1,.font-normal h2,.font-normal h3{font-weight:400!important}pre,code,[id*=\"code-group\"],.not-prose,[class*=\"codeblock\"],[role=\"tabpanel\"],.mint-card,[class*=\"Card\"],.rounded-xl,.rounded-lg,.rounded-2xl{border-radius:0.375rem!important}.flex.flex-col.not-prose.relative.overflow-hidden{border-radius:0.375rem!important}[role=\"tab\"][aria-selected=\"true\"],[role=\"tab\"][data-headlessui-state=\"selected\"]{color:#FB631B!important;border-color:#FB631B!important}[role=\"tab\"][aria-selected=\"true\"] .absolute,[role=\"tab\"][data-headlessui-state=\"selected\"] .absolute{border-color:#FB631B!important}.dark .codeblock-dark,.dark [class*=\"codeblock\"],.dark pre{background-color:#1d1b16!important}[class*=\"codeblock\"],.not-prose{background-color:#fcfcfa!important}.dark [class*=\"codeblock\"],.dark .not-prose{background-color:#1d1b16!important}.bg-white\\/60{background-color:#fcfcfa!important}.dark .bg-codeblock,.dark .codeblock-dark{background-color:#1d1b16!important}#pagination{display:none}.dark{--bg-color: #1d1b16}.dark .example-panel,.dark [class*=\"example-panel\"]{background-color:transparent!important}.dark .example-button{background-color:transparent!important;background-image:none!important}.dark .example-button.text-white{background-color:#fb631b!important}.dark [class*=\"Card\"],.dark .mint-card,.dark a[href]>div{background-color:transparent!important;background-image:none!important}.dark [class*=\"Card\"]:hover,.dark .mint-card:hover,.dark a[href]:hover>div,.dark a[href]>div:hover{background-color:transparent!important;background-image:none!important}.dark .rounded-md.border{background-color:transparent!important}[class*=\"Card\"],.mint-card,[class*=\"Card\"] h1,[class*=\"Card\"] h2,[class*=\"Card\"] h3,[class*=\"Card\"] h4{background:none!important;background-color:transparent!important;background-image:none!important}[class*=\"Card\"]>div,.mint-card>div,[role=\"group\"]>a>div{background:none!important;background-color:transparent!important;background-image:none!important}[class*=\"Card\"] [class*=\"title\"],.mint-card [class*=\"title\"]{background:none!important;background-color:transparent!important}[class*=\"Card\"] h3,[class*=\"Card\"] h4,.mint-card h3,.mint-card h4{font-size:1.125rem!important;font-weight:600!important;margin-bottom:0.5rem!important}*:not(pre):not(code):not([class*=\"language-\"]):not(.token){text-decoration-color:inherit!important}mark:not(pre mark):not(code mark),::selection:not(pre ::selection):not(code ::selection){background:none!important;background-color:transparent!important}*:not(pre):not(code):not([class*=\"language-\"]):not(.token)::before,*:not(pre):not(code):not([class*=\"language-\"]):not(.token)::after{background:inherit!important}[data-card],[data-card-title],.card,.card-title{background:none!important;background-color:transparent!important;background-image:none!important}a[href] h1,a[href] h2,a[href] h3,a[href] h4{text-decoration:none!important;background:none!important;background-color:transparent!important}header nav button,header [role=\"navigation\"] a,header [role=\"navigation\"] button,[data-tabs] a,[data-tabs] button,nav[data-orientation=\"horizontal\"] a,nav[data-orientation=\"horizontal\"] button{font-size:1.25rem!important}article ul:not(nav ul):not([role=\"navigation\"] ul),.prose ul:not(nav ul):not([role=\"navigation\"] ul){list-style-type:disc;list-style-position:outside;padding-left:1.5rem}article ol:not(nav ol):not([role=\"navigation\"] ol),.prose ol:not(nav ol):not([role=\"navigation\"] ol){list-style-type:decimal;list-style-position:outside;padding-left:1.5rem}article li:not(nav li):not([role=\"navigation\"] li),.prose li:not(nav li):not([role=\"navigation\"] li){display:list-item;margin-left:0.5rem}nav ul,nav ol,nav li,[role=\"navigation\"] ul,[role=\"navigation\"] ol,[role=\"navigation\"] li,aside ul,aside ol,aside li{list-style-type:none!important}@media (min-width: 1024px){#content-container{max-width:none!important}}.pricing-summary th:first-child{width:28%}.pricing-summary th:nth-child(2){width:48%}.example-panel pre{max-height:340px;overflow-y:auto;overflow-x:hidden;white-space:pre-wrap;word-break:break-word;scrollbar-gutter:stable}.example-panel .code-block>.print\\:hidden{display:none!important}.example-panel pre::-webkit-scrollbar{width:8px}.example-panel pre::-webkit-scrollbar-thumb{background:rgba(0, 0, 0, 0.22);border-radius:4px;border:1px solid transparent;background-clip:padding-box}.dark .example-panel pre::-webkit-scrollbar-thumb{background:rgba(255, 255, 255, 0.22);background-clip:padding-box}.example-panel pre::-webkit-scrollbar-track{background:transparent}.example-tab-active{background-color:#eeeeee!important}.dark .example-tab-active{background-color:rgba(255, 255, 255, 0.06)!important}.example-tab-list,.example-tab-list li{padding:0!important;margin:0!important;list-style:none!important}.example-tab-list li{display:block!important}.example-panel .code-block{margin-top:0!important;margin-bottom:0!important}.home-panel-link{font-size:0.875rem;color:#4b5563;transition:color 0.15s}.home-panel-link:hover{color:#FB631B}.dark .home-panel-link{color:#9ca3af}.dark .home-panel-link:hover{color:#FB631B}.min-h-\\[260px\\]{min-height:260px}.bg-\\[\\#f6f6f6\\]{background-color:#f6f6f6}.bg-\\[\\#434343\\]{background-color:#434343}.hover\\:bg-\\[\\#2a2a2a\\]:hover{background-color:#2a2a2a}.border-\\[\\#e5e5e5\\]{border-color:#e5e5e5}.dark .dark\\:bg-\\[\\#1a1a1a\\]{background-color:#1a1a1a}.dark .dark\\:border-\\[\\#2a2a2a\\]{border-color:#2a2a2a}.dark .dark\\:bg-\\[\\#111\\]{background-color:#111}.bg-gray-50\\/60{background-color:rgb(249 250 251 / 0.6)}.dark .dark\\:bg-white\\/\\[0\\.02\\]{background-color:rgb(255 255 255 / 0.02)}.text-\\[12px\\]{font-size:12px}.text-\\[13px\\]{font-size:13px}@media (min-width: 1024px){.lg\\:w-\\[262px\\]{width:262px}.lg\\:p-5{padding:1.25rem}.lg\\:grid-cols-4{grid-template-columns:repeat(4, minmax(0, 1fr))}.lg\\:border-r{border-right-width:1px}.lg\\:border-b-0{border-bottom-width:0}.lg\\:border-gray-200{border-color:rgb(229 231 235)}.dark .lg\\:dark\\:border-\\[\\#2a2a2a\\]{border-color:#2a2a2a}}html[data-current-path=\"/getting-started/overview\"] [class*=\"max-w-6xl\"]>div:last-child{max-width:none!important}html[data-current-path=\"/getting-started/overview\"] header#header{display:none!important}html[data-current-path=\"/getting-started/overview\"] h2.font-bold{font-weight:700!important}html[data-current-path=\"/getting-started/overview\"] .mdx-content{margin-top:0!important}html[data-current-path=\"/getting-started/overview\"] .mdx-content h2{margin-top:0!important}html[data-current-path=\"/getting-started/overview\"] .agent-onboarding-prompt code{font-family:'FT System Mono', monospace!important;font-size:14px!important;font-weight:400!important;line-height:1.6!important}html[data-current-path=\"/getting-started/overview\"] .agent-onboarding-prompt a,html[data-current-path=\"/getting-started/overview\"] .agent-onboarding-prompt a:hover,html[data-current-path=\"/getting-started/overview\"] .agent-onboarding-prompt a:focus,html[data-current-path=\"/getting-started/overview\"] .agent-onboarding-prompt a:active,html[data-current-path=\"/getting-started/overview\"] .agent-onboarding-prompt a:visited{color:rgb(5, 80, 174)!important;font-weight:400!important;text-decoration:none!important;border-bottom:0!important;box-shadow:none!important;background-image:none!important}.dark html[data-current-path=\"/getting-started/overview\"] .agent-onboarding-prompt a,.dark html[data-current-path=\"/getting-started/overview\"] .agent-onboarding-prompt a:hover,.dark html[data-current-path=\"/getting-started/overview\"] .agent-onboarding-prompt a:focus,.dark html[data-current-path=\"/getting-started/overview\"] .agent-onboarding-prompt a:active,.dark html[data-current-path=\"/getting-started/overview\"] .agent-onboarding-prompt a:visited,html.dark[data-current-path=\"/getting-started/overview\"] .agent-onboarding-prompt a,html.dark[data-current-path=\"/getting-started/overview\"] .agent-onboarding-prompt a:hover,html.dark[data-current-path=\"/getting-started/overview\"] .agent-onboarding-prompt a:focus,html.dark[data-current-path=\"/getting-started/overview\"] .agent-onboarding-prompt a:active,html.dark[data-current-path=\"/getting-started/overview\"] .agent-onboarding-prompt a:visited{color:#79c0ff!important}.prose a:not([class*=\"card\"]):not([class*=\"button\"]){font-weight:400!important}.pw-consent{position:fixed;bottom:1rem;left:1rem;right:1rem;z-index:2147483000;max-height:calc(100dvh - 2rem);overflow-y:auto;border-radius:4px;background:rgba(34, 34, 34, 0.8);backdrop-filter:blur(6px);-webkit-backdrop-filter:blur(6px);padding:1rem;color:#fff;font-family:'Gerstner Programm', -apple-system, BlinkMacSystemFont, sans-serif;opacity:0;transform:translateY(12px);transition:opacity 0.4s cubic-bezier(0.6, 0, 0.2, 1), transform 0.4s cubic-bezier(0.6, 0, 0.2, 1)}.pw-consent[data-visible=\"true\"]{opacity:1;transform:translateY(0)}@media (min-width: 768px){.pw-consent{bottom:1.5rem;left:1.5rem;right:auto;width:300px}}.pw-consent__stack{display:flex;flex-direction:column;gap:1rem}.pw-consent__title{font-size:16px;font-weight:500;line-height:24px;letter-spacing:0.15px;margin:0;color:#fff}.pw-consent__body{font-size:13px;line-height:16px;letter-spacing:0.15px;margin:0;color:#fff}.pw-consent__body a,.pw-consent__linkbtn{color:#fff;text-decoration:underline;background:none;border:0;padding:0;font:inherit;cursor:pointer}.pw-consent__panel{display:none;flex-direction:column;gap:0.75rem;border-top:1px solid rgba(255, 255, 255, 0.15);padding-top:1rem}.pw-consent__panel[data-expanded=\"true\"]{display:flex}.pw-consent__row{display:flex;align-items:flex-start;justify-content:space-between;gap:0.75rem}.pw-consent__label{font-size:13px;line-height:16px;letter-spacing:0.15px;color:#fff}.pw-consent__hint{display:block;margin-top:2px;font-size:12px;line-height:15px;color:rgba(255, 255, 255, 0.55)}.pw-consent__always{flex-shrink:0;margin-top:2px;font-family:'FT System Mono', monospace;font-size:11px;line-height:16px;text-transform:uppercase;color:rgba(255, 255, 255, 0.55)}.pw-consent__toggle{position:relative;flex-shrink:0;margin-top:2px;width:34px;height:20px;border:0;border-radius:9999px;background:rgba(255, 255, 255, 0.25);cursor:pointer;transition:background-color 0.2s cubic-bezier(0.6, 0, 0.2, 1)}.pw-consent__toggle[aria-checked=\"true\"]{background:#fff}.pw-consent__knob{position:absolute;top:2px;left:2px;width:16px;height:16px;border-radius:9999px;background:#fff;transition:left 0.2s cubic-bezier(0.6, 0, 0.2, 1), background-color 0.2s}.pw-consent__toggle[aria-checked=\"true\"] .pw-consent__knob{left:16px;background:#222}.pw-consent__actions{display:flex;gap:1rem}.pw-consent__btn{flex:1 1 0;display:flex;align-items:center;justify-content:center;white-space:nowrap;border:0;border-radius:4px;background:#eee;color:#181818;padding:8px 16px;font-family:'FT System Mono', monospace;font-size:13px;line-height:16px;text-transform:uppercase;cursor:pointer;transition:background-color 0.2s}.pw-consent__btn:hover{background:#fff}.pw-consent__btn--save{margin-top:4px;width:100%}@media (prefers-reduced-motion: reduce){.pw-consent,.pw-consent__toggle,.pw-consent__knob,.pw-consent__btn{transition:none}}"}],"page":{"pagePath":"api-reference/legacy/chat-api-beta/chat-completions","slug":"/api-reference/legacy/chat-api-beta/chat-completions","pageMetadata":{"title":"Chat Completions","description":"Chat completions.\n\nThis endpoint can be used to get realtime chat completions. It can also be used\nwith the Task API processors to get structured, research outputs via a chat\ninterface.","deprecated":null,"version":null,"openapi":"/docs-legacy-openapi.json post /v1beta/chat/completions","href":"/api-reference/legacy/chat-api-beta/chat-completions","autogeneratedByOpenApi":true,"hidden":true},"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 p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Chat completions.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"This endpoint can be used to get realtime chat completions. It can also be used\\nwith the Task API processors to get structured, research outputs via a chat\\ninterface.\"\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":{"codeStyling":"system","config":{},"pageMetadata":{"title":"Chat Completions","description":"Chat completions.\n\nThis endpoint can be used to get realtime chat completions. It can also be used\nwith the Task API processors to get structured, research outputs via a chat\ninterface.","deprecated":null,"version":null,"openapi":"/docs-legacy-openapi.json post /v1beta/chat/completions","href":"/api-reference/legacy/chat-api-beta/chat-completions","autogeneratedByOpenApi":true,"hidden":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/parallel-6fabab31-mtje7p526we/8bc4b1f689ce2d52/consent.js","/_mintlify/custom/parallel-6fabab31-mtje7p526we/07c1eb0ddac88dfe/link-tracking.js"],"openApiReferenceData":{"operation":{"tags":["Chat API (Beta)"],"summary":"Chat Completions","description":"Chat completions.\n\nThis endpoint can be used to get realtime chat completions. It can also be used\nwith the Task API processors to get structured, research outputs via a chat\ninterface.","operationId":"chat_completions_v1beta_chat_completions_post","requestBody":"5f03db13-dfe9-4bf3-a5b9-442bd5c169d8","responses":{"200":"202134c2-61ba-49c5-80a5-d0368b549c3a","422":"9ce07d97-18ac-4ed5-a416-b4c026678ffd"},"method":"post","type":"path","servers":["9eb25184-f485-41e5-93a2-065601fe5a47"],"security":["49a29ffa-8f37-47ed-a6b7-cbccaf1be4c3"],"path":"/v1beta/chat/completions","baseUrlOptions":["https://api.parallel.ai"],"title":"Chat Completions","codeSamples":[],"requestExampleLanguages":["python","typescript","java","bash"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"properties":{"model":{"type":"string","title":"Model","description":"The model to use for chat completions.","isRequired":true,"uniqueKey":"model","typeLabel":"string"},"messages":{"items":{"properties":{"role":{"type":"string","enum":["system","user","assistant"],"title":"Role","description":"The role of the chat message.","isRequired":true,"uniqueKey":"messages.items.[INDEX].role","typeLabel":"enum\u003cstring>"},"content":{"type":"string","title":"Content","description":"The content of the chat message.","isRequired":true,"uniqueKey":"messages.items.[INDEX].content","typeLabel":"string"},"name":{"oneOf":[{"type":"string","title":"Name","description":"An optional name for the participant. Provides the model information to differentiate between participants of the same role.","uniqueKey":"messages.items.[INDEX].name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Name","description":"An optional name for the participant. Provides the model information to differentiate between participants of the same role.","uniqueKey":"messages.items.[INDEX].name.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].name","typeLabel":"string | null"}},"type":"object","required":["role","content"],"title":"ChatMessage","description":"Chat message for OpenAI API.","uniqueKey":"messages.items.[INDEX]","typeLabel":"ChatMessage · object"},"type":"array","title":"Messages","description":"The messages to use for chat completions.","isRequired":true,"uniqueKey":"messages","typeLabel":"ChatMessage · object[]"},"stream":{"oneOf":[{"type":"boolean","title":"Stream","description":"Whether to stream the chat completions.","uniqueKey":"stream.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Stream","description":"Whether to stream the chat completions.","uniqueKey":"stream.oneOf.1","typeLabel":"null"}],"uniqueKey":"stream","typeLabel":"boolean | null"},"response_format":{"oneOf":[{"type":"object","title":"ResponseFormatText","description":"Default response format. Used to generate text responses.","required":["type"],"properties":{"type":{"const":"text","title":"Type","type":"string","isRequired":true,"uniqueKey":"response_format.oneOf.0.type","typeLabel":"string"}},"uniqueKey":"response_format.oneOf.0","typeLabel":"ResponseFormatText · object"},{"type":"object","title":"ResponseFormatJSONSchema","description":"JSON Schema response format.\n\nUsed to generate structured JSON responses.\nLearn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs).","required":["json_schema","type"],"properties":{"json_schema":{"properties":{"name":{"type":"string","title":"Name","isRequired":true,"uniqueKey":"response_format.oneOf.1.json_schema.name","typeLabel":"string"},"description":{"type":"string","title":"Description","uniqueKey":"response_format.oneOf.1.json_schema.description","typeLabel":"string"},"schema":{"additionalProperties":false,"type":"object","title":"Schema","uniqueKey":"response_format.oneOf.1.json_schema.schema","typeLabel":"Schema · object"},"strict":{"oneOf":[{"type":"boolean","title":"Strict","uniqueKey":"response_format.oneOf.1.json_schema.strict.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Strict","uniqueKey":"response_format.oneOf.1.json_schema.strict.oneOf.1","typeLabel":"null"}],"uniqueKey":"response_format.oneOf.1.json_schema.strict","typeLabel":"boolean | null"}},"type":"object","required":["name"],"title":"JSONSchema","description":"Structured Outputs configuration options, including a JSON Schema.","isRequired":true,"uniqueKey":"response_format.oneOf.1.json_schema","typeLabel":"JSONSchema · object"},"type":{"type":"string","const":"json_schema","title":"Type","isRequired":true,"uniqueKey":"response_format.oneOf.1.type","typeLabel":"string"}},"uniqueKey":"response_format.oneOf.1","typeLabel":"ResponseFormatJSONSchema · object"},{"type":"object","title":"ResponseFormatJSONObject","description":"JSON object response format.\n\nAn older method of generating JSON responses.\nUsing `json_schema` is recommended for models that support it. Note that the\nmodel will not generate JSON without a system or user message instructing it\nto do so.","required":["type"],"properties":{"type":{"const":"json_object","title":"Type","type":"string","isRequired":true,"uniqueKey":"response_format.oneOf.2.type","typeLabel":"string"}},"uniqueKey":"response_format.oneOf.2","typeLabel":"ResponseFormatJSONObject · object"},{"type":"null","title":"Response Format","description":"The response format to use for chat completions. OpenAI compatible.","uniqueKey":"response_format.oneOf.3","typeLabel":"null"}],"uniqueKey":"response_format","typeLabel":"ResponseFormatText · object | ResponseFormatJSONSchema · object | ResponseFormatJSONObject · object | null"},"max_tokens":{"oneOf":[{"type":"integer","title":"Max Tokens","description":"The maximum number of tokens to generate. Unsupported.","uniqueKey":"max_tokens.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Max Tokens","description":"The maximum number of tokens to generate. Unsupported.","uniqueKey":"max_tokens.oneOf.1","typeLabel":"null"}],"uniqueKey":"max_tokens","typeLabel":"integer | null"},"temperature":{"oneOf":[{"type":"number","title":"Temperature","description":"The temperature to use for chat completions. Unsupported.","uniqueKey":"temperature.oneOf.0","typeLabel":"number"},{"type":"null","title":"Temperature","description":"The temperature to use for chat completions. Unsupported.","uniqueKey":"temperature.oneOf.1","typeLabel":"null"}],"uniqueKey":"temperature","typeLabel":"number | null"},"top_p":{"oneOf":[{"type":"number","title":"Top P","description":"The top p to use for chat completions. Unsupported.","uniqueKey":"top_p.oneOf.0","typeLabel":"number"},{"type":"null","title":"Top P","description":"The top p to use for chat completions. Unsupported.","uniqueKey":"top_p.oneOf.1","typeLabel":"null"}],"uniqueKey":"top_p","typeLabel":"number | null"},"n":{"oneOf":[{"type":"integer","title":"N","description":"The number of chat completions to generate. Unsupported.","uniqueKey":"n.oneOf.0","typeLabel":"integer"},{"type":"null","title":"N","description":"The number of chat completions to generate. Unsupported.","uniqueKey":"n.oneOf.1","typeLabel":"null"}],"uniqueKey":"n","typeLabel":"integer | null"},"presence_penalty":{"oneOf":[{"type":"number","title":"Presence Penalty","description":"The presence penalty to use for chat completions. Unsupported.","uniqueKey":"presence_penalty.oneOf.0","typeLabel":"number"},{"type":"null","title":"Presence Penalty","description":"The presence penalty to use for chat completions. Unsupported.","uniqueKey":"presence_penalty.oneOf.1","typeLabel":"null"}],"uniqueKey":"presence_penalty","typeLabel":"number | null"},"frequency_penalty":{"oneOf":[{"type":"number","title":"Frequency Penalty","description":"The frequency penalty to use for chat completions. Unsupported.","uniqueKey":"frequency_penalty.oneOf.0","typeLabel":"number"},{"type":"null","title":"Frequency Penalty","description":"The frequency penalty to use for chat completions. Unsupported.","uniqueKey":"frequency_penalty.oneOf.1","typeLabel":"null"}],"uniqueKey":"frequency_penalty","typeLabel":"number | null"},"previous_interaction_id":{"oneOf":[{"type":"string","title":"Previous Interaction Id","description":"Interaction ID from a previous chat completion to use as context.","uniqueKey":"previous_interaction_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Previous Interaction Id","description":"Interaction ID from a previous chat completion to use as context.","uniqueKey":"previous_interaction_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"previous_interaction_id","typeLabel":"string | null"}},"type":"object","required":["model","messages"],"title":"ChatCompletionRequest","description":"Request for the chat completions endpoint.\n\nNote that all parameters except for `model`, `stream`, and `response_format`\nare ignored.","uniqueKey":"","typeLabel":"ChatCompletionRequest · object"},"examples":{"Example":{"title":"Example","value":{"model":"\u003cstring>","messages":[{"content":"\u003cstring>","name":"\u003cstring>"}],"stream":true,"response_format":{"type":"text"},"max_tokens":123,"temperature":123,"top_p":123,"n":123,"presence_penalty":123,"frequency_penalty":123,"previous_interaction_id":"\u003cstring>"}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"202134c2-61ba-49c5-80a5-d0368b549c3a":{"description":"Returns a ChatCompletion object for non-streaming requests (application/json), or a stream of ChatCompletionResponseChunk objects for streaming requests (text/event-stream) when `stream=true` is set in the request.","content":{"application/json":{"schema":{"properties":{"id":{"type":"string","title":"Id","description":"The id of the chat completion.","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"choices":{"items":{"additionalProperties":true,"properties":{"delta":{"additionalProperties":true,"description":"A chat completion delta generated by streamed model responses.","properties":{"content":{"oneOf":[{"type":"string","title":"Content","uniqueKey":"choices.items.[INDEX].delta.content.oneOf.0","typeLabel":"string"},{"type":"null","title":"Content","uniqueKey":"choices.items.[INDEX].delta.content.oneOf.1","typeLabel":"null"}],"uniqueKey":"choices.items.[INDEX].delta.content","typeLabel":"string | null"},"function_call":{"oneOf":[{"type":"object","title":"ChoiceDeltaFunctionCall","description":"Deprecated and replaced by `tool_calls`.\n\nThe name and arguments of a function that should be called, as generated by the model.","properties":{"arguments":{"oneOf":[{"type":"string","title":"Arguments","uniqueKey":"choices.items.[INDEX].delta.function_call.oneOf.0.arguments.oneOf.0","typeLabel":"string"},{"type":"null","title":"Arguments","uniqueKey":"choices.items.[INDEX].delta.function_call.oneOf.0.arguments.oneOf.1","typeLabel":"null"}],"uniqueKey":"choices.items.[INDEX].delta.function_call.oneOf.0.arguments","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","title":"Name","uniqueKey":"choices.items.[INDEX].delta.function_call.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Name","uniqueKey":"choices.items.[INDEX].delta.function_call.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"choices.items.[INDEX].delta.function_call.oneOf.0.name","typeLabel":"string | null"}},"additionalProperties":true,"uniqueKey":"choices.items.[INDEX].delta.function_call.oneOf.0","typeLabel":"ChoiceDeltaFunctionCall · object"},{"type":"null","uniqueKey":"choices.items.[INDEX].delta.function_call.oneOf.1","typeLabel":"null"}],"uniqueKey":"choices.items.[INDEX].delta.function_call","typeLabel":"ChoiceDeltaFunctionCall · object | null"},"refusal":{"oneOf":[{"type":"string","title":"Refusal","uniqueKey":"choices.items.[INDEX].delta.refusal.oneOf.0","typeLabel":"string"},{"type":"null","title":"Refusal","uniqueKey":"choices.items.[INDEX].delta.refusal.oneOf.1","typeLabel":"null"}],"uniqueKey":"choices.items.[INDEX].delta.refusal","typeLabel":"string | null"},"role":{"oneOf":[{"type":"string","title":"Role","enum":["developer","system","user","assistant","tool"],"uniqueKey":"choices.items.[INDEX].delta.role.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Role","uniqueKey":"choices.items.[INDEX].delta.role.oneOf.1","typeLabel":"null"}],"uniqueKey":"choices.items.[INDEX].delta.role","typeLabel":"enum\u003cstring> | null"},"tool_calls":{"oneOf":[{"type":"array","items":{"additionalProperties":true,"properties":{"index":{"title":"Index","type":"integer","isRequired":true,"uniqueKey":"choices.items.[INDEX].delta.tool_calls.oneOf.0.items.[INDEX].index","typeLabel":"integer"},"id":{"oneOf":[{"type":"string","title":"Id","uniqueKey":"choices.items.[INDEX].delta.tool_calls.oneOf.0.items.[INDEX].id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Id","uniqueKey":"choices.items.[INDEX].delta.tool_calls.oneOf.0.items.[INDEX].id.oneOf.1","typeLabel":"null"}],"uniqueKey":"choices.items.[INDEX].delta.tool_calls.oneOf.0.items.[INDEX].id","typeLabel":"string | null"},"function":{"oneOf":[{"type":"object","title":"ChoiceDeltaToolCallFunction","properties":{"arguments":{"oneOf":[{"type":"string","title":"Arguments","uniqueKey":"choices.items.[INDEX].delta.tool_calls.oneOf.0.items.[INDEX].function.oneOf.0.arguments.oneOf.0","typeLabel":"string"},{"type":"null","title":"Arguments","uniqueKey":"choices.items.[INDEX].delta.tool_calls.oneOf.0.items.[INDEX].function.oneOf.0.arguments.oneOf.1","typeLabel":"null"}],"uniqueKey":"choices.items.[INDEX].delta.tool_calls.oneOf.0.items.[INDEX].function.oneOf.0.arguments","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","title":"Name","uniqueKey":"choices.items.[INDEX].delta.tool_calls.oneOf.0.items.[INDEX].function.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Name","uniqueKey":"choices.items.[INDEX].delta.tool_calls.oneOf.0.items.[INDEX].function.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"choices.items.[INDEX].delta.tool_calls.oneOf.0.items.[INDEX].function.oneOf.0.name","typeLabel":"string | null"}},"additionalProperties":true,"uniqueKey":"choices.items.[INDEX].delta.tool_calls.oneOf.0.items.[INDEX].function.oneOf.0","typeLabel":"ChoiceDeltaToolCallFunction · object"},{"type":"null","uniqueKey":"choices.items.[INDEX].delta.tool_calls.oneOf.0.items.[INDEX].function.oneOf.1","typeLabel":"null"}],"uniqueKey":"choices.items.[INDEX].delta.tool_calls.oneOf.0.items.[INDEX].function","typeLabel":"ChoiceDeltaToolCallFunction · object | null"},"type":{"oneOf":[{"type":"string","title":"Type","const":"function","uniqueKey":"choices.items.[INDEX].delta.tool_calls.oneOf.0.items.[INDEX].type.oneOf.0","typeLabel":"string"},{"type":"null","title":"Type","uniqueKey":"choices.items.[INDEX].delta.tool_calls.oneOf.0.items.[INDEX].type.oneOf.1","typeLabel":"null"}],"uniqueKey":"choices.items.[INDEX].delta.tool_calls.oneOf.0.items.[INDEX].type","typeLabel":"string | null"}},"required":["index"],"title":"ChoiceDeltaToolCall","type":"object","uniqueKey":"choices.items.[INDEX].delta.tool_calls.oneOf.0.items.[INDEX]","typeLabel":"ChoiceDeltaToolCall · object"},"title":"Tool Calls","uniqueKey":"choices.items.[INDEX].delta.tool_calls.oneOf.0","typeLabel":"ChoiceDeltaToolCall · object[]"},{"type":"null","title":"Tool Calls","uniqueKey":"choices.items.[INDEX].delta.tool_calls.oneOf.1","typeLabel":"null"}],"uniqueKey":"choices.items.[INDEX].delta.tool_calls","typeLabel":"ChoiceDeltaToolCall · object[] | null"}},"title":"ChoiceDelta","type":"object","isRequired":true,"uniqueKey":"choices.items.[INDEX].delta","typeLabel":"ChoiceDelta · object"},"index":{"title":"Index","type":"integer","isRequired":true,"uniqueKey":"choices.items.[INDEX].index","typeLabel":"integer"},"finish_reason":{"oneOf":[{"type":"string","title":"Finish Reason","enum":["stop","length","tool_calls","content_filter","function_call"],"uniqueKey":"choices.items.[INDEX].finish_reason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Finish Reason","uniqueKey":"choices.items.[INDEX].finish_reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"choices.items.[INDEX].finish_reason","typeLabel":"enum\u003cstring> | null"},"logprobs":{"oneOf":[{"type":"object","title":"ChoiceLogprobs","description":"Log probability information for the choice.","properties":{"content":{"oneOf":[{"type":"array","items":{"additionalProperties":true,"properties":{"token":{"title":"Token","type":"string","isRequired":true,"uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.content.oneOf.0.items.[INDEX].token","typeLabel":"string"},"logprob":{"title":"Logprob","type":"number","isRequired":true,"uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.content.oneOf.0.items.[INDEX].logprob","typeLabel":"number"},"top_logprobs":{"items":{"additionalProperties":true,"properties":{"token":{"title":"Token","type":"string","isRequired":true,"uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.content.oneOf.0.items.[INDEX].top_logprobs.items.[INDEX].token","typeLabel":"string"},"logprob":{"title":"Logprob","type":"number","isRequired":true,"uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.content.oneOf.0.items.[INDEX].top_logprobs.items.[INDEX].logprob","typeLabel":"number"},"bytes":{"oneOf":[{"type":"array","items":{"type":"integer","uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.content.oneOf.0.items.[INDEX].top_logprobs.items.[INDEX].bytes.oneOf.0.items.[INDEX]","typeLabel":"integer"},"title":"Bytes","uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.content.oneOf.0.items.[INDEX].top_logprobs.items.[INDEX].bytes.oneOf.0","typeLabel":"integer[]"},{"type":"null","title":"Bytes","uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.content.oneOf.0.items.[INDEX].top_logprobs.items.[INDEX].bytes.oneOf.1","typeLabel":"null"}],"uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.content.oneOf.0.items.[INDEX].top_logprobs.items.[INDEX].bytes","typeLabel":"integer[] | null"}},"required":["token","logprob"],"title":"TopLogprob","type":"object","uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.content.oneOf.0.items.[INDEX].top_logprobs.items.[INDEX]","typeLabel":"TopLogprob · object"},"title":"Top Logprobs","type":"array","isRequired":true,"uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.content.oneOf.0.items.[INDEX].top_logprobs","typeLabel":"TopLogprob · object[]"},"bytes":{"oneOf":[{"type":"array","items":{"type":"integer","uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.content.oneOf.0.items.[INDEX].bytes.oneOf.0.items.[INDEX]","typeLabel":"integer"},"title":"Bytes","uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.content.oneOf.0.items.[INDEX].bytes.oneOf.0","typeLabel":"integer[]"},{"type":"null","title":"Bytes","uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.content.oneOf.0.items.[INDEX].bytes.oneOf.1","typeLabel":"null"}],"uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.content.oneOf.0.items.[INDEX].bytes","typeLabel":"integer[] | null"}},"required":["token","logprob","top_logprobs"],"title":"ChatCompletionTokenLogprob","type":"object","uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.content.oneOf.0.items.[INDEX]","typeLabel":"ChatCompletionTokenLogprob · object"},"title":"Content","uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.content.oneOf.0","typeLabel":"ChatCompletionTokenLogprob · object[]"},{"type":"null","title":"Content","uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.content.oneOf.1","typeLabel":"null"}],"uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.content","typeLabel":"ChatCompletionTokenLogprob · object[] | null"},"refusal":{"oneOf":[{"type":"array","items":{"additionalProperties":true,"properties":{"token":{"title":"Token","type":"string","isRequired":true,"uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.refusal.oneOf.0.items.[INDEX].token","typeLabel":"string"},"logprob":{"title":"Logprob","type":"number","isRequired":true,"uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.refusal.oneOf.0.items.[INDEX].logprob","typeLabel":"number"},"top_logprobs":{"items":{"additionalProperties":true,"properties":{"token":{"title":"Token","type":"string","isRequired":true,"uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.refusal.oneOf.0.items.[INDEX].top_logprobs.items.[INDEX].token","typeLabel":"string"},"logprob":{"title":"Logprob","type":"number","isRequired":true,"uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.refusal.oneOf.0.items.[INDEX].top_logprobs.items.[INDEX].logprob","typeLabel":"number"},"bytes":{"oneOf":[{"type":"array","items":{"type":"integer","uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.refusal.oneOf.0.items.[INDEX].top_logprobs.items.[INDEX].bytes.oneOf.0.items.[INDEX]","typeLabel":"integer"},"title":"Bytes","uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.refusal.oneOf.0.items.[INDEX].top_logprobs.items.[INDEX].bytes.oneOf.0","typeLabel":"integer[]"},{"type":"null","title":"Bytes","uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.refusal.oneOf.0.items.[INDEX].top_logprobs.items.[INDEX].bytes.oneOf.1","typeLabel":"null"}],"uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.refusal.oneOf.0.items.[INDEX].top_logprobs.items.[INDEX].bytes","typeLabel":"integer[] | null"}},"required":["token","logprob"],"title":"TopLogprob","type":"object","uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.refusal.oneOf.0.items.[INDEX].top_logprobs.items.[INDEX]","typeLabel":"TopLogprob · object"},"title":"Top Logprobs","type":"array","isRequired":true,"uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.refusal.oneOf.0.items.[INDEX].top_logprobs","typeLabel":"TopLogprob · object[]"},"bytes":{"oneOf":[{"type":"array","items":{"type":"integer","uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.refusal.oneOf.0.items.[INDEX].bytes.oneOf.0.items.[INDEX]","typeLabel":"integer"},"title":"Bytes","uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.refusal.oneOf.0.items.[INDEX].bytes.oneOf.0","typeLabel":"integer[]"},{"type":"null","title":"Bytes","uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.refusal.oneOf.0.items.[INDEX].bytes.oneOf.1","typeLabel":"null"}],"uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.refusal.oneOf.0.items.[INDEX].bytes","typeLabel":"integer[] | null"}},"required":["token","logprob","top_logprobs"],"title":"ChatCompletionTokenLogprob","type":"object","uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.refusal.oneOf.0.items.[INDEX]","typeLabel":"ChatCompletionTokenLogprob · object"},"title":"Refusal","uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.refusal.oneOf.0","typeLabel":"ChatCompletionTokenLogprob · object[]"},{"type":"null","title":"Refusal","uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.refusal.oneOf.1","typeLabel":"null"}],"uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.refusal","typeLabel":"ChatCompletionTokenLogprob · object[] | null"}},"additionalProperties":true,"uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0","typeLabel":"ChoiceLogprobs · object"},{"type":"null","uniqueKey":"choices.items.[INDEX].logprobs.oneOf.1","typeLabel":"null"}],"uniqueKey":"choices.items.[INDEX].logprobs","typeLabel":"ChoiceLogprobs · object | null"}},"required":["delta","index"],"title":"Choice","type":"object","uniqueKey":"choices.items.[INDEX]","typeLabel":"Choice · object"},"type":"array","title":"Choices","isRequired":true,"uniqueKey":"choices","typeLabel":"Choice · object[]"},"created":{"type":"integer","title":"Created","isRequired":true,"uniqueKey":"created","typeLabel":"integer"},"model":{"type":"string","title":"Model","isRequired":true,"uniqueKey":"model","typeLabel":"string"},"object":{"type":"string","const":"chat.completion","title":"Object","isRequired":true,"uniqueKey":"object","typeLabel":"string"},"moderation":{"oneOf":[{"type":"object","title":"Moderation","description":"Moderation results for the request input and generated output, if moderated\ncompletions were requested.","required":["input","output"],"properties":{"input":{"oneOf":[{"type":"object","title":"ModerationInputModerationResults","description":"Successful moderation results for the request input or generated output.","required":["model","results","type"],"properties":{"model":{"type":"string","title":"Model","isRequired":true,"uniqueKey":"moderation.oneOf.0.input.oneOf.0.model","typeLabel":"string"},"results":{"items":{"additionalProperties":true,"description":"A moderation result produced for the response input or output.","properties":{"categories":{"additionalProperties":{"type":"boolean","uniqueKey":"moderation.oneOf.0.input.oneOf.0.results.items.[INDEX].categories.additionalProperties","typeLabel":"boolean"},"title":"Categories","type":"object","isRequired":true,"uniqueKey":"moderation.oneOf.0.input.oneOf.0.results.items.[INDEX].categories","typeLabel":"Categories · object"},"category_applied_input_types":{"additionalProperties":{"items":{"enum":["text","image"],"type":"string","uniqueKey":"moderation.oneOf.0.input.oneOf.0.results.items.[INDEX].category_applied_input_types.additionalProperties.items.[INDEX]","typeLabel":"enum\u003cstring>"},"type":"array","uniqueKey":"moderation.oneOf.0.input.oneOf.0.results.items.[INDEX].category_applied_input_types.additionalProperties","typeLabel":"enum\u003cstring>[]"},"title":"Category Applied Input Types","type":"object","isRequired":true,"uniqueKey":"moderation.oneOf.0.input.oneOf.0.results.items.[INDEX].category_applied_input_types","typeLabel":"Category Applied Input Types · object"},"category_scores":{"additionalProperties":{"type":"number","uniqueKey":"moderation.oneOf.0.input.oneOf.0.results.items.[INDEX].category_scores.additionalProperties","typeLabel":"number"},"title":"Category Scores","type":"object","isRequired":true,"uniqueKey":"moderation.oneOf.0.input.oneOf.0.results.items.[INDEX].category_scores","typeLabel":"Category Scores · object"},"flagged":{"title":"Flagged","type":"boolean","isRequired":true,"uniqueKey":"moderation.oneOf.0.input.oneOf.0.results.items.[INDEX].flagged","typeLabel":"boolean"},"model":{"type":"string","title":"Model","isRequired":true,"uniqueKey":"moderation.oneOf.0.input.oneOf.0.results.items.[INDEX].model","typeLabel":"string"},"type":{"const":"moderation_result","title":"Type","type":"string","isRequired":true,"uniqueKey":"moderation.oneOf.0.input.oneOf.0.results.items.[INDEX].type","typeLabel":"string"}},"required":["categories","category_applied_input_types","category_scores","flagged","model","type"],"title":"ModerationInputModerationResultsResult","type":"object","uniqueKey":"moderation.oneOf.0.input.oneOf.0.results.items.[INDEX]","typeLabel":"ModerationInputModerationResultsResult · object"},"title":"Results","type":"array","isRequired":true,"uniqueKey":"moderation.oneOf.0.input.oneOf.0.results","typeLabel":"ModerationInputModerationResultsResult · object[]"},"type":{"const":"moderation_results","title":"Type","type":"string","isRequired":true,"uniqueKey":"moderation.oneOf.0.input.oneOf.0.type","typeLabel":"string"}},"additionalProperties":true,"isRequired":true,"uniqueKey":"moderation.oneOf.0.input.oneOf.0","typeLabel":"ModerationInputModerationResults · object"},{"type":"object","title":"ModerationInputError","description":"An error produced while attempting moderation.","required":["code","message","type"],"properties":{"code":{"type":"string","title":"Code","isRequired":true,"uniqueKey":"moderation.oneOf.0.input.oneOf.1.code","typeLabel":"string"},"message":{"title":"Message","type":"string","isRequired":true,"uniqueKey":"moderation.oneOf.0.input.oneOf.1.message","typeLabel":"string"},"type":{"type":"string","const":"error","title":"Type","isRequired":true,"uniqueKey":"moderation.oneOf.0.input.oneOf.1.type","typeLabel":"string"}},"additionalProperties":true,"isRequired":true,"uniqueKey":"moderation.oneOf.0.input.oneOf.1","typeLabel":"ModerationInputError · object"}],"isRequired":true,"uniqueKey":"moderation.oneOf.0.input","typeLabel":"ModerationInputModerationResults · object | ModerationInputError · object"},"output":{"oneOf":[{"type":"object","title":"ModerationOutputModerationResults","description":"Successful moderation results for the request input or generated output.","required":["model","results","type"],"properties":{"model":{"type":"string","title":"Model","isRequired":true,"uniqueKey":"moderation.oneOf.0.output.oneOf.0.model","typeLabel":"string"},"results":{"items":{"additionalProperties":true,"description":"A moderation result produced for the response input or output.","properties":{"categories":{"additionalProperties":{"type":"boolean","uniqueKey":"moderation.oneOf.0.output.oneOf.0.results.items.[INDEX].categories.additionalProperties","typeLabel":"boolean"},"title":"Categories","type":"object","isRequired":true,"uniqueKey":"moderation.oneOf.0.output.oneOf.0.results.items.[INDEX].categories","typeLabel":"Categories · object"},"category_applied_input_types":{"additionalProperties":{"items":{"enum":["text","image"],"type":"string","uniqueKey":"moderation.oneOf.0.output.oneOf.0.results.items.[INDEX].category_applied_input_types.additionalProperties.items.[INDEX]","typeLabel":"enum\u003cstring>"},"type":"array","uniqueKey":"moderation.oneOf.0.output.oneOf.0.results.items.[INDEX].category_applied_input_types.additionalProperties","typeLabel":"enum\u003cstring>[]"},"title":"Category Applied Input Types","type":"object","isRequired":true,"uniqueKey":"moderation.oneOf.0.output.oneOf.0.results.items.[INDEX].category_applied_input_types","typeLabel":"Category Applied Input Types · object"},"category_scores":{"additionalProperties":{"type":"number","uniqueKey":"moderation.oneOf.0.output.oneOf.0.results.items.[INDEX].category_scores.additionalProperties","typeLabel":"number"},"title":"Category Scores","type":"object","isRequired":true,"uniqueKey":"moderation.oneOf.0.output.oneOf.0.results.items.[INDEX].category_scores","typeLabel":"Category Scores · object"},"flagged":{"title":"Flagged","type":"boolean","isRequired":true,"uniqueKey":"moderation.oneOf.0.output.oneOf.0.results.items.[INDEX].flagged","typeLabel":"boolean"},"model":{"type":"string","title":"Model","isRequired":true,"uniqueKey":"moderation.oneOf.0.output.oneOf.0.results.items.[INDEX].model","typeLabel":"string"},"type":{"const":"moderation_result","title":"Type","type":"string","isRequired":true,"uniqueKey":"moderation.oneOf.0.output.oneOf.0.results.items.[INDEX].type","typeLabel":"string"}},"required":["categories","category_applied_input_types","category_scores","flagged","model","type"],"title":"ModerationOutputModerationResultsResult","type":"object","uniqueKey":"moderation.oneOf.0.output.oneOf.0.results.items.[INDEX]","typeLabel":"ModerationOutputModerationResultsResult · object"},"title":"Results","type":"array","isRequired":true,"uniqueKey":"moderation.oneOf.0.output.oneOf.0.results","typeLabel":"ModerationOutputModerationResultsResult · object[]"},"type":{"const":"moderation_results","title":"Type","type":"string","isRequired":true,"uniqueKey":"moderation.oneOf.0.output.oneOf.0.type","typeLabel":"string"}},"additionalProperties":true,"isRequired":true,"uniqueKey":"moderation.oneOf.0.output.oneOf.0","typeLabel":"ModerationOutputModerationResults · object"},{"type":"object","title":"ModerationOutputError","description":"An error produced while attempting moderation.","required":["code","message","type"],"properties":{"code":{"type":"string","title":"Code","isRequired":true,"uniqueKey":"moderation.oneOf.0.output.oneOf.1.code","typeLabel":"string"},"message":{"title":"Message","type":"string","isRequired":true,"uniqueKey":"moderation.oneOf.0.output.oneOf.1.message","typeLabel":"string"},"type":{"type":"string","const":"error","title":"Type","isRequired":true,"uniqueKey":"moderation.oneOf.0.output.oneOf.1.type","typeLabel":"string"}},"additionalProperties":true,"isRequired":true,"uniqueKey":"moderation.oneOf.0.output.oneOf.1","typeLabel":"ModerationOutputError · object"}],"isRequired":true,"uniqueKey":"moderation.oneOf.0.output","typeLabel":"ModerationOutputModerationResults · object | ModerationOutputError · object"}},"additionalProperties":true,"uniqueKey":"moderation.oneOf.0","typeLabel":"Moderation · object"},{"type":"null","uniqueKey":"moderation.oneOf.1","typeLabel":"null"}],"uniqueKey":"moderation","typeLabel":"Moderation · object | null"},"service_tier":{"oneOf":[{"type":"string","title":"Service Tier","enum":["auto","default","flex","scale","priority"],"uniqueKey":"service_tier.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Service Tier","uniqueKey":"service_tier.oneOf.1","typeLabel":"null"}],"uniqueKey":"service_tier","typeLabel":"enum\u003cstring> | null"},"system_fingerprint":{"oneOf":[{"type":"string","title":"System Fingerprint","uniqueKey":"system_fingerprint.oneOf.0","typeLabel":"string"},{"type":"null","title":"System Fingerprint","uniqueKey":"system_fingerprint.oneOf.1","typeLabel":"null"}],"uniqueKey":"system_fingerprint","typeLabel":"string | null"},"usage":{"oneOf":[{"type":"object","title":"CompletionUsage","description":"Usage statistics for the completion request.","required":["completion_tokens","prompt_tokens","total_tokens"],"properties":{"completion_tokens":{"title":"Completion Tokens","type":"integer","isRequired":true,"uniqueKey":"usage.oneOf.0.completion_tokens","typeLabel":"integer"},"prompt_tokens":{"title":"Prompt Tokens","type":"integer","isRequired":true,"uniqueKey":"usage.oneOf.0.prompt_tokens","typeLabel":"integer"},"total_tokens":{"title":"Total Tokens","type":"integer","isRequired":true,"uniqueKey":"usage.oneOf.0.total_tokens","typeLabel":"integer"},"completion_tokens_details":{"oneOf":[{"type":"object","title":"CompletionTokensDetails","description":"Breakdown of tokens used in a completion.","properties":{"accepted_prediction_tokens":{"oneOf":[{"type":"integer","title":"Accepted Prediction Tokens","uniqueKey":"usage.oneOf.0.completion_tokens_details.oneOf.0.accepted_prediction_tokens.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Accepted Prediction Tokens","uniqueKey":"usage.oneOf.0.completion_tokens_details.oneOf.0.accepted_prediction_tokens.oneOf.1","typeLabel":"null"}],"uniqueKey":"usage.oneOf.0.completion_tokens_details.oneOf.0.accepted_prediction_tokens","typeLabel":"integer | null"},"audio_tokens":{"oneOf":[{"type":"integer","title":"Audio Tokens","uniqueKey":"usage.oneOf.0.completion_tokens_details.oneOf.0.audio_tokens.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Audio Tokens","uniqueKey":"usage.oneOf.0.completion_tokens_details.oneOf.0.audio_tokens.oneOf.1","typeLabel":"null"}],"uniqueKey":"usage.oneOf.0.completion_tokens_details.oneOf.0.audio_tokens","typeLabel":"integer | null"},"reasoning_tokens":{"oneOf":[{"type":"integer","title":"Reasoning Tokens","uniqueKey":"usage.oneOf.0.completion_tokens_details.oneOf.0.reasoning_tokens.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Reasoning Tokens","uniqueKey":"usage.oneOf.0.completion_tokens_details.oneOf.0.reasoning_tokens.oneOf.1","typeLabel":"null"}],"uniqueKey":"usage.oneOf.0.completion_tokens_details.oneOf.0.reasoning_tokens","typeLabel":"integer | null"},"rejected_prediction_tokens":{"oneOf":[{"type":"integer","title":"Rejected Prediction Tokens","uniqueKey":"usage.oneOf.0.completion_tokens_details.oneOf.0.rejected_prediction_tokens.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Rejected Prediction Tokens","uniqueKey":"usage.oneOf.0.completion_tokens_details.oneOf.0.rejected_prediction_tokens.oneOf.1","typeLabel":"null"}],"uniqueKey":"usage.oneOf.0.completion_tokens_details.oneOf.0.rejected_prediction_tokens","typeLabel":"integer | null"}},"additionalProperties":true,"uniqueKey":"usage.oneOf.0.completion_tokens_details.oneOf.0","typeLabel":"CompletionTokensDetails · object"},{"type":"null","uniqueKey":"usage.oneOf.0.completion_tokens_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"usage.oneOf.0.completion_tokens_details","typeLabel":"CompletionTokensDetails · object | null"},"prompt_tokens_details":{"oneOf":[{"type":"object","title":"PromptTokensDetails","description":"Breakdown of tokens used in the prompt.","properties":{"audio_tokens":{"oneOf":[{"type":"integer","title":"Audio Tokens","uniqueKey":"usage.oneOf.0.prompt_tokens_details.oneOf.0.audio_tokens.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Audio Tokens","uniqueKey":"usage.oneOf.0.prompt_tokens_details.oneOf.0.audio_tokens.oneOf.1","typeLabel":"null"}],"uniqueKey":"usage.oneOf.0.prompt_tokens_details.oneOf.0.audio_tokens","typeLabel":"integer | null"},"cached_tokens":{"oneOf":[{"type":"integer","title":"Cached Tokens","uniqueKey":"usage.oneOf.0.prompt_tokens_details.oneOf.0.cached_tokens.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Cached Tokens","uniqueKey":"usage.oneOf.0.prompt_tokens_details.oneOf.0.cached_tokens.oneOf.1","typeLabel":"null"}],"uniqueKey":"usage.oneOf.0.prompt_tokens_details.oneOf.0.cached_tokens","typeLabel":"integer | null"}},"additionalProperties":true,"uniqueKey":"usage.oneOf.0.prompt_tokens_details.oneOf.0","typeLabel":"PromptTokensDetails · object"},{"type":"null","uniqueKey":"usage.oneOf.0.prompt_tokens_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"usage.oneOf.0.prompt_tokens_details","typeLabel":"PromptTokensDetails · object | null"}},"additionalProperties":true,"uniqueKey":"usage.oneOf.0","typeLabel":"CompletionUsage · object"},{"type":"null","uniqueKey":"usage.oneOf.1","typeLabel":"null"}],"uniqueKey":"usage","typeLabel":"CompletionUsage · object | null"},"basis":{"items":{"description":"Citations and reasoning supporting one field of a task output.","properties":{"field":{"description":"Name of the output field.","title":"Field","type":"string","isRequired":true,"uniqueKey":"basis.items.[INDEX].field","typeLabel":"string"},"reasoning":{"description":"Reasoning for the output field.","title":"Reasoning","type":"string","isRequired":true,"uniqueKey":"basis.items.[INDEX].reasoning","typeLabel":"string"},"citations":{"default":[],"description":"List of citations supporting the output field.","items":{"description":"A citation for a task output.","properties":{"url":{"description":"URL of the citation.","title":"Url","type":"string","isRequired":true,"uniqueKey":"basis.items.[INDEX].citations.items.[INDEX].url","typeLabel":"string"},"title":{"oneOf":[{"type":"string","title":"Title","description":"Title of the citation.","uniqueKey":"basis.items.[INDEX].citations.items.[INDEX].title.oneOf.0","typeLabel":"string"},{"type":"null","title":"Title","description":"Title of the citation.","uniqueKey":"basis.items.[INDEX].citations.items.[INDEX].title.oneOf.1","typeLabel":"null"}],"uniqueKey":"basis.items.[INDEX].citations.items.[INDEX].title","typeLabel":"string | null"},"excerpts":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"basis.items.[INDEX].citations.items.[INDEX].excerpts.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Excerpts","description":"Excerpts from the citation supporting the output. Only certain processors provide excerpts.","uniqueKey":"basis.items.[INDEX].citations.items.[INDEX].excerpts.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Excerpts","description":"Excerpts from the citation supporting the output. Only certain processors provide excerpts.","uniqueKey":"basis.items.[INDEX].citations.items.[INDEX].excerpts.oneOf.1","typeLabel":"null"}],"uniqueKey":"basis.items.[INDEX].citations.items.[INDEX].excerpts","typeLabel":"string[] | null"}},"required":["url"],"title":"Citation","type":"object","uniqueKey":"basis.items.[INDEX].citations.items.[INDEX]","typeLabel":"Citation · object"},"title":"Citations","type":"array","uniqueKey":"basis.items.[INDEX].citations","typeLabel":"Citation · object[]"},"confidence":{"oneOf":[{"type":"string","title":"Confidence","description":"Confidence level for the output field. Only certain processors provide confidence levels.","example":"low","uniqueKey":"basis.items.[INDEX].confidence.oneOf.0","typeLabel":"string"},{"type":"null","title":"Confidence","description":"Confidence level for the output field. Only certain processors provide confidence levels.","example":"low","uniqueKey":"basis.items.[INDEX].confidence.oneOf.1","typeLabel":"null"}],"uniqueKey":"basis.items.[INDEX].confidence","typeLabel":"string | null"}},"required":["field","reasoning"],"title":"FieldBasis","type":"object","uniqueKey":"basis.items.[INDEX]","typeLabel":"FieldBasis · object"},"type":"array","title":"Basis","description":"Basis for the chat completion, including citations and reasoning supporting the output.","default":[],"uniqueKey":"basis","typeLabel":"FieldBasis · object[]"},"interaction_id":{"oneOf":[{"type":"string","title":"Interaction Id","description":"Identifier for this interaction. Pass as previous_interaction_id for follow-ups.","uniqueKey":"interaction_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Interaction Id","description":"Identifier for this interaction. Pass as previous_interaction_id for follow-ups.","uniqueKey":"interaction_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"interaction_id","typeLabel":"string | null"}},"additionalProperties":true,"type":"object","required":["id","choices","created","model","object"],"title":"ChatCompletion","description":"Chat completion response.","uniqueKey":"","typeLabel":"ChatCompletion · object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","choices":[{"delta":{"content":"\u003cstring>","function_call":{"arguments":"\u003cstring>","name":"\u003cstring>"},"refusal":"\u003cstring>","role":"developer","tool_calls":[{"index":123,"id":"\u003cstring>","function":{"arguments":"\u003cstring>","name":"\u003cstring>"},"type":"function"}]},"index":123,"finish_reason":"stop","logprobs":{"content":[{"token":"\u003cstring>","logprob":123,"top_logprobs":[{"token":"\u003cstring>","logprob":123,"bytes":[123]}],"bytes":[123]}],"refusal":[{"token":"\u003cstring>","logprob":123,"top_logprobs":[{"token":"\u003cstring>","logprob":123,"bytes":[123]}],"bytes":[123]}]}}],"created":123,"model":"\u003cstring>","object":"chat.completion","moderation":{"input":{"model":"\u003cstring>","results":[{"categories":{},"category_applied_input_types":{},"category_scores":{},"flagged":true,"model":"\u003cstring>","type":"moderation_result"}],"type":"moderation_results"},"output":{"model":"\u003cstring>","results":[{"categories":{},"category_applied_input_types":{},"category_scores":{},"flagged":true,"model":"\u003cstring>","type":"moderation_result"}],"type":"moderation_results"}},"service_tier":"auto","system_fingerprint":"\u003cstring>","usage":{"completion_tokens":123,"prompt_tokens":123,"total_tokens":123,"completion_tokens_details":{"accepted_prediction_tokens":123,"audio_tokens":123,"reasoning_tokens":123,"rejected_prediction_tokens":123},"prompt_tokens_details":{"audio_tokens":123,"cached_tokens":123}},"basis":[],"interaction_id":"\u003cstring>"}}},"exampleType":"generated"},"text/event-stream":{"schema":{"additionalProperties":true,"description":"Chat completion response chunk.","properties":{"id":{"description":"The id of the chat completion response chunk.","title":"Id","type":"string","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"choices":{"items":{"additionalProperties":true,"properties":{"delta":{"additionalProperties":true,"description":"A chat completion delta generated by streamed model responses.","properties":{"content":{"oneOf":[{"type":"string","title":"Content","uniqueKey":"choices.items.[INDEX].delta.content.oneOf.0","typeLabel":"string"},{"type":"null","title":"Content","uniqueKey":"choices.items.[INDEX].delta.content.oneOf.1","typeLabel":"null"}],"uniqueKey":"choices.items.[INDEX].delta.content","typeLabel":"string | null"},"function_call":{"oneOf":[{"type":"object","title":"ChoiceDeltaFunctionCall","description":"Deprecated and replaced by `tool_calls`.\n\nThe name and arguments of a function that should be called, as generated by the model.","properties":{"arguments":{"oneOf":[{"type":"string","title":"Arguments","uniqueKey":"choices.items.[INDEX].delta.function_call.oneOf.0.arguments.oneOf.0","typeLabel":"string"},{"type":"null","title":"Arguments","uniqueKey":"choices.items.[INDEX].delta.function_call.oneOf.0.arguments.oneOf.1","typeLabel":"null"}],"uniqueKey":"choices.items.[INDEX].delta.function_call.oneOf.0.arguments","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","title":"Name","uniqueKey":"choices.items.[INDEX].delta.function_call.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Name","uniqueKey":"choices.items.[INDEX].delta.function_call.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"choices.items.[INDEX].delta.function_call.oneOf.0.name","typeLabel":"string | null"}},"additionalProperties":true,"uniqueKey":"choices.items.[INDEX].delta.function_call.oneOf.0","typeLabel":"ChoiceDeltaFunctionCall · object"},{"type":"null","uniqueKey":"choices.items.[INDEX].delta.function_call.oneOf.1","typeLabel":"null"}],"uniqueKey":"choices.items.[INDEX].delta.function_call","typeLabel":"ChoiceDeltaFunctionCall · object | null"},"refusal":{"oneOf":[{"type":"string","title":"Refusal","uniqueKey":"choices.items.[INDEX].delta.refusal.oneOf.0","typeLabel":"string"},{"type":"null","title":"Refusal","uniqueKey":"choices.items.[INDEX].delta.refusal.oneOf.1","typeLabel":"null"}],"uniqueKey":"choices.items.[INDEX].delta.refusal","typeLabel":"string | null"},"role":{"oneOf":[{"type":"string","title":"Role","enum":["developer","system","user","assistant","tool"],"uniqueKey":"choices.items.[INDEX].delta.role.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Role","uniqueKey":"choices.items.[INDEX].delta.role.oneOf.1","typeLabel":"null"}],"uniqueKey":"choices.items.[INDEX].delta.role","typeLabel":"enum\u003cstring> | null"},"tool_calls":{"oneOf":[{"type":"array","items":{"additionalProperties":true,"properties":{"index":{"title":"Index","type":"integer","isRequired":true,"uniqueKey":"choices.items.[INDEX].delta.tool_calls.oneOf.0.items.[INDEX].index","typeLabel":"integer"},"id":{"oneOf":[{"type":"string","title":"Id","uniqueKey":"choices.items.[INDEX].delta.tool_calls.oneOf.0.items.[INDEX].id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Id","uniqueKey":"choices.items.[INDEX].delta.tool_calls.oneOf.0.items.[INDEX].id.oneOf.1","typeLabel":"null"}],"uniqueKey":"choices.items.[INDEX].delta.tool_calls.oneOf.0.items.[INDEX].id","typeLabel":"string | null"},"function":{"oneOf":[{"type":"object","title":"ChoiceDeltaToolCallFunction","properties":{"arguments":{"oneOf":[{"type":"string","title":"Arguments","uniqueKey":"choices.items.[INDEX].delta.tool_calls.oneOf.0.items.[INDEX].function.oneOf.0.arguments.oneOf.0","typeLabel":"string"},{"type":"null","title":"Arguments","uniqueKey":"choices.items.[INDEX].delta.tool_calls.oneOf.0.items.[INDEX].function.oneOf.0.arguments.oneOf.1","typeLabel":"null"}],"uniqueKey":"choices.items.[INDEX].delta.tool_calls.oneOf.0.items.[INDEX].function.oneOf.0.arguments","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","title":"Name","uniqueKey":"choices.items.[INDEX].delta.tool_calls.oneOf.0.items.[INDEX].function.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Name","uniqueKey":"choices.items.[INDEX].delta.tool_calls.oneOf.0.items.[INDEX].function.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"choices.items.[INDEX].delta.tool_calls.oneOf.0.items.[INDEX].function.oneOf.0.name","typeLabel":"string | null"}},"additionalProperties":true,"uniqueKey":"choices.items.[INDEX].delta.tool_calls.oneOf.0.items.[INDEX].function.oneOf.0","typeLabel":"ChoiceDeltaToolCallFunction · object"},{"type":"null","uniqueKey":"choices.items.[INDEX].delta.tool_calls.oneOf.0.items.[INDEX].function.oneOf.1","typeLabel":"null"}],"uniqueKey":"choices.items.[INDEX].delta.tool_calls.oneOf.0.items.[INDEX].function","typeLabel":"ChoiceDeltaToolCallFunction · object | null"},"type":{"oneOf":[{"type":"string","title":"Type","const":"function","uniqueKey":"choices.items.[INDEX].delta.tool_calls.oneOf.0.items.[INDEX].type.oneOf.0","typeLabel":"string"},{"type":"null","title":"Type","uniqueKey":"choices.items.[INDEX].delta.tool_calls.oneOf.0.items.[INDEX].type.oneOf.1","typeLabel":"null"}],"uniqueKey":"choices.items.[INDEX].delta.tool_calls.oneOf.0.items.[INDEX].type","typeLabel":"string | null"}},"required":["index"],"title":"ChoiceDeltaToolCall","type":"object","uniqueKey":"choices.items.[INDEX].delta.tool_calls.oneOf.0.items.[INDEX]","typeLabel":"ChoiceDeltaToolCall · object"},"title":"Tool Calls","uniqueKey":"choices.items.[INDEX].delta.tool_calls.oneOf.0","typeLabel":"ChoiceDeltaToolCall · object[]"},{"type":"null","title":"Tool Calls","uniqueKey":"choices.items.[INDEX].delta.tool_calls.oneOf.1","typeLabel":"null"}],"uniqueKey":"choices.items.[INDEX].delta.tool_calls","typeLabel":"ChoiceDeltaToolCall · object[] | null"}},"title":"ChoiceDelta","type":"object","isRequired":true,"uniqueKey":"choices.items.[INDEX].delta","typeLabel":"ChoiceDelta · object"},"index":{"title":"Index","type":"integer","isRequired":true,"uniqueKey":"choices.items.[INDEX].index","typeLabel":"integer"},"finish_reason":{"oneOf":[{"type":"string","title":"Finish Reason","enum":["stop","length","tool_calls","content_filter","function_call"],"uniqueKey":"choices.items.[INDEX].finish_reason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Finish Reason","uniqueKey":"choices.items.[INDEX].finish_reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"choices.items.[INDEX].finish_reason","typeLabel":"enum\u003cstring> | null"},"logprobs":{"oneOf":[{"type":"object","title":"ChoiceLogprobs","description":"Log probability information for the choice.","properties":{"content":{"oneOf":[{"type":"array","items":{"additionalProperties":true,"properties":{"token":{"title":"Token","type":"string","isRequired":true,"uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.content.oneOf.0.items.[INDEX].token","typeLabel":"string"},"logprob":{"title":"Logprob","type":"number","isRequired":true,"uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.content.oneOf.0.items.[INDEX].logprob","typeLabel":"number"},"top_logprobs":{"items":{"additionalProperties":true,"properties":{"token":{"title":"Token","type":"string","isRequired":true,"uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.content.oneOf.0.items.[INDEX].top_logprobs.items.[INDEX].token","typeLabel":"string"},"logprob":{"title":"Logprob","type":"number","isRequired":true,"uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.content.oneOf.0.items.[INDEX].top_logprobs.items.[INDEX].logprob","typeLabel":"number"},"bytes":{"oneOf":[{"type":"array","items":{"type":"integer","uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.content.oneOf.0.items.[INDEX].top_logprobs.items.[INDEX].bytes.oneOf.0.items.[INDEX]","typeLabel":"integer"},"title":"Bytes","uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.content.oneOf.0.items.[INDEX].top_logprobs.items.[INDEX].bytes.oneOf.0","typeLabel":"integer[]"},{"type":"null","title":"Bytes","uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.content.oneOf.0.items.[INDEX].top_logprobs.items.[INDEX].bytes.oneOf.1","typeLabel":"null"}],"uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.content.oneOf.0.items.[INDEX].top_logprobs.items.[INDEX].bytes","typeLabel":"integer[] | null"}},"required":["token","logprob"],"title":"TopLogprob","type":"object","uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.content.oneOf.0.items.[INDEX].top_logprobs.items.[INDEX]","typeLabel":"TopLogprob · object"},"title":"Top Logprobs","type":"array","isRequired":true,"uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.content.oneOf.0.items.[INDEX].top_logprobs","typeLabel":"TopLogprob · object[]"},"bytes":{"oneOf":[{"type":"array","items":{"type":"integer","uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.content.oneOf.0.items.[INDEX].bytes.oneOf.0.items.[INDEX]","typeLabel":"integer"},"title":"Bytes","uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.content.oneOf.0.items.[INDEX].bytes.oneOf.0","typeLabel":"integer[]"},{"type":"null","title":"Bytes","uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.content.oneOf.0.items.[INDEX].bytes.oneOf.1","typeLabel":"null"}],"uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.content.oneOf.0.items.[INDEX].bytes","typeLabel":"integer[] | null"}},"required":["token","logprob","top_logprobs"],"title":"ChatCompletionTokenLogprob","type":"object","uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.content.oneOf.0.items.[INDEX]","typeLabel":"ChatCompletionTokenLogprob · object"},"title":"Content","uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.content.oneOf.0","typeLabel":"ChatCompletionTokenLogprob · object[]"},{"type":"null","title":"Content","uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.content.oneOf.1","typeLabel":"null"}],"uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.content","typeLabel":"ChatCompletionTokenLogprob · object[] | null"},"refusal":{"oneOf":[{"type":"array","items":{"additionalProperties":true,"properties":{"token":{"title":"Token","type":"string","isRequired":true,"uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.refusal.oneOf.0.items.[INDEX].token","typeLabel":"string"},"logprob":{"title":"Logprob","type":"number","isRequired":true,"uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.refusal.oneOf.0.items.[INDEX].logprob","typeLabel":"number"},"top_logprobs":{"items":{"additionalProperties":true,"properties":{"token":{"title":"Token","type":"string","isRequired":true,"uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.refusal.oneOf.0.items.[INDEX].top_logprobs.items.[INDEX].token","typeLabel":"string"},"logprob":{"title":"Logprob","type":"number","isRequired":true,"uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.refusal.oneOf.0.items.[INDEX].top_logprobs.items.[INDEX].logprob","typeLabel":"number"},"bytes":{"oneOf":[{"type":"array","items":{"type":"integer","uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.refusal.oneOf.0.items.[INDEX].top_logprobs.items.[INDEX].bytes.oneOf.0.items.[INDEX]","typeLabel":"integer"},"title":"Bytes","uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.refusal.oneOf.0.items.[INDEX].top_logprobs.items.[INDEX].bytes.oneOf.0","typeLabel":"integer[]"},{"type":"null","title":"Bytes","uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.refusal.oneOf.0.items.[INDEX].top_logprobs.items.[INDEX].bytes.oneOf.1","typeLabel":"null"}],"uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.refusal.oneOf.0.items.[INDEX].top_logprobs.items.[INDEX].bytes","typeLabel":"integer[] | null"}},"required":["token","logprob"],"title":"TopLogprob","type":"object","uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.refusal.oneOf.0.items.[INDEX].top_logprobs.items.[INDEX]","typeLabel":"TopLogprob · object"},"title":"Top Logprobs","type":"array","isRequired":true,"uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.refusal.oneOf.0.items.[INDEX].top_logprobs","typeLabel":"TopLogprob · object[]"},"bytes":{"oneOf":[{"type":"array","items":{"type":"integer","uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.refusal.oneOf.0.items.[INDEX].bytes.oneOf.0.items.[INDEX]","typeLabel":"integer"},"title":"Bytes","uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.refusal.oneOf.0.items.[INDEX].bytes.oneOf.0","typeLabel":"integer[]"},{"type":"null","title":"Bytes","uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.refusal.oneOf.0.items.[INDEX].bytes.oneOf.1","typeLabel":"null"}],"uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.refusal.oneOf.0.items.[INDEX].bytes","typeLabel":"integer[] | null"}},"required":["token","logprob","top_logprobs"],"title":"ChatCompletionTokenLogprob","type":"object","uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.refusal.oneOf.0.items.[INDEX]","typeLabel":"ChatCompletionTokenLogprob · object"},"title":"Refusal","uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.refusal.oneOf.0","typeLabel":"ChatCompletionTokenLogprob · object[]"},{"type":"null","title":"Refusal","uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.refusal.oneOf.1","typeLabel":"null"}],"uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.refusal","typeLabel":"ChatCompletionTokenLogprob · object[] | null"}},"additionalProperties":true,"uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0","typeLabel":"ChoiceLogprobs · object"},{"type":"null","uniqueKey":"choices.items.[INDEX].logprobs.oneOf.1","typeLabel":"null"}],"uniqueKey":"choices.items.[INDEX].logprobs","typeLabel":"ChoiceLogprobs · object | null"}},"required":["delta","index"],"title":"Choice","type":"object","uniqueKey":"choices.items.[INDEX]","typeLabel":"Choice · object"},"type":"array","title":"Choices","isRequired":true,"uniqueKey":"choices","typeLabel":"Choice · object[]"},"created":{"type":"integer","title":"Created","isRequired":true,"uniqueKey":"created","typeLabel":"integer"},"model":{"type":"string","title":"Model","isRequired":true,"uniqueKey":"model","typeLabel":"string"},"object":{"const":"chat.completion.chunk","title":"Object","type":"string","isRequired":true,"uniqueKey":"object","typeLabel":"string"},"type":{"const":"chat.completion.chunk","description":"The type of the chat completion chunk. Always `chat.completion.chunk`.","title":"Type","type":"string","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"moderation":{"oneOf":[{"type":"object","title":"Moderation","description":"Moderation results for the response input and output, if moderated completions were requested.","required":["input","output"],"properties":{"input":{"oneOf":[{"type":"object","title":"ModerationInputModerationResult","description":"A moderation result produced for the response input or output.","required":["categories","category_applied_input_types","category_scores","flagged","model","type"],"properties":{"categories":{"additionalProperties":{"type":"boolean","uniqueKey":"moderation.oneOf.0.input.oneOf.0.categories.additionalProperties","typeLabel":"boolean"},"title":"Categories","type":"object","isRequired":true,"uniqueKey":"moderation.oneOf.0.input.oneOf.0.categories","typeLabel":"Categories · object"},"category_applied_input_types":{"additionalProperties":{"items":{"enum":["text","image"],"type":"string","uniqueKey":"moderation.oneOf.0.input.oneOf.0.category_applied_input_types.additionalProperties.items.[INDEX]","typeLabel":"enum\u003cstring>"},"type":"array","uniqueKey":"moderation.oneOf.0.input.oneOf.0.category_applied_input_types.additionalProperties","typeLabel":"enum\u003cstring>[]"},"title":"Category Applied Input Types","type":"object","isRequired":true,"uniqueKey":"moderation.oneOf.0.input.oneOf.0.category_applied_input_types","typeLabel":"Category Applied Input Types · object"},"category_scores":{"additionalProperties":{"type":"number","uniqueKey":"moderation.oneOf.0.input.oneOf.0.category_scores.additionalProperties","typeLabel":"number"},"title":"Category Scores","type":"object","isRequired":true,"uniqueKey":"moderation.oneOf.0.input.oneOf.0.category_scores","typeLabel":"Category Scores · object"},"flagged":{"title":"Flagged","type":"boolean","isRequired":true,"uniqueKey":"moderation.oneOf.0.input.oneOf.0.flagged","typeLabel":"boolean"},"model":{"type":"string","title":"Model","isRequired":true,"uniqueKey":"moderation.oneOf.0.input.oneOf.0.model","typeLabel":"string"},"type":{"const":"moderation_result","title":"Type","type":"string","isRequired":true,"uniqueKey":"moderation.oneOf.0.input.oneOf.0.type","typeLabel":"string"}},"additionalProperties":true,"isRequired":true,"uniqueKey":"moderation.oneOf.0.input.oneOf.0","typeLabel":"ModerationInputModerationResult · object"},{"type":"object","title":"ModerationInputError","description":"An error produced while attempting moderation for the response input or output.","required":["code","message","type"],"properties":{"code":{"type":"string","title":"Code","isRequired":true,"uniqueKey":"moderation.oneOf.0.input.oneOf.1.code","typeLabel":"string"},"message":{"title":"Message","type":"string","isRequired":true,"uniqueKey":"moderation.oneOf.0.input.oneOf.1.message","typeLabel":"string"},"type":{"type":"string","const":"error","title":"Type","isRequired":true,"uniqueKey":"moderation.oneOf.0.input.oneOf.1.type","typeLabel":"string"}},"additionalProperties":true,"isRequired":true,"uniqueKey":"moderation.oneOf.0.input.oneOf.1","typeLabel":"ModerationInputError · object"}],"isRequired":true,"uniqueKey":"moderation.oneOf.0.input","typeLabel":"ModerationInputModerationResult · object | ModerationInputError · object"},"output":{"oneOf":[{"type":"object","title":"ModerationOutputModerationResult","description":"A moderation result produced for the response input or output.","required":["categories","category_applied_input_types","category_scores","flagged","model","type"],"properties":{"categories":{"additionalProperties":{"type":"boolean","uniqueKey":"moderation.oneOf.0.output.oneOf.0.categories.additionalProperties","typeLabel":"boolean"},"title":"Categories","type":"object","isRequired":true,"uniqueKey":"moderation.oneOf.0.output.oneOf.0.categories","typeLabel":"Categories · object"},"category_applied_input_types":{"additionalProperties":{"items":{"enum":["text","image"],"type":"string","uniqueKey":"moderation.oneOf.0.output.oneOf.0.category_applied_input_types.additionalProperties.items.[INDEX]","typeLabel":"enum\u003cstring>"},"type":"array","uniqueKey":"moderation.oneOf.0.output.oneOf.0.category_applied_input_types.additionalProperties","typeLabel":"enum\u003cstring>[]"},"title":"Category Applied Input Types","type":"object","isRequired":true,"uniqueKey":"moderation.oneOf.0.output.oneOf.0.category_applied_input_types","typeLabel":"Category Applied Input Types · object"},"category_scores":{"additionalProperties":{"type":"number","uniqueKey":"moderation.oneOf.0.output.oneOf.0.category_scores.additionalProperties","typeLabel":"number"},"title":"Category Scores","type":"object","isRequired":true,"uniqueKey":"moderation.oneOf.0.output.oneOf.0.category_scores","typeLabel":"Category Scores · object"},"flagged":{"title":"Flagged","type":"boolean","isRequired":true,"uniqueKey":"moderation.oneOf.0.output.oneOf.0.flagged","typeLabel":"boolean"},"model":{"type":"string","title":"Model","isRequired":true,"uniqueKey":"moderation.oneOf.0.output.oneOf.0.model","typeLabel":"string"},"type":{"const":"moderation_result","title":"Type","type":"string","isRequired":true,"uniqueKey":"moderation.oneOf.0.output.oneOf.0.type","typeLabel":"string"}},"additionalProperties":true,"isRequired":true,"uniqueKey":"moderation.oneOf.0.output.oneOf.0","typeLabel":"ModerationOutputModerationResult · object"},{"type":"object","title":"ModerationOutputError","description":"An error produced while attempting moderation for the response input or output.","required":["code","message","type"],"properties":{"code":{"type":"string","title":"Code","isRequired":true,"uniqueKey":"moderation.oneOf.0.output.oneOf.1.code","typeLabel":"string"},"message":{"title":"Message","type":"string","isRequired":true,"uniqueKey":"moderation.oneOf.0.output.oneOf.1.message","typeLabel":"string"},"type":{"type":"string","const":"error","title":"Type","isRequired":true,"uniqueKey":"moderation.oneOf.0.output.oneOf.1.type","typeLabel":"string"}},"additionalProperties":true,"isRequired":true,"uniqueKey":"moderation.oneOf.0.output.oneOf.1","typeLabel":"ModerationOutputError · object"}],"isRequired":true,"uniqueKey":"moderation.oneOf.0.output","typeLabel":"ModerationOutputModerationResult · object | ModerationOutputError · object"}},"additionalProperties":true,"uniqueKey":"moderation.oneOf.0","typeLabel":"Moderation · object"},{"type":"null","uniqueKey":"moderation.oneOf.1","typeLabel":"null"}],"uniqueKey":"moderation","typeLabel":"Moderation · object | null"},"service_tier":{"oneOf":[{"type":"string","title":"Service Tier","enum":["auto","default","flex","scale","priority"],"uniqueKey":"service_tier.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Service Tier","uniqueKey":"service_tier.oneOf.1","typeLabel":"null"}],"uniqueKey":"service_tier","typeLabel":"enum\u003cstring> | null"},"system_fingerprint":{"oneOf":[{"type":"string","title":"System Fingerprint","uniqueKey":"system_fingerprint.oneOf.0","typeLabel":"string"},{"type":"null","title":"System Fingerprint","uniqueKey":"system_fingerprint.oneOf.1","typeLabel":"null"}],"uniqueKey":"system_fingerprint","typeLabel":"string | null"},"usage":{"oneOf":[{"type":"object","title":"CompletionUsage","description":"Usage statistics for the completion request.","required":["completion_tokens","prompt_tokens","total_tokens"],"properties":{"completion_tokens":{"title":"Completion Tokens","type":"integer","isRequired":true,"uniqueKey":"usage.oneOf.0.completion_tokens","typeLabel":"integer"},"prompt_tokens":{"title":"Prompt Tokens","type":"integer","isRequired":true,"uniqueKey":"usage.oneOf.0.prompt_tokens","typeLabel":"integer"},"total_tokens":{"title":"Total Tokens","type":"integer","isRequired":true,"uniqueKey":"usage.oneOf.0.total_tokens","typeLabel":"integer"},"completion_tokens_details":{"oneOf":[{"type":"object","title":"CompletionTokensDetails","description":"Breakdown of tokens used in a completion.","properties":{"accepted_prediction_tokens":{"oneOf":[{"type":"integer","title":"Accepted Prediction Tokens","uniqueKey":"usage.oneOf.0.completion_tokens_details.oneOf.0.accepted_prediction_tokens.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Accepted Prediction Tokens","uniqueKey":"usage.oneOf.0.completion_tokens_details.oneOf.0.accepted_prediction_tokens.oneOf.1","typeLabel":"null"}],"uniqueKey":"usage.oneOf.0.completion_tokens_details.oneOf.0.accepted_prediction_tokens","typeLabel":"integer | null"},"audio_tokens":{"oneOf":[{"type":"integer","title":"Audio Tokens","uniqueKey":"usage.oneOf.0.completion_tokens_details.oneOf.0.audio_tokens.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Audio Tokens","uniqueKey":"usage.oneOf.0.completion_tokens_details.oneOf.0.audio_tokens.oneOf.1","typeLabel":"null"}],"uniqueKey":"usage.oneOf.0.completion_tokens_details.oneOf.0.audio_tokens","typeLabel":"integer | null"},"reasoning_tokens":{"oneOf":[{"type":"integer","title":"Reasoning Tokens","uniqueKey":"usage.oneOf.0.completion_tokens_details.oneOf.0.reasoning_tokens.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Reasoning Tokens","uniqueKey":"usage.oneOf.0.completion_tokens_details.oneOf.0.reasoning_tokens.oneOf.1","typeLabel":"null"}],"uniqueKey":"usage.oneOf.0.completion_tokens_details.oneOf.0.reasoning_tokens","typeLabel":"integer | null"},"rejected_prediction_tokens":{"oneOf":[{"type":"integer","title":"Rejected Prediction Tokens","uniqueKey":"usage.oneOf.0.completion_tokens_details.oneOf.0.rejected_prediction_tokens.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Rejected Prediction Tokens","uniqueKey":"usage.oneOf.0.completion_tokens_details.oneOf.0.rejected_prediction_tokens.oneOf.1","typeLabel":"null"}],"uniqueKey":"usage.oneOf.0.completion_tokens_details.oneOf.0.rejected_prediction_tokens","typeLabel":"integer | null"}},"additionalProperties":true,"uniqueKey":"usage.oneOf.0.completion_tokens_details.oneOf.0","typeLabel":"CompletionTokensDetails · object"},{"type":"null","uniqueKey":"usage.oneOf.0.completion_tokens_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"usage.oneOf.0.completion_tokens_details","typeLabel":"CompletionTokensDetails · object | null"},"prompt_tokens_details":{"oneOf":[{"type":"object","title":"PromptTokensDetails","description":"Breakdown of tokens used in the prompt.","properties":{"audio_tokens":{"oneOf":[{"type":"integer","title":"Audio Tokens","uniqueKey":"usage.oneOf.0.prompt_tokens_details.oneOf.0.audio_tokens.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Audio Tokens","uniqueKey":"usage.oneOf.0.prompt_tokens_details.oneOf.0.audio_tokens.oneOf.1","typeLabel":"null"}],"uniqueKey":"usage.oneOf.0.prompt_tokens_details.oneOf.0.audio_tokens","typeLabel":"integer | null"},"cached_tokens":{"oneOf":[{"type":"integer","title":"Cached Tokens","uniqueKey":"usage.oneOf.0.prompt_tokens_details.oneOf.0.cached_tokens.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Cached Tokens","uniqueKey":"usage.oneOf.0.prompt_tokens_details.oneOf.0.cached_tokens.oneOf.1","typeLabel":"null"}],"uniqueKey":"usage.oneOf.0.prompt_tokens_details.oneOf.0.cached_tokens","typeLabel":"integer | null"}},"additionalProperties":true,"uniqueKey":"usage.oneOf.0.prompt_tokens_details.oneOf.0","typeLabel":"PromptTokensDetails · object"},{"type":"null","uniqueKey":"usage.oneOf.0.prompt_tokens_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"usage.oneOf.0.prompt_tokens_details","typeLabel":"PromptTokensDetails · object | null"}},"additionalProperties":true,"uniqueKey":"usage.oneOf.0","typeLabel":"CompletionUsage · object"},{"type":"null","uniqueKey":"usage.oneOf.1","typeLabel":"null"}],"uniqueKey":"usage","typeLabel":"CompletionUsage · object | null"},"basis":{"default":[],"description":"Basis for the chat completion chunk, including citations and reasoning supporting the output.","items":{"description":"Citations and reasoning supporting one field of a task output.","properties":{"field":{"description":"Name of the output field.","title":"Field","type":"string","isRequired":true,"uniqueKey":"basis.items.[INDEX].field","typeLabel":"string"},"reasoning":{"description":"Reasoning for the output field.","title":"Reasoning","type":"string","isRequired":true,"uniqueKey":"basis.items.[INDEX].reasoning","typeLabel":"string"},"citations":{"default":[],"description":"List of citations supporting the output field.","items":{"description":"A citation for a task output.","properties":{"url":{"description":"URL of the citation.","title":"Url","type":"string","isRequired":true,"uniqueKey":"basis.items.[INDEX].citations.items.[INDEX].url","typeLabel":"string"},"title":{"oneOf":[{"type":"string","title":"Title","description":"Title of the citation.","uniqueKey":"basis.items.[INDEX].citations.items.[INDEX].title.oneOf.0","typeLabel":"string"},{"type":"null","title":"Title","description":"Title of the citation.","uniqueKey":"basis.items.[INDEX].citations.items.[INDEX].title.oneOf.1","typeLabel":"null"}],"uniqueKey":"basis.items.[INDEX].citations.items.[INDEX].title","typeLabel":"string | null"},"excerpts":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"basis.items.[INDEX].citations.items.[INDEX].excerpts.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Excerpts","description":"Excerpts from the citation supporting the output. Only certain processors provide excerpts.","uniqueKey":"basis.items.[INDEX].citations.items.[INDEX].excerpts.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Excerpts","description":"Excerpts from the citation supporting the output. Only certain processors provide excerpts.","uniqueKey":"basis.items.[INDEX].citations.items.[INDEX].excerpts.oneOf.1","typeLabel":"null"}],"uniqueKey":"basis.items.[INDEX].citations.items.[INDEX].excerpts","typeLabel":"string[] | null"}},"required":["url"],"title":"Citation","type":"object","uniqueKey":"basis.items.[INDEX].citations.items.[INDEX]","typeLabel":"Citation · object"},"title":"Citations","type":"array","uniqueKey":"basis.items.[INDEX].citations","typeLabel":"Citation · object[]"},"confidence":{"oneOf":[{"type":"string","title":"Confidence","description":"Confidence level for the output field. Only certain processors provide confidence levels.","example":"low","uniqueKey":"basis.items.[INDEX].confidence.oneOf.0","typeLabel":"string"},{"type":"null","title":"Confidence","description":"Confidence level for the output field. Only certain processors provide confidence levels.","example":"low","uniqueKey":"basis.items.[INDEX].confidence.oneOf.1","typeLabel":"null"}],"uniqueKey":"basis.items.[INDEX].confidence","typeLabel":"string | null"}},"required":["field","reasoning"],"title":"FieldBasis","type":"object","uniqueKey":"basis.items.[INDEX]","typeLabel":"FieldBasis · object"},"title":"Basis","type":"array","uniqueKey":"basis","typeLabel":"FieldBasis · object[]"},"interaction_id":{"oneOf":[{"type":"string","title":"Interaction Id","description":"Identifier for this interaction. Pass as previous_interaction_id for follow-ups.","uniqueKey":"interaction_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Interaction Id","description":"Identifier for this interaction. Pass as previous_interaction_id for follow-ups.","uniqueKey":"interaction_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"interaction_id","typeLabel":"string | null"}},"required":["id","choices","created","model","object","type"],"title":"ChatCompletionResponseChunk","type":"object","uniqueKey":"","typeLabel":"ChatCompletionResponseChunk · object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","choices":[{"delta":{"content":"\u003cstring>","function_call":{"arguments":"\u003cstring>","name":"\u003cstring>"},"refusal":"\u003cstring>","role":"developer","tool_calls":[{"index":123,"id":"\u003cstring>","function":{"arguments":"\u003cstring>","name":"\u003cstring>"},"type":"function"}]},"index":123,"finish_reason":"stop","logprobs":{"content":[{"token":"\u003cstring>","logprob":123,"top_logprobs":[{"token":"\u003cstring>","logprob":123,"bytes":[123]}],"bytes":[123]}],"refusal":[{"token":"\u003cstring>","logprob":123,"top_logprobs":[{"token":"\u003cstring>","logprob":123,"bytes":[123]}],"bytes":[123]}]}}],"created":123,"model":"\u003cstring>","object":"chat.completion.chunk","type":"chat.completion.chunk","moderation":{"input":{"categories":{},"category_applied_input_types":{},"category_scores":{},"flagged":true,"model":"\u003cstring>","type":"moderation_result"},"output":{"categories":{},"category_applied_input_types":{},"category_scores":{},"flagged":true,"model":"\u003cstring>","type":"moderation_result"}},"service_tier":"auto","system_fingerprint":"\u003cstring>","usage":{"completion_tokens":123,"prompt_tokens":123,"total_tokens":123,"completion_tokens_details":{"accepted_prediction_tokens":123,"audio_tokens":123,"reasoning_tokens":123,"rejected_prediction_tokens":123},"prompt_tokens_details":{"audio_tokens":123,"cached_tokens":123}},"basis":[],"interaction_id":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"9ce07d97-18ac-4ed5-a416-b4c026678ffd":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"oneOf":[{"type":"string","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.1","typeLabel":"integer"}],"uniqueKey":"detail.items.[INDEX].loc.items.[INDEX]","typeLabel":"string | integer"},"type":"array","title":"Location","isRequired":true,"uniqueKey":"detail.items.[INDEX].loc","typeLabel":"(string | integer)[]"},"msg":{"title":"Message","type":"string","isRequired":true,"uniqueKey":"detail.items.[INDEX].msg","typeLabel":"string"},"type":{"type":"string","title":"Error Type","isRequired":true,"uniqueKey":"detail.items.[INDEX].type","typeLabel":"string"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError","uniqueKey":"detail.items.[INDEX]","typeLabel":"ValidationError · object"},"type":"array","title":"Detail","uniqueKey":"detail","typeLabel":"ValidationError · object[]"}},"type":"object","title":"HTTPValidationError","uniqueKey":"","typeLabel":"HTTPValidationError · object"},"examples":{"Example":{"title":"Example","value":{"detail":[{"loc":["\u003cstring>"],"msg":"\u003cstring>","type":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"49a29ffa-8f37-47ed-a6b7-cbccaf1be4c3":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"9eb25184-f485-41e5-93a2-065601fe5a47":{"url":"https://api.parallel.ai","description":"Parallel API"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"x-api-key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"x-api-key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"docs-legacy-openapi.json"},"subdomain":"parallel-6fabab31-mtje7p526we","siteName":"Parallel","title":"Chat Completions - Parallel","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-22T01:00:29.989Z","originalFileLocation":"api-reference/legacy/chat-api-beta/chat-completions.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=\"light\"}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 completions. This endpoint can be used to get realtime chat completions. It can also be used with the Task API processors to get structured, research outputs via a chat interface.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Parallel\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"noindex\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/parallel-6fabab31-mtje7p526we/ZNRH8iM_vWv_wJYk/_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/parallel-6fabab31-mtje7p526we/ZNRH8iM_vWv_wJYk/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/parallel-6fabab31-mtje7p526we/ZNRH8iM_vWv_wJYk/_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/parallel-6fabab31-mtje7p526we/ZNRH8iM_vWv_wJYk/_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/parallel-6fabab31-mtje7p526we/ZNRH8iM_vWv_wJYk/_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/parallel-6fabab31-mtje7p526we/ZNRH8iM_vWv_wJYk/_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/parallel-6fabab31-mtje7p526we/ZNRH8iM_vWv_wJYk/_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/parallel-6fabab31-mtje7p526we/ZNRH8iM_vWv_wJYk/_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/parallel-6fabab31-mtje7p526we/ZNRH8iM_vWv_wJYk/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Chat Completions - Parallel\">\u003cmeta data-mint-head property=\"og:description\" content=\"Chat completions. This endpoint can be used to get realtime chat completions. It can also be used with the Task API processors to get structured, research outputs via a chat interface.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Parallel\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.parallel.ai/api-reference/legacy/chat-api-beta/chat-completions\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://parallel-6fabab31-mtje7p526we.mintlify.app/_mintlify/api/og/v2?division=Chat+API+%28Beta%29\u0026amp;title=Chat+Completions\u0026amp;description=Chat+completions.%0A%0AThis+endpoint+can+be+used+to+get+realtime+chat+completions.+It+can+also+be+used%0Awith+the+Task+API+processors+to+get+structured%2C+research+outp\u0026amp;theme=106af9efc399e2ef4c618350\u0026amp;signature=0654d94be3c423495508d620875ee149b3308494395d9d99a1ad93d2e9f65016\">\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=\"Chat Completions - Parallel\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Chat completions. This endpoint can be used to get realtime chat completions. It can also be used with the Task API processors to get structured, research outputs via a chat interface.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://parallel-6fabab31-mtje7p526we.mintlify.app/_mintlify/api/og/v2?division=Chat+API+%28Beta%29\u0026amp;title=Chat+Completions\u0026amp;description=Chat+completions.%0A%0AThis+endpoint+can+be+used+to+get+realtime+chat+completions.+It+can+also+be+used%0Awith+the+Task+API+processors+to+get+structured%2C+research+outp\u0026amp;theme=106af9efc399e2ef4c618350\u0026amp;signature=0654d94be3c423495508d620875ee149b3308494395d9d99a1ad93d2e9f65016\">\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/parallel-6fabab31-mtje7p526we/ZNRH8iM_vWv_wJYk/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Parallel\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FB631B\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.parallel.ai/api-reference/legacy/chat-api-beta/chat-completions\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/legacy/chat-api-beta/chat-completions.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.parallel.ai/#organization\",\"name\":\"Parallel\",\"url\":\"https://docs.parallel.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/parallel-6fabab31-mtje7p526we/ODrEI5O3l6nnvEZD/logo/wordmark_light.svg?fit=max\u0026auto=format\u0026n=ODrEI5O3l6nnvEZD\u0026q=85\u0026s=955d1146a212bea2279ca4ee6916b8ae\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.parallel.ai#website\",\"name\":\"Parallel\",\"url\":\"https://docs.parallel.ai\",\"publisher\":{\"@id\":\"https://docs.parallel.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.parallel.ai/api-reference/legacy/chat-api-beta/chat-completions#webpage\",\"url\":\"https://docs.parallel.ai/api-reference/legacy/chat-api-beta/chat-completions\",\"name\":\"Chat Completions\",\"description\":\"Chat completions. This endpoint can be used to get realtime chat completions. It can also be used with the Task API processors to get structured, research outputs via a chat interface.\",\"dateModified\":\"2026-10-22T01:00:29.989Z\",\"isPartOf\":{\"@id\":\"https://docs.parallel.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.parallel.ai/api-reference/legacy/chat-api-beta/chat-completions#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.parallel.ai/api-reference/legacy/chat-api-beta/chat-completions#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Parallel\",\"item\":\"https://docs.parallel.ai\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Chat Completions\",\"item\":\"https://docs.parallel.ai/api-reference/legacy/chat-api-beta/chat-completions\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.parallel.ai/api-reference/legacy/chat-api-beta/chat-completions#apireference\",\"headline\":\"Chat Completions\",\"name\":\"Chat Completions\",\"description\":\"Chat completions. This endpoint can be used to get realtime chat completions. It can also be used with the Task API processors to get structured, research outputs via a chat interface.\",\"url\":\"https://docs.parallel.ai/api-reference/legacy/chat-api-beta/chat-completions\",\"mainEntityOfPage\":{\"@id\":\"https://docs.parallel.ai/api-reference/legacy/chat-api-beta/chat-completions#webpage\"},\"dateModified\":\"2026-10-22T01:00:29.989Z\",\"publisher\":{\"@id\":\"https://docs.parallel.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.parallel.ai#website\"}}]}\u003c/script>","siteName":"Parallel","nav":{"global":{"anchors":[{"anchor":"Get API Key","icon":"key","href":"https://platform.parallel.ai"},{"anchor":"OpenAPI Spec","icon":"file-code","href":"https://docs.parallel.ai/public-openapi.json"},{"anchor":"Python SDK","icon":"python","href":"https://pypi.org/project/parallel-web/"},{"anchor":"TypeScript SDK","icon":"js","href":"https://www.npmjs.com/package/parallel-web"}]},"tabs":[{"tab":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":"/getting-started/overview"}]},{"tab":"API Reference","icon":"magnifying-glass","pages":[{"title":"API Reference","href":"/api-reference/search/search"}]},{"tab":"Account API","icon":"gear","pages":[{"title":"Account API","href":"/service-api/balance/get-balance"}]},{"tab":"API Reference (legacy)","icon":"magnifying-glass","hidden":true,"groups":[{"group":"Search (Beta)","pages":[{"title":"Search","description":"Searches the web.\n\nThis endpoint remains supported for existing integrations. For new integrations,\nuse the [V1 Search API reference](https://docs.parallel.ai/api-reference/search/search)\nand see the [migration guide](https://docs.parallel.ai/search/search-migration-guide).","deprecated":null,"version":null,"openapi":"/docs-legacy-openapi.json post /v1beta/search","href":"/api-reference/legacy/search-beta/search"}]},{"group":"Extract (Beta)","pages":[{"title":"Extract","description":"Extracts relevant content from specific web URLs.\n\nThis endpoint remains supported for existing integrations. For new integrations,\nuse the [V1 Extract API reference](https://docs.parallel.ai/api-reference/extract/extract)\nand see the [migration guide](https://docs.parallel.ai/extract/extract-migration-guide).","deprecated":null,"version":null,"openapi":"/docs-legacy-openapi.json post /v1beta/extract","href":"/api-reference/legacy/extract-beta/extract"}]},{"group":"Tasks","pages":[{"title":"Create Task Group","description":"Initiates a TaskGroup to group and track multiple runs.","deprecated":null,"version":null,"openapi":"/docs-legacy-openapi.json post /v1/tasks/groups","href":"/api-reference/legacy/tasks/create-task-group"},{"title":"Retrieve Task Group","description":"Retrieves aggregated status across runs in a TaskGroup.","deprecated":null,"version":null,"openapi":"/docs-legacy-openapi.json get /v1/tasks/groups/{taskgroup_id}","href":"/api-reference/legacy/tasks/retrieve-task-group"},{"title":"Stream Task Group Events","description":"Streams events from a TaskGroup: status updates and run completions.\n\nThe connection will remain open for up to an hour as long as at least one run in the\ngroup is still active.","deprecated":null,"version":null,"openapi":"/docs-legacy-openapi.json get /v1/tasks/groups/{taskgroup_id}/events","href":"/api-reference/legacy/tasks/stream-task-group-events"},{"title":"Fetch Task Group Runs","description":"Retrieves task runs in a TaskGroup and optionally their inputs and outputs.\n\nAll runs within a TaskGroup are returned as a stream. To get the inputs and/or\noutputs back in the stream, set the corresponding `include_input` and\n`include_output` parameters to `true`.\n\nThe stream is resumable using the `event_id` as the cursor. To resume a stream,\nspecify the `last_event_id` parameter with the `event_id` of the last event in the\nstream. The stream will resume from the next event after the `last_event_id`.","deprecated":null,"version":null,"openapi":"/docs-legacy-openapi.json get /v1/tasks/groups/{taskgroup_id}/runs","href":"/api-reference/legacy/tasks/fetch-task-group-runs"},{"title":"Add Runs to Task Group","description":"Initiates multiple task runs within a TaskGroup.","deprecated":null,"version":null,"openapi":"/docs-legacy-openapi.json post /v1/tasks/groups/{taskgroup_id}/runs","href":"/api-reference/legacy/tasks/add-runs-to-task-group"},{"title":"Retrieve Task Group Run","description":"Retrieves run status by run_id.\n\nThis endpoint is equivalent to fetching run status directly using the\n`retrieve()` method or the `tasks/runs` GET endpoint.\n\nThe run result is available from the `/result` endpoint.","deprecated":null,"version":null,"openapi":"/docs-legacy-openapi.json get /v1/tasks/groups/{taskgroup_id}/runs/{run_id}","href":"/api-reference/legacy/tasks/retrieve-task-group-run"},{"title":"Create Task Run","description":"Initiates a task run.\n\nReturns immediately with a run object in status 'queued'.\n\nBeta features can be enabled by setting the 'parallel-beta' header.","deprecated":null,"version":null,"openapi":"/docs-legacy-openapi.json post /v1/tasks/runs","href":"/api-reference/legacy/tasks/create-task-run"},{"title":"Retrieve Task Run","description":"Retrieves run status by run_id.\n\nThe run result is available from the `/result` endpoint.","deprecated":null,"version":null,"openapi":"/docs-legacy-openapi.json get /v1/tasks/runs/{run_id}","href":"/api-reference/legacy/tasks/retrieve-task-run"},{"title":"Stream Task Run Events","description":"Streams events for a task run.\n\nReturns a stream of events showing progress updates and state changes for the task\nrun.\n\nFor task runs that did not have enable_events set to true during creation, the\nfrequency of events will be reduced.","deprecated":null,"version":null,"openapi":"/docs-legacy-openapi.json get /v1/tasks/runs/{run_id}/events","href":"/api-reference/legacy/tasks/stream-task-run-events"},{"title":"Retrieve Task Run Input","description":"Retrieves the input of a run by run_id.","deprecated":null,"version":null,"openapi":"/docs-legacy-openapi.json get /v1/tasks/runs/{run_id}/input","href":"/api-reference/legacy/tasks/retrieve-task-run-input"},{"title":"Retrieve Task Run Result","description":"Retrieves a run result by run_id, blocking until the run is completed.","deprecated":null,"version":null,"openapi":"/docs-legacy-openapi.json get /v1/tasks/runs/{run_id}/result","href":"/api-reference/legacy/tasks/retrieve-task-run-result"}]},{"group":"FindAll","pages":[{"title":"Generate FindAll Candidates","description":"Deprecated alias for ``/v1beta/findall/entity-search``.","deprecated":null,"version":null,"openapi":"/docs-legacy-openapi.json post /v1beta/findall/candidates","href":"/api-reference/legacy/findall/generate-findall-candidates"},{"title":"Fast Entity Search","description":"Return ranked entities matching a natural language objective.\n\nThis endpoint performs a best-effort search optimized for low latency. To keep\nresponses fast, it returns a fixed set of attributes and supports queries of\nlimited complexity.\n\nFor comprehensive match evaluation and enrichment, use the\n[FindAll API](https://docs.parallel.ai/findall-api/findall-quickstart).","deprecated":null,"version":null,"openapi":"/docs-legacy-openapi.json post /v1beta/findall/entity-search","href":"/api-reference/legacy/findall/fast-entity-search"},{"title":"Ingest FindAll Run","description":"Transforms a natural language search objective into a structured FindAll spec.\n\nThe generated specification serves as a suggested starting point and can be further\ncustomized by the user.","deprecated":null,"version":null,"openapi":"/docs-legacy-openapi.json post /v1beta/findall/ingest","href":"/api-reference/legacy/findall/ingest-findall-run"},{"title":"Create FindAll Run","description":"Starts a FindAll run.\n\nThis endpoint immediately returns a FindAll run object with status set to 'queued'.\nYou can get the run result snapshot using the GET /v1beta/findall/runs/{findall_id}/result endpoint.\nYou can track the progress of the run by:\n- Polling the status using the GET /v1beta/findall/runs/{findall_id} endpoint,\n- Subscribing to real-time updates via the /v1beta/findall/runs/{findall_id}/events\nendpoint,\n- Or specifying a webhook with relevant event types during run creation to receive\nnotifications.","deprecated":null,"version":null,"openapi":"/docs-legacy-openapi.json post /v1beta/findall/runs","href":"/api-reference/legacy/findall/create-findall-run"},{"title":"Retrieve FindAll Run Status","description":"Retrieve a FindAll run.","deprecated":null,"version":null,"openapi":"/docs-legacy-openapi.json get /v1beta/findall/runs/{findall_id}","href":"/api-reference/legacy/findall/retrieve-findall-run-status"},{"title":"Cancel FindAll Run","description":"Cancel a FindAll run.","deprecated":null,"version":null,"openapi":"/docs-legacy-openapi.json post /v1beta/findall/runs/{findall_id}/cancel","href":"/api-reference/legacy/findall/cancel-findall-run"},{"title":"Add Enrichment to FindAll Run","description":"Add an enrichment to a FindAll run.","deprecated":null,"version":null,"openapi":"/docs-legacy-openapi.json post /v1beta/findall/runs/{findall_id}/enrich","href":"/api-reference/legacy/findall/add-enrichment-to-findall-run"},{"title":"Stream FindAll Events","description":"Stream events from a FindAll run.\n\nArgs:\n request: The Shapi request\n findall_id: The FindAll run ID\n last_event_id: Optional event ID to resume from.\n timeout: Optional timeout in seconds. If None, keep connection alive\n as long as the run is going. If set, stop after specified duration.","deprecated":null,"version":null,"openapi":"/docs-legacy-openapi.json get /v1beta/findall/runs/{findall_id}/events","href":"/api-reference/legacy/findall/stream-findall-events"},{"title":"Extend FindAll Run","description":"Extend a FindAll run by adding additional matches to the current match limit.","deprecated":null,"version":null,"openapi":"/docs-legacy-openapi.json post /v1beta/findall/runs/{findall_id}/extend","href":"/api-reference/legacy/findall/extend-findall-run"},{"title":"FindAll Run Result","description":"Retrieve the FindAll run result at the time of the request.","deprecated":null,"version":null,"openapi":"/docs-legacy-openapi.json get /v1beta/findall/runs/{findall_id}/result","href":"/api-reference/legacy/findall/findall-run-result"},{"title":"Get FindAll Run Schema","description":null,"deprecated":null,"version":null,"openapi":"/docs-legacy-openapi.json get /v1beta/findall/runs/{findall_id}/schema","href":"/api-reference/legacy/findall/get-findall-run-schema"}]},{"group":"Monitor (Alpha)","pages":[{"title":"List Monitors","description":"List active monitors.\n\nReturns all monitors for the user, regardless of status. Each list item\ncontains the monitor configuration and current status.\n\nSupports pagination using `monitor_id` as a cursor and `limit` to control\nthe number of results returned.","deprecated":null,"version":null,"openapi":"/docs-legacy-openapi.json get /v1alpha/monitors","href":"/api-reference/legacy/monitor-alpha/list-monitors"},{"title":"Create Monitor","description":"Create a web monitor.\n\nCreates a monitor that periodically runs the specified query over the web at the\nspecified cadence (hourly, daily, weekly, or every two weeks). The monitor runs once at\ncreation and then continues according to the specified frequency.\n\nUpdates will be sent to the webhook if provided. Use the `executions` endpoint\nto retrieve execution history for a monitor.","deprecated":null,"version":null,"openapi":"/docs-legacy-openapi.json post /v1alpha/monitors","href":"/api-reference/legacy/monitor-alpha/create-monitor"},{"title":"List Monitors","description":"List active monitors ordered by creation time, newest first.\n\nReturns active monitors for the authenticated client, sorted by `created_at`\ndescending. `limit` defaults to 100. Use `next_cursor` from the response\nand pass it as `cursor` to fetch the next page. Pagination ends when\n`next_cursor` is absent.","deprecated":null,"version":null,"openapi":"/docs-legacy-openapi.json get /v1alpha/monitors/list","href":"/api-reference/legacy/monitor-alpha/list-monitors-1"},{"title":"Retrieve Monitor","description":"Retrieve a monitor.\n\nRetrieves a specific monitor by `monitor_id`. Returns the monitor\nconfiguration including status, cadence, input, and webhook settings.","deprecated":null,"version":null,"openapi":"/docs-legacy-openapi.json get /v1alpha/monitors/{monitor_id}","href":"/api-reference/legacy/monitor-alpha/retrieve-monitor"},{"title":"Update Monitor","description":"Update a monitor.\n\nAt least one field must be non-null to apply an update.","deprecated":null,"version":null,"openapi":"/docs-legacy-openapi.json post /v1alpha/monitors/{monitor_id}","href":"/api-reference/legacy/monitor-alpha/update-monitor"},{"title":"Delete Monitor","description":"Delete a monitor.\n\nDeletes a monitor, stopping all future executions. Deleted monitors can no\nlonger be updated or retrieved.","deprecated":null,"version":null,"openapi":"/docs-legacy-openapi.json delete /v1alpha/monitors/{monitor_id}","href":"/api-reference/legacy/monitor-alpha/delete-monitor"},{"title":"Retrieve Event Group","description":"Retrieve an event group for a monitor.\n\nEach list item in the response will have type `event`.","deprecated":null,"version":null,"openapi":"/docs-legacy-openapi.json get /v1alpha/monitors/{monitor_id}/event_groups/{event_group_id}","href":"/api-reference/legacy/monitor-alpha/retrieve-event-group"},{"title":"List Events","description":"List events for a monitor from up to the last 300 event groups.\n\nRetrieves events from the monitor, including events with errors and\nmaterial changes. The endpoint checks up to the specified lookback period or the\nprevious 300 event groups, whichever is less.\n\nEvents will be returned in reverse chronological order, with the most recent event groups\nfirst. All events from an event group will be flattened out into individual entries\nin the list.","deprecated":null,"version":null,"openapi":"/docs-legacy-openapi.json get /v1alpha/monitors/{monitor_id}/events","href":"/api-reference/legacy/monitor-alpha/list-events"},{"title":"Simulate Event","description":"Simulate sending an event for a monitor.\n\nSimulates sending an event for the specified event_type.\nDefaults to `monitor.event.detected` if not specified.","deprecated":null,"version":null,"openapi":"/docs-legacy-openapi.json post /v1alpha/monitors/{monitor_id}/simulate_event","href":"/api-reference/legacy/monitor-alpha/simulate-event"}]},{"group":"Memory","pages":[{"title":"Clear Memory","description":"Clears all entries from the selected memory without deleting the underlying tasks, monitors, or FindAll runs.","deprecated":null,"version":null,"openapi":"/docs-legacy-openapi.json post /v1beta/memory/clear","href":"/api-reference/legacy/memory/clear-memory"},{"title":"Evict from Memory","description":"Removes a task run, monitor, or FindAll run from the selected memory without deleting the original resource.","deprecated":null,"version":null,"openapi":"/docs-legacy-openapi.json post /v1beta/memory/evict","href":"/api-reference/legacy/memory/evict-from-memory"},{"title":"Retrieve Memory","description":"Retrieves relevant or recent runs from the selected memory. Provide a query to rank results by relevance; leave it empty to return the most recent runs.","deprecated":null,"version":null,"openapi":"/docs-legacy-openapi.json post /v1beta/memory/retrieve","href":"/api-reference/legacy/memory/retrieve-memory"}]},{"group":"Chat API (Beta)","pages":[{"title":"Chat Completions","deprecated":null,"version":null,"openapi":"/docs-legacy-openapi.json post /v1beta/chat/completions","href":"/api-reference/legacy/chat-api-beta/chat-completions"}]},{"group":"Responses API","pages":[{"title":"Create Response","description":"Create a response.\n\nGenerates an answer to the given input, grounded in live web research and\nannotated with URL citations. Set `model` to `parallel`; `reasoning.effort`\n(`low`/`medium`/`high`/`auto`) controls how much research is performed, trading\nresponse time for answer quality. Returns an OpenAI-format `Response` as\n`application/json`, or a `text/event-stream` of OpenAI Responses SSE\nevents when `stream=true`.","deprecated":null,"version":null,"openapi":"/docs-legacy-openapi.json post /v1/responses","href":"/api-reference/legacy/responses-api/create-response"}]},{"group":"Tasks (Beta)","pages":[{"title":"Create Task Group","description":"Initiates a TaskGroup to group and track multiple runs.","deprecated":null,"version":null,"openapi":"/docs-legacy-openapi.json post /v1beta/tasks/groups","href":"/api-reference/legacy/tasks-beta/create-task-group"},{"title":"Retrieve Task Group","description":"Retrieves aggregated status across runs in a TaskGroup.","deprecated":null,"version":null,"openapi":"/docs-legacy-openapi.json get /v1beta/tasks/groups/{taskgroup_id}","href":"/api-reference/legacy/tasks-beta/retrieve-task-group"},{"title":"Stream Task Group Events","description":"Streams events from a TaskGroup: status updates and run completions.\n\nThe connection will remain open for up to an hour as long as at least one run in the\ngroup is still active.","deprecated":null,"version":null,"openapi":"/docs-legacy-openapi.json get /v1beta/tasks/groups/{taskgroup_id}/events","href":"/api-reference/legacy/tasks-beta/stream-task-group-events"},{"title":"Fetch Task Group Runs","description":"Retrieves task runs in a TaskGroup and optionally their inputs and outputs.\n\nAll runs within a TaskGroup are returned as a stream. To get the inputs and/or\noutputs back in the stream, set the corresponding `include_input` and\n`include_output` parameters to `true`.\n\nThe stream is resumable using the `event_id` as the cursor. To resume a stream,\nspecify the `last_event_id` parameter with the `event_id` of the last event in the\nstream. The stream will resume from the next event after the `last_event_id`.","deprecated":null,"version":null,"openapi":"/docs-legacy-openapi.json get /v1beta/tasks/groups/{taskgroup_id}/runs","href":"/api-reference/legacy/tasks-beta/fetch-task-group-runs"},{"title":"Add Runs to Task Group","description":"Initiates multiple task runs within a TaskGroup.","deprecated":null,"version":null,"openapi":"/docs-legacy-openapi.json post /v1beta/tasks/groups/{taskgroup_id}/runs","href":"/api-reference/legacy/tasks-beta/add-runs-to-task-group"},{"title":"Retrieve Task Group Run","description":"Retrieves run status by run_id.\n\nThis endpoint is equivalent to fetching run status directly using the\n`retrieve()` method or the `tasks/runs` GET endpoint.\n\nThe run result is available from the `/result` endpoint.","deprecated":null,"version":null,"openapi":"/docs-legacy-openapi.json get /v1beta/tasks/groups/{taskgroup_id}/runs/{run_id}","href":"/api-reference/legacy/tasks-beta/retrieve-task-group-run"}]}]},{"tab":"Changelog","icon":"clock","pages":[{"title":"Changelog","href":"/resources/changelog"}]}]},"basePath":"","title":"Chat Completions - Parallel","buildId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","deploymentId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DX1Meug0.js","utils-B_OMIQVC.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-ChxhRPMa.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CuKvD8Iv.js","snippetPresets-C5d7p2hp.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CfHcE8m4.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C1zZV314.js","shallow-CmQhqCJn.js","getApiPlaygroundDisplay-YRo9s1O7.js","CodeSnippet-RN1MTdfk.js","CodeSnippets-DKLPHxJA.js","Page-BAvA99GL.js","getPastedJson-bz0M41mU.js","icon-CsmhpPrv.js","MethodPill-CNGsVE77.js","DuplicateIcon-DilfU_Z2.js","createIcon-BdsYzQck.js","DynamicMarkdown-CbqEDjbV.js","SectionHeading-O6hXpFCN.js","axios-vUo_bRtp.js","Markdown-nKm-uidQ.js","clsx-ClVdStUn.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CIQkMg3R.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-ImrFS4Fy.js"]}