Generate a chat completion from a prompt using one model in your project.
Your prompt messages can include several roles.
This endpoints supports streaming
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Adaptive ML Documentation","colors":{"primary":"#275AF1","light":"#80a0fe","dark":"#275AF1"},"logo":{"light":"https://mintcdn.com/adaptiveml/nxrXfjE5HXjTB4Su/logo/new_adaptive_logo.png?fit=max\u0026auto=format\u0026n=nxrXfjE5HXjTB4Su\u0026q=85\u0026s=533f3281b841f120ead3f47eeea805b3","dark":"https://mintcdn.com/adaptiveml/nxrXfjE5HXjTB4Su/logo/new_adaptive_logo_white.png?fit=max\u0026auto=format\u0026n=nxrXfjE5HXjTB4Su\u0026q=85\u0026s=e22d3354dfdbdfd4e092e3ada58c6c75"},"favicon":"https://mintcdn.com/adaptiveml/vkPwKLK0frhpPFY8/logo/purple_fav.svg?fit=max\u0026auto=format\u0026n=vkPwKLK0frhpPFY8\u0026q=85\u0026s=102965f15a992970771bf3b16a08ccf2","navbar":{"primary":{"type":"button","label":"Contact Us","href":"https://www.adaptive-ml.com/"}},"footer":{"socials":{"x":"https://twitter.com/AdaptiveML","linkedin":"https://www.linkedin.com/company/adaptive-ml"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"adaptiveml","hasAudioNarration":false,"actualSubdomain":"adaptiveml","customDomains":["docs.adaptive-ml.com"],"gitSource":{"type":"github","owner":"adaptive-ml","repo":"adaptonomicon","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21e65633a4518725aab6dc","collectionId":"b7dacaa6-345e-4648-a28b-558d6a3a3648","schemaVersion":"v2"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae922285bfa35cf904498af:success","clientVersion":"0.0.4071","searchFilterCounts":[{"language":"default","tag":"Harmony","count":52},{"language":"default","tag":"Adaptive Engine","count":38},{"language":"default","tag":"Core","count":17},{"language":"default","tag":"Building Blocks","count":16},{"language":"default","tag":"Advanced","count":12},{"language":"default","tag":"Training \u0026 Evaluation","count":12},{"language":"default","tag":"Cookbook","count":12},{"language":"default","tag":"Getting Started","count":10},{"language":"default","tag":"Custom graders","count":8},{"language":"default","tag":"Deploy","count":5}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"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},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","content":".walkthrough-iframe{width:100%!important;border:none!important;background:transparent!important;aspect-ratio:5/4!important}@media (max-width: 600px){.walkthrough-iframe{aspect-ratio:1/1!important}}"}],"page":{"pagePath":"api-reference/completions/post-apiv1chatcompletions","slug":"/api-reference/completions/post-apiv1chatcompletions","pageMetadata":{"openapi":"POST /api/v1/chat/completions","title":"Generate chat completion","description":"Generate a chat completion from a prompt using one model in your project.\nYour prompt messages can include several roles.\nThis endpoints supports streaming","href":"/api-reference/completions/post-apiv1chatcompletions"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Generate a chat completion from a prompt using one model in your project.\\nYour prompt messages can include several roles.\\nThis endpoints supports streaming\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"POST /api/v1/chat/completions","title":"Generate chat completion","description":"Generate a chat completion from a prompt using one model in your project.\nYour prompt messages can include several roles.\nThis endpoints supports streaming","href":"/api-reference/completions/post-apiv1chatcompletions"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Completions"],"summary":"Generate chat completion","description":"Generate a chat completion from a prompt using one model in your project.\nYour prompt messages can include several roles.\nThis endpoints supports streaming","operationId":"Chat","requestBody":"5d5f951e-e0a0-4811-b1d7-f78cdb1d5b02","responses":{"200":"635d96a5-6e64-4c78-93e0-2d85cb0296e2"},"method":"post","type":"path","servers":[],"security":[],"path":"/api/v1/chat/completions","baseUrlOptions":[],"title":"Generate chat completion","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["messages","model"],"properties":{"messages":{"type":"array","items":{"type":"object","required":["content","role"],"properties":{"content":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"messages.items.[INDEX].content.oneOf.0","typeLabel":"string"},{"type":"array","items":{"oneOf":[{"type":"object","required":["text","type"],"properties":{"text":{"type":"string","isRequired":true,"uniqueKey":"messages.items.[INDEX].content.oneOf.1.items.[INDEX].oneOf.0.text","typeLabel":"string"},"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"messages.items.[INDEX].content.oneOf.1.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"messages.items.[INDEX].content.oneOf.1.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["image_url","type"],"properties":{"image_url":{"type":"string","isRequired":true,"uniqueKey":"messages.items.[INDEX].content.oneOf.1.items.[INDEX].oneOf.1.image_url","typeLabel":"string"},"type":{"type":"string","enum":["image_url"],"isRequired":true,"uniqueKey":"messages.items.[INDEX].content.oneOf.1.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"messages.items.[INDEX].content.oneOf.1.items.[INDEX].oneOf.1","typeLabel":"object"}],"uniqueKey":"messages.items.[INDEX].content.oneOf.1.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"messages.items.[INDEX].content.oneOf.1","typeLabel":"object[]"}],"isRequired":true,"uniqueKey":"messages.items.[INDEX].content","typeLabel":"string | object[]"},"role":{"type":"string","isRequired":true,"uniqueKey":"messages.items.[INDEX].role","typeLabel":"string"},"name":{"oneOf":[{"type":"string","uniqueKey":"messages.items.[INDEX].name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"messages.items.[INDEX].name.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].name","typeLabel":"string | null"},"completion_id":{"oneOf":[{"type":"string","format":"uuid","uniqueKey":"messages.items.[INDEX].completion_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","uniqueKey":"messages.items.[INDEX].completion_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].completion_id","typeLabel":"string\u003cuuid> | null"},"metadata":{"oneOf":[{}],"uniqueKey":"messages.items.[INDEX].metadata","typeLabel":"any"}},"uniqueKey":"messages.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"messages","typeLabel":"object[]"},"model":{"type":"string","description":"can be of the form `{project}/{model}` or `{project}`. In the latter it will use the default model","isRequired":true,"uniqueKey":"model","typeLabel":"string"},"stop":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"stop.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"stop.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"uniqueKey":"stop.oneOf.1","typeLabel":"null"}],"uniqueKey":"stop","typeLabel":"string[] | null"},"max_tokens":{"oneOf":[{"type":"integer","format":"int32","minimum":0,"uniqueKey":"max_tokens.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","minimum":0,"uniqueKey":"max_tokens.oneOf.1","typeLabel":"null"}],"uniqueKey":"max_tokens","typeLabel":"integer\u003cint32> | null"},"temperature":{"oneOf":[{"type":"number","format":"float","uniqueKey":"temperature.oneOf.0","typeLabel":"number\u003cfloat>"},{"type":"null","format":"float","uniqueKey":"temperature.oneOf.1","typeLabel":"null"}],"uniqueKey":"temperature","typeLabel":"number\u003cfloat> | null"},"top_p":{"oneOf":[{"type":"number","format":"float","uniqueKey":"top_p.oneOf.0","typeLabel":"number\u003cfloat>"},{"type":"null","format":"float","uniqueKey":"top_p.oneOf.1","typeLabel":"null"}],"uniqueKey":"top_p","typeLabel":"number\u003cfloat> | null"},"max_ttft_ms":{"oneOf":[{"type":"integer","format":"int64","minimum":0,"uniqueKey":"max_ttft_ms.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","minimum":0,"uniqueKey":"max_ttft_ms.oneOf.1","typeLabel":"null"}],"uniqueKey":"max_ttft_ms","typeLabel":"integer\u003cint64> | null"},"stream":{"type":"boolean","uniqueKey":"stream","typeLabel":"boolean"},"stream_options":{"oneOf":[{"type":"null","uniqueKey":"stream_options.oneOf.0","typeLabel":"null"},{"type":"object","properties":{"include_usage":{"type":"boolean","uniqueKey":"stream_options.oneOf.1.include_usage","typeLabel":"boolean"}},"uniqueKey":"stream_options.oneOf.1","typeLabel":"object"}],"uniqueKey":"stream_options","typeLabel":"null | object"},"session_id":{"oneOf":[{"type":"string","format":"uuid","uniqueKey":"session_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","uniqueKey":"session_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"session_id","typeLabel":"string\u003cuuid> | null"},"user":{"oneOf":[{"type":"string","format":"uuid","uniqueKey":"user.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","uniqueKey":"user.oneOf.1","typeLabel":"null"}],"uniqueKey":"user","typeLabel":"string\u003cuuid> | null"},"ab_campaign":{"oneOf":[{"type":"null","uniqueKey":"ab_campaign.oneOf.0","typeLabel":"null"},{"type":"string","description":"id or key of the entity","example":"76d1fab3-214c-47ef-bb04-16270639bf89","uniqueKey":"ab_campaign.oneOf.1","typeLabel":"string"}],"uniqueKey":"ab_campaign","typeLabel":"null | string"},"n":{"type":"integer","format":"int32","minimum":0,"uniqueKey":"n","typeLabel":"integer\u003cint32>"},"labels":{"oneOf":[{"type":"null","uniqueKey":"labels.oneOf.0","typeLabel":"null"},{"type":"object","description":"dictionnary with key and values as string","example":{"key":"value"},"additionalProperties":{"type":"string","uniqueKey":"labels.oneOf.1.additionalProperties","typeLabel":"string"},"uniqueKey":"labels.oneOf.1","typeLabel":"object"}],"uniqueKey":"labels","typeLabel":"null | object"},"metadata":{"oneOf":[{"type":"null","uniqueKey":"metadata.oneOf.0","typeLabel":"null"},{"type":"object","description":"alias for labels","example":{"key":"value"},"additionalProperties":{"type":"string","uniqueKey":"metadata.oneOf.1.additionalProperties","typeLabel":"string"},"uniqueKey":"metadata.oneOf.1","typeLabel":"object"}],"uniqueKey":"metadata","typeLabel":"null | object"},"system_prompt_args":{"oneOf":[{"type":"object","description":"Will be used to render system prompt template","additionalProperties":{"oneOf":[{}],"uniqueKey":"system_prompt_args.oneOf.0.additionalProperties","typeLabel":"any"},"propertyNames":{"type":"string"},"uniqueKey":"system_prompt_args.oneOf.0","typeLabel":"object"},{"type":"null","description":"Will be used to render system prompt template","additionalProperties":{"oneOf":[{}],"uniqueKey":"system_prompt_args.oneOf.1.additionalProperties","typeLabel":"any"},"propertyNames":{"type":"string"},"uniqueKey":"system_prompt_args.oneOf.1","typeLabel":"null"}],"uniqueKey":"system_prompt_args","typeLabel":"object | null"},"tags":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"tags.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"tags.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"uniqueKey":"tags.oneOf.1","typeLabel":"null"}],"uniqueKey":"tags","typeLabel":"string[] | null"},"use_tools":{"type":"boolean","uniqueKey":"use_tools","typeLabel":"boolean"},"tools":{"oneOf":[{"type":"array","items":{"type":"object","required":["id","enabled"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"tools.oneOf.0.items.[INDEX].id","typeLabel":"string"},"enabled":{"type":"boolean","isRequired":true,"uniqueKey":"tools.oneOf.0.items.[INDEX].enabled","typeLabel":"boolean"}},"uniqueKey":"tools.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Override tool configuration for this request - enables/disables specific tools","uniqueKey":"tools.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","required":["id","enabled"],"properties":{"id":{"type":"string"},"enabled":{"type":"boolean"}}},"description":"Override tool configuration for this request - enables/disables specific tools","uniqueKey":"tools.oneOf.1","typeLabel":"null"}],"uniqueKey":"tools","typeLabel":"object[] | null"},"store":{"oneOf":[{"type":"boolean","uniqueKey":"store.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"store.oneOf.1","typeLabel":"null"}],"uniqueKey":"store","typeLabel":"boolean | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"messages":[{"content":"\u003cstring>","role":"\u003cstring>","name":"\u003cstring>","completion_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","metadata":"\u003cunknown>"}],"model":"\u003cstring>","stop":["\u003cstring>"],"max_tokens":1,"temperature":123,"top_p":123,"max_ttft_ms":1,"stream":true,"stream_options":{"include_usage":true},"session_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","user":"3c90c3cc-0d44-4b50-8888-8dd25736052a","ab_campaign":"76d1fab3-214c-47ef-bb04-16270639bf89","n":1,"labels":{"key":"value"},"metadata":{"key":"value"},"system_prompt_args":{},"tags":["\u003cstring>"],"use_tools":true,"tools":[{"id":"\u003cstring>","enabled":true}],"store":true}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"635d96a5-6e64-4c78-93e0-2d85cb0296e2":{"description":"a stream will be returned if `streaming = true` in the request","content":{"application/json":{"schema":{"type":"object","required":["id","created","choices","session_id","usage"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"created":{"type":"number","description":"Unix Timestamp in seconds","examples":["1720712536"],"isRequired":true,"uniqueKey":"created","typeLabel":"number"},"choices":{"type":"array","items":{"type":"object","required":["index","message","completion_id","model"],"properties":{"index":{"type":"integer","format":"int32","minimum":0,"isRequired":true,"uniqueKey":"choices.items.[INDEX].index","typeLabel":"integer\u003cint32>"},"message":{"type":"object","required":["id","role","content"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"choices.items.[INDEX].message.id","typeLabel":"string"},"role":{"type":"string","isRequired":true,"uniqueKey":"choices.items.[INDEX].message.role","typeLabel":"string"},"content":{"type":"string","isRequired":true,"uniqueKey":"choices.items.[INDEX].message.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"choices.items.[INDEX].message","typeLabel":"object"},"completion_id":{"type":"string","isRequired":true,"uniqueKey":"choices.items.[INDEX].completion_id","typeLabel":"string"},"model":{"type":"string","isRequired":true,"uniqueKey":"choices.items.[INDEX].model","typeLabel":"string"},"finish_reason":{"oneOf":[{"type":"string","uniqueKey":"choices.items.[INDEX].finish_reason.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"choices.items.[INDEX].finish_reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"choices.items.[INDEX].finish_reason","typeLabel":"string | null"}},"uniqueKey":"choices.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"choices","typeLabel":"object[]"},"session_id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"session_id","typeLabel":"string\u003cuuid>"},"usage":{"type":"object","required":["completion_tokens","prompt_tokens","total_tokens"],"properties":{"completion_tokens":{"type":"integer","format":"int32","minimum":0,"isRequired":true,"uniqueKey":"usage.completion_tokens","typeLabel":"integer\u003cint32>"},"prompt_tokens":{"type":"integer","format":"int32","minimum":0,"isRequired":true,"uniqueKey":"usage.prompt_tokens","typeLabel":"integer\u003cint32>"},"total_tokens":{"type":"integer","format":"int32","minimum":0,"isRequired":true,"uniqueKey":"usage.total_tokens","typeLabel":"integer\u003cint32>"}},"isRequired":true,"uniqueKey":"usage","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","created":"1720712536","choices":[{"index":1,"message":{"id":"\u003cstring>","role":"\u003cstring>","content":"\u003cstring>"},"completion_id":"\u003cstring>","model":"\u003cstring>","finish_reason":"\u003cstring>"}],"session_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","usage":{"completion_tokens":1,"prompt_tokens":1,"total_tokens":1}}}},"exampleType":"generated"},"text/event-stream":{"schema":{"type":"object","required":["id","choices","created","session_id"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"choices":{"type":"array","items":{"type":"object","required":["delta","index","completion_id"],"properties":{"delta":{"type":"object","required":["id","role","content"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"choices.items.[INDEX].delta.id","typeLabel":"string"},"role":{"type":"string","isRequired":true,"uniqueKey":"choices.items.[INDEX].delta.role","typeLabel":"string"},"content":{"type":"string","isRequired":true,"uniqueKey":"choices.items.[INDEX].delta.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"choices.items.[INDEX].delta","typeLabel":"object"},"index":{"type":"integer","format":"int32","minimum":0,"isRequired":true,"uniqueKey":"choices.items.[INDEX].index","typeLabel":"integer\u003cint32>"},"completion_id":{"type":"string","isRequired":true,"uniqueKey":"choices.items.[INDEX].completion_id","typeLabel":"string"},"finish_reason":{"oneOf":[{"type":"string","uniqueKey":"choices.items.[INDEX].finish_reason.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"choices.items.[INDEX].finish_reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"choices.items.[INDEX].finish_reason","typeLabel":"string | null"}},"uniqueKey":"choices.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"choices","typeLabel":"object[]"},"created":{"type":"number","description":"Unix Timestamp in seconds","examples":["1720712536"],"isRequired":true,"uniqueKey":"created","typeLabel":"number"},"session_id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"session_id","typeLabel":"string\u003cuuid>"},"usage":{"oneOf":[{"type":"null","uniqueKey":"usage.oneOf.0","typeLabel":"null"},{"type":"object","required":["completion_tokens","prompt_tokens","total_tokens"],"properties":{"completion_tokens":{"type":"integer","format":"int32","minimum":0,"isRequired":true,"uniqueKey":"usage.oneOf.1.completion_tokens","typeLabel":"integer\u003cint32>"},"prompt_tokens":{"type":"integer","format":"int32","minimum":0,"isRequired":true,"uniqueKey":"usage.oneOf.1.prompt_tokens","typeLabel":"integer\u003cint32>"},"total_tokens":{"type":"integer","format":"int32","minimum":0,"isRequired":true,"uniqueKey":"usage.oneOf.1.total_tokens","typeLabel":"integer\u003cint32>"}},"uniqueKey":"usage.oneOf.1","typeLabel":"object"}],"uniqueKey":"usage","typeLabel":"null | object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","choices":[{"delta":{"id":"\u003cstring>","role":"\u003cstring>","content":"\u003cstring>"},"index":1,"completion_id":"\u003cstring>","finish_reason":"\u003cstring>"}],"created":"1720712536","session_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","usage":{"completion_tokens":1,"prompt_tokens":1,"total_tokens":1}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{},"servers":{}},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"adaptiveml","siteName":"Adaptive ML Documentation","title":"Generate chat completion - Adaptive ML Documentation","navMaps":{"firstHrefInVersion":{"v0.14":{"href":"/api-reference/completions/post-apiv1chatcompletions","matchLevel":0},"v0.13":{"href":"/v0.13/introduction","matchLevel":4},"v0.12":{"href":"/v0.12/introduction","matchLevel":4},"v0.11":{"href":"/v0.11/introduction","matchLevel":4},"v0.10":{"href":"/release-notes","matchLevel":4},"v0.8":{"href":"/release-notes","matchLevel":4},"v0.7":{"href":"/release-notes","matchLevel":4},"v0.6":{"href":"/release-notes","matchLevel":4},"v0.5":{"href":"/release-notes","matchLevel":4}},"firstHrefInLanguage":{}},"lastModified":"2026-03-09T21:15:38.759Z","originalFileLocation":"api-reference/completions/post-apiv1chatcompletions.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Generate a chat completion from a prompt using one model in your project. Your prompt messages can include several roles. This endpoints supports streaming\">\u003cmeta data-mint-head name=\"application-name\" content=\"Adaptive ML Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/adaptiveml/TKzRz13HIqHOqpDr/_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/adaptiveml/TKzRz13HIqHOqpDr/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/adaptiveml/TKzRz13HIqHOqpDr/_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/adaptiveml/TKzRz13HIqHOqpDr/_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/adaptiveml/TKzRz13HIqHOqpDr/_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/adaptiveml/TKzRz13HIqHOqpDr/_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/adaptiveml/TKzRz13HIqHOqpDr/_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/adaptiveml/TKzRz13HIqHOqpDr/_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/adaptiveml/TKzRz13HIqHOqpDr/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Generate chat completion - Adaptive ML Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Generate a chat completion from a prompt using one model in your project. Your prompt messages can include several roles. This endpoints supports streaming\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Adaptive ML Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.adaptive-ml.com/api-reference/completions/post-apiv1chatcompletions\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://adaptiveml.mintlify.app/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Generate+chat+completion\u0026amp;description=Generate+a+chat+completion+from+a+prompt+using+one+model+in+your+project.%0AYour+prompt+messages+can+include+several+roles.%0AThis+endpoints+supports+streaming\u0026amp;theme=e2be52ca69cd8e6c4f326c14\u0026amp;signature=b1c10b0363ade814ea6aec97c474c6c863f57a0fb9b28ab69bd6a463507bd81e\">\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=\"Generate chat completion - Adaptive ML Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Generate a chat completion from a prompt using one model in your project. Your prompt messages can include several roles. This endpoints supports streaming\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://adaptiveml.mintlify.app/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Generate+chat+completion\u0026amp;description=Generate+a+chat+completion+from+a+prompt+using+one+model+in+your+project.%0AYour+prompt+messages+can+include+several+roles.%0AThis+endpoints+supports+streaming\u0026amp;theme=e2be52ca69cd8e6c4f326c14\u0026amp;signature=b1c10b0363ade814ea6aec97c474c6c863f57a0fb9b28ab69bd6a463507bd81e\">\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/adaptiveml/TKzRz13HIqHOqpDr/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Adaptive ML Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#275AF1\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.adaptive-ml.com/api-reference/completions/post-apiv1chatcompletions\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/completions/post-apiv1chatcompletions.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Adaptive ML Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Adaptive ML Documentation","nav":{"global":null,"versions":[{"version":"v0.14","default":true,"tabs":[{"tab":"Adaptive Engine","groups":[{"group":"Start","icon":"arrow-down-right","pages":[{"title":"Introduction","href":"/v0.14/introduction"},{"title":"Quickstart","href":"/v0.14/quickstart"}]},{"group":"Core","icon":"book-open","pages":[{"title":"Projects","href":"/v0.14/core/projects"},{"title":"Models","href":"/v0.14/core/models"},{"title":"Inference","href":"/v0.14/core/inference"},{"title":"Datasets","href":"/v0.14/core/datasets"},{"title":"Recipes","href":"/v0.14/core/recipes"},{"title":"Monitoring","href":"/v0.14/core/monitoring"},{"title":"Interactions","href":"/v0.14/core/interactions"},{"title":"Metrics","href":"/v0.14/core/metrics"},{"title":"Graders","href":"/v0.14/core/graders"}]},{"group":"Advanced","icon":"sliders","pages":[{"title":"Authentication","href":"/v0.14/advanced/authentication"},{"title":"Single Sign-On (SSO)","href":"/v0.14/advanced/sso"},{"title":"Integrations","href":"/v0.14/advanced/integrations"},{"title":"Permissions","href":"/v0.14/advanced/permissions"},{"title":"GPU management","href":"/v0.14/advanced/optimization"},{"title":"Reward servers","href":"/v0.14/advanced/reward-servers"}]},{"group":"Deploy","icon":"rocket","pages":[{"title":"Self-hosting","href":"/v0.14/deploy/self-hosting"},{"title":"Architecture","href":"/v0.14/deploy/architecture"}]},{"group":"Updates","icon":"newspaper","pages":[{"title":"Release notes","href":"/release-notes"}]}]},{"tab":"Harmony","groups":[{"group":"Getting Started","icon":"play","pages":[{"title":"Overview","href":"/v0.14/harmony/overview"},{"title":"Prerequisites and setup","href":"/v0.14/harmony/install"},{"title":"Harmony client and local testing","href":"/v0.14/harmony/harmony-client"},{"title":"Recipe syntax","href":"/v0.14/harmony/recipe-syntax"},{"title":"Input configuration","href":"/v0.14/harmony/config"}]},{"group":"Building Blocks","icon":"puzzle-piece","pages":[{"title":"Threads","href":"/v0.14/harmony/string-thread"},{"title":"Load datasets and StringThread","href":"/v0.14/harmony/datasets"},{"title":"Load models","href":"/v0.14/harmony/models"},{"title":"Load Graders","href":"/v0.14/harmony/platform-graders"},{"title":"Custom recipe Graders","href":"/v0.14/harmony/graders"},{"title":"Output artifacts","href":"/v0.14/harmony/artifacts"},{"title":"Structured generation","href":"/v0.14/harmony/structured-output"},{"title":"Asynchronous utilities","href":"/v0.14/harmony/async-utils"}]},{"group":"Training \u0026 Evaluation","icon":"dumbbell","pages":[{"title":"Create a training recipe","href":"/v0.14/harmony/training"},{"title":"Create a training algorithm","href":"/v0.14/harmony/algorithms"},{"title":"Log run metrics","href":"/v0.14/harmony/logging"},{"title":"Progress reporting","href":"/v0.14/harmony/progress"},{"title":"Training callbacks","href":"/v0.14/harmony/callbacks"},{"title":"Create an evaluation recipe","href":"/v0.14/harmony/eval"}]},{"group":"Cookbook","icon":"book-open-cover","pages":[{"group":"Agentic","pages":[{"title":"Multi-turn training with environments","href":"/v0.14/harmony/cookbook/agentic/multi-turn"}]},{"group":"Custom graders","pages":[{"title":"Binary LLM judge grader","href":"/v0.14/harmony/cookbook/custom-graders/binary-judge"},{"title":"Label classification accuracy","href":"/v0.14/harmony/cookbook/custom-graders/classification"},{"title":"Ranged scoring with LLM judges","href":"/v0.14/harmony/cookbook/custom-graders/range-judge"},{"title":"Grading structured JSON with template injection","href":"/v0.14/harmony/cookbook/custom-graders/structured-output"}]},{"group":"Training","pages":[{"title":"Two-stage training - SFT warm-up before RL","href":"/v0.14/harmony/cookbook/training/sft-warmup"}]}]},{"group":"Updates","icon":"newspaper","pages":[{"title":"Release notes","href":"/v0.14/harmony/release-notes"}]}]},{"tab":"SDK Reference","groups":[{"group":"SDK","pages":[{"title":"SDK reference","href":"/v0.14/reference/sdk"}]},{"group":"API","pages":[{"title":"API reference","href":"/v0.14/reference/api"}]}]}]},{"version":"v0.13","default":true,"pages":[{"title":"v0.13","href":"/v0.13/introduction"}]},{"version":"v0.12","pages":[{"title":"v0.12","href":"/v0.12/introduction"}]},{"version":"v0.11","pages":[{"title":"v0.11","href":"/v0.11/introduction"}]},{"version":"v0.10","pages":[{"title":"v0.10","href":"/release-notes"}]},{"version":"v0.8","pages":[{"title":"v0.8","href":"/release-notes"}]},{"version":"v0.7","pages":[{"title":"v0.7","href":"/release-notes"}]},{"version":"v0.6","pages":[{"title":"v0.6","href":"/release-notes"}]},{"version":"v0.5","pages":[{"title":"v0.5","href":"/release-notes"}]}]},"basePath":"","title":"Generate chat completion - Adaptive ML Documentation","buildId":"dpl_GZsjphRpnhWkstV12jxWNcMHFyox","deploymentId":"dpl_GZsjphRpnhWkstV12jxWNcMHFyox","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B5zPa4Vr.js","utils-CVjrr8Yd.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DTgURWzl.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DxTHtkdZ.js","snippetPresets-Cx47o5Vx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-4Fr6y9N_.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Dq2ElbEk.js","shallow-BfYl9r69.js","getApiPlaygroundDisplay-Ch3xc7i1.js","CodeSnippet-BsBxuJ1v.js","CodeSnippets-CetzeDL8.js","Page-CYZot51e.js","getPastedJson-BxPKFSJx.js","icon-o0J1Ochb.js","MethodPill-Du3usO5m.js","DuplicateIcon-DJypyMzl.js","createIcon-YMA6N8KJ.js","DynamicMarkdown-CWvhfcZc.js","SectionHeading-BdLVaXCd.js","axios-vUo_bRtp.js","Markdown-C4Ez6OeV.js","clsx-DptzKFCt.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-Dt1IougW.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CZ6Wt2Vb.js"]}