Developer-provided instructions that the model should follow, regardless of
messages sent by the user. With o1 models and newer, developer messages
replace the previous system messages.
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"Agent Stack","colors":{"primary":"#000000","light":"#c5c5c5","dark":"#000000"},"favicon":"https://mintcdn.com/ibm-8c0b5b62/BjsSe0erXdvYok_r/favicon.svg?fit=max\u0026auto=format\u0026n=BjsSe0erXdvYok_r\u0026q=85\u0026s=ec1d52abadf5ea26cf8b36c13a64af2e","navbar":{"links":[{"href":"https://discord.gg/NradeA6ZNF","label":"Discord"}],"primary":{"type":"button","label":"GitHub","href":"https://github.com/i-am-bee/agentstack"}},"footer":{"socials":{"github":"https://github.com/i-am-bee/agentstack","discord":"https://discord.gg/AZFrp3UF5k","bluesky":"https://bsky.app/profile/beeaiagents.bsky.social"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"ibm-8c0b5b62","hasAudioNarration":false,"actualSubdomain":"ibm-8c0b5b62","customDomains":["agentstack.beeai.dev"],"gitSource":{"type":"github","owner":"i-am-bee","repo":"agentstack","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a98bd8e90df3562f5e0158d","collectionId":"eb6ce558-4bba-44b0-88ec-c13227f7e82d","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6a98bd8e90df3562f5e0158d"},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"REMOVE_BRANDING":{"status":"ENABLED"}},"buildId":"6a98bd8e90df3562f5e0158d","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"Reference","count":92},{"language":"default","tag":"API Reference","count":89},{"language":"default","tag":"Agent Integration","count":36},{"language":"default","tag":"Custom UI Integration","count":18},{"language":"default","tag":"a2a","count":17},{"language":"default","tag":"connectors","count":10},{"language":"default","tag":"contexts","count":10},{"language":"default","tag":"providers","count":10},{"language":"default","tag":"files","count":9},{"language":"default","tag":"Deploy Agents","count":8}]},"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":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/openai/create-chat-completion","slug":"/api-reference/openai/create-chat-completion","pageMetadata":{"title":"Create Chat Completion","description":null,"deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json post /api/v1/openai/chat/completions","href":"/api-reference/openai/create-chat-completion","autogeneratedByOpenApi":true},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create Chat Completion","description":null,"deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json post /api/v1/openai/chat/completions","href":"/api-reference/openai/create-chat-completion","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/ibm-8c0b5b62/a6db903b88df9d6e/redirect-staging.js","/_mintlify/custom/ibm-8c0b5b62/456556f95b1893eb/prettier.config.js"],"openApiReferenceData":{"operation":{"tags":["openai"],"summary":"Create Chat Completion","operationId":"create_chat_completion_api_v1_openai_chat_completions_post","requestBody":"ee2e4b16-1f2c-4c79-9ec1-cea86c394c10","responses":{"200":"21dbe828-0d97-4f70-96c2-cff36a104154","422":"1a47815f-d98e-4e5f-bfd6-8127d1bfa530"},"security":["3da5fabd-1784-4b15-a719-f6b0ba3b125e","5df34faa-532e-4131-900f-cf3213c675a0"],"method":"post","type":"path","servers":[],"path":"/api/v1/openai/chat/completions","baseUrlOptions":[],"title":"Create Chat Completion","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"properties":{"messages":{"items":{"oneOf":[{"type":"object","title":"ChatCompletionDeveloperMessageParam","description":"Developer-provided instructions that the model should follow, regardless of\nmessages sent by the user. With o1 models and newer, `developer` messages\nreplace the previous `system` messages.","required":["content","role"],"properties":{"content":{"oneOf":[{"type":"string","title":"Content","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.0.content.oneOf.0","typeLabel":"string"},{"type":"array","items":{"properties":{"text":{"type":"string","title":"Text","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.0.content.oneOf.1.items.[INDEX].text","typeLabel":"string"},"type":{"type":"string","const":"text","title":"Type","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.0.content.oneOf.1.items.[INDEX].type","typeLabel":"string"}},"type":"object","required":["text","type"],"title":"ChatCompletionContentPartTextParam","description":"Learn about [text inputs](https://platform.openai.com/docs/guides/text-generation).","uniqueKey":"messages.items.[INDEX].oneOf.0.content.oneOf.1.items.[INDEX]","typeLabel":"ChatCompletionContentPartTextParam · object"},"title":"Content","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.0.content.oneOf.1","typeLabel":"ChatCompletionContentPartTextParam · object[]"}],"isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.0.content","typeLabel":"string | ChatCompletionContentPartTextParam · object[]"},"role":{"type":"string","const":"developer","title":"Role","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.0.role","typeLabel":"string"},"name":{"type":"string","title":"Name","uniqueKey":"messages.items.[INDEX].oneOf.0.name","typeLabel":"string"}},"uniqueKey":"messages.items.[INDEX].oneOf.0","typeLabel":"ChatCompletionDeveloperMessageParam · object"},{"type":"object","title":"ChatCompletionSystemMessageParam","description":"Developer-provided instructions that the model should follow, regardless of\nmessages sent by the user. With o1 models and newer, use `developer` messages\nfor this purpose instead.","required":["content","role"],"properties":{"content":{"oneOf":[{"type":"string","title":"Content","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.1.content.oneOf.0","typeLabel":"string"},{"type":"array","items":{"properties":{"text":{"type":"string","title":"Text","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.1.content.oneOf.1.items.[INDEX].text","typeLabel":"string"},"type":{"type":"string","const":"text","title":"Type","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.1.content.oneOf.1.items.[INDEX].type","typeLabel":"string"}},"type":"object","required":["text","type"],"title":"ChatCompletionContentPartTextParam","description":"Learn about [text inputs](https://platform.openai.com/docs/guides/text-generation).","uniqueKey":"messages.items.[INDEX].oneOf.1.content.oneOf.1.items.[INDEX]","typeLabel":"ChatCompletionContentPartTextParam · object"},"title":"Content","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.1.content.oneOf.1","typeLabel":"ChatCompletionContentPartTextParam · object[]"}],"isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.1.content","typeLabel":"string | ChatCompletionContentPartTextParam · object[]"},"role":{"type":"string","const":"system","title":"Role","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.1.role","typeLabel":"string"},"name":{"type":"string","title":"Name","uniqueKey":"messages.items.[INDEX].oneOf.1.name","typeLabel":"string"}},"uniqueKey":"messages.items.[INDEX].oneOf.1","typeLabel":"ChatCompletionSystemMessageParam · object"},{"type":"object","title":"ChatCompletionUserMessageParam","description":"Messages sent by an end user, containing prompts or additional context\ninformation.","required":["content","role"],"properties":{"content":{"oneOf":[{"type":"string","title":"Content","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.2.content.oneOf.0","typeLabel":"string"},{"type":"array","items":{"oneOf":[{"type":"object","title":"ChatCompletionContentPartTextParam","description":"Learn about [text inputs](https://platform.openai.com/docs/guides/text-generation).","required":["text","type"],"properties":{"text":{"type":"string","title":"Text","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.2.content.oneOf.1.items.[INDEX].oneOf.0.text","typeLabel":"string"},"type":{"type":"string","const":"text","title":"Type","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.2.content.oneOf.1.items.[INDEX].oneOf.0.type","typeLabel":"string"}},"uniqueKey":"messages.items.[INDEX].oneOf.2.content.oneOf.1.items.[INDEX].oneOf.0","typeLabel":"ChatCompletionContentPartTextParam · object"},{"type":"object","title":"ChatCompletionContentPartImageParam","description":"Learn about [image inputs](https://platform.openai.com/docs/guides/vision).","required":["image_url","type"],"properties":{"image_url":{"properties":{"url":{"type":"string","title":"Url","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.2.content.oneOf.1.items.[INDEX].oneOf.1.image_url.url","typeLabel":"string"},"detail":{"type":"string","enum":["auto","low","high"],"title":"Detail","uniqueKey":"messages.items.[INDEX].oneOf.2.content.oneOf.1.items.[INDEX].oneOf.1.image_url.detail","typeLabel":"enum\u003cstring>"}},"type":"object","required":["url"],"title":"ImageURL","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.2.content.oneOf.1.items.[INDEX].oneOf.1.image_url","typeLabel":"ImageURL · object"},"type":{"type":"string","const":"image_url","title":"Type","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.2.content.oneOf.1.items.[INDEX].oneOf.1.type","typeLabel":"string"}},"uniqueKey":"messages.items.[INDEX].oneOf.2.content.oneOf.1.items.[INDEX].oneOf.1","typeLabel":"ChatCompletionContentPartImageParam · object"},{"type":"object","title":"ChatCompletionContentPartInputAudioParam","description":"Learn about [audio inputs](https://platform.openai.com/docs/guides/audio).","required":["input_audio","type"],"properties":{"input_audio":{"properties":{"data":{"type":"string","title":"Data","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.2.content.oneOf.1.items.[INDEX].oneOf.2.input_audio.data","typeLabel":"string"},"format":{"type":"string","enum":["wav","mp3"],"title":"Format","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.2.content.oneOf.1.items.[INDEX].oneOf.2.input_audio.format","typeLabel":"enum\u003cstring>"}},"type":"object","required":["data","format"],"title":"InputAudio","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.2.content.oneOf.1.items.[INDEX].oneOf.2.input_audio","typeLabel":"InputAudio · object"},"type":{"type":"string","const":"input_audio","title":"Type","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.2.content.oneOf.1.items.[INDEX].oneOf.2.type","typeLabel":"string"}},"uniqueKey":"messages.items.[INDEX].oneOf.2.content.oneOf.1.items.[INDEX].oneOf.2","typeLabel":"ChatCompletionContentPartInputAudioParam · object"},{"type":"object","title":"File","description":"Learn about [file inputs](https://platform.openai.com/docs/guides/text) for text generation.","required":["file","type"],"properties":{"file":{"properties":{"file_data":{"type":"string","title":"File Data","uniqueKey":"messages.items.[INDEX].oneOf.2.content.oneOf.1.items.[INDEX].oneOf.3.file.file_data","typeLabel":"string"},"file_id":{"type":"string","title":"File Id","uniqueKey":"messages.items.[INDEX].oneOf.2.content.oneOf.1.items.[INDEX].oneOf.3.file.file_id","typeLabel":"string"},"filename":{"type":"string","title":"Filename","uniqueKey":"messages.items.[INDEX].oneOf.2.content.oneOf.1.items.[INDEX].oneOf.3.file.filename","typeLabel":"string"}},"type":"object","title":"FileFile","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.2.content.oneOf.1.items.[INDEX].oneOf.3.file","typeLabel":"FileFile · object"},"type":{"type":"string","const":"file","title":"Type","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.2.content.oneOf.1.items.[INDEX].oneOf.3.type","typeLabel":"string"}},"uniqueKey":"messages.items.[INDEX].oneOf.2.content.oneOf.1.items.[INDEX].oneOf.3","typeLabel":"File · object"}],"uniqueKey":"messages.items.[INDEX].oneOf.2.content.oneOf.1.items.[INDEX]","typeLabel":"ChatCompletionContentPartTextParam · object | ChatCompletionContentPartImageParam · object | ChatCompletionContentPartInputAudioParam · object | File · object"},"title":"Content","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.2.content.oneOf.1","typeLabel":"(ChatCompletionContentPartTextParam · object | ChatCompletionContentPartImageParam · object | ChatCompletionContentPartInputAudioParam · object | File · object)[]"}],"isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.2.content","typeLabel":"string | (ChatCompletionContentPartTextParam · object | ChatCompletionContentPartImageParam · object | ChatCompletionContentPartInputAudioParam · object | File · object)[]"},"role":{"type":"string","const":"user","title":"Role","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.2.role","typeLabel":"string"},"name":{"type":"string","title":"Name","uniqueKey":"messages.items.[INDEX].oneOf.2.name","typeLabel":"string"}},"uniqueKey":"messages.items.[INDEX].oneOf.2","typeLabel":"ChatCompletionUserMessageParam · object"},{"type":"object","title":"ChatCompletionAssistantMessageParam","description":"Messages sent by the model in response to user messages.","required":["role"],"properties":{"role":{"type":"string","const":"assistant","title":"Role","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.3.role","typeLabel":"string"},"audio":{"oneOf":[{"type":"object","title":"Audio","description":"Data about a previous audio response from the model.\n[Learn more](https://platform.openai.com/docs/guides/audio).","required":["id"],"properties":{"id":{"type":"string","title":"Id","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.3.audio.oneOf.0.id","typeLabel":"string"}},"uniqueKey":"messages.items.[INDEX].oneOf.3.audio.oneOf.0","typeLabel":"Audio · object"},{"type":"null","uniqueKey":"messages.items.[INDEX].oneOf.3.audio.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].oneOf.3.audio","typeLabel":"Audio · object | null"},"content":{"oneOf":[{"type":"string","title":"Content","uniqueKey":"messages.items.[INDEX].oneOf.3.content.oneOf.0","typeLabel":"string"},{"type":"array","items":{"oneOf":[{"type":"object","title":"ChatCompletionContentPartTextParam","description":"Learn about [text inputs](https://platform.openai.com/docs/guides/text-generation).","required":["text","type"],"properties":{"text":{"type":"string","title":"Text","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.3.content.oneOf.1.items.[INDEX].oneOf.0.text","typeLabel":"string"},"type":{"type":"string","const":"text","title":"Type","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.3.content.oneOf.1.items.[INDEX].oneOf.0.type","typeLabel":"string"}},"uniqueKey":"messages.items.[INDEX].oneOf.3.content.oneOf.1.items.[INDEX].oneOf.0","typeLabel":"ChatCompletionContentPartTextParam · object"},{"type":"object","title":"ChatCompletionContentPartRefusalParam","required":["refusal","type"],"properties":{"refusal":{"type":"string","title":"Refusal","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.3.content.oneOf.1.items.[INDEX].oneOf.1.refusal","typeLabel":"string"},"type":{"type":"string","const":"refusal","title":"Type","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.3.content.oneOf.1.items.[INDEX].oneOf.1.type","typeLabel":"string"}},"uniqueKey":"messages.items.[INDEX].oneOf.3.content.oneOf.1.items.[INDEX].oneOf.1","typeLabel":"ChatCompletionContentPartRefusalParam · object"}],"uniqueKey":"messages.items.[INDEX].oneOf.3.content.oneOf.1.items.[INDEX]","typeLabel":"ChatCompletionContentPartTextParam · object | ChatCompletionContentPartRefusalParam · object"},"title":"Content","uniqueKey":"messages.items.[INDEX].oneOf.3.content.oneOf.1","typeLabel":"(ChatCompletionContentPartTextParam · object | ChatCompletionContentPartRefusalParam · object)[]"},{"type":"null","title":"Content","uniqueKey":"messages.items.[INDEX].oneOf.3.content.oneOf.2","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].oneOf.3.content","typeLabel":"string | (ChatCompletionContentPartTextParam · object | ChatCompletionContentPartRefusalParam · object)[] | null"},"function_call":{"oneOf":[{"type":"object","title":"FunctionCall","description":"Deprecated and replaced by `tool_calls`.\n\nThe name and arguments of a function that should be called, as generated by the model.","required":["arguments","name"],"properties":{"arguments":{"type":"string","title":"Arguments","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.3.function_call.oneOf.0.arguments","typeLabel":"string"},"name":{"type":"string","title":"Name","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.3.function_call.oneOf.0.name","typeLabel":"string"}},"uniqueKey":"messages.items.[INDEX].oneOf.3.function_call.oneOf.0","typeLabel":"FunctionCall · object"},{"type":"null","uniqueKey":"messages.items.[INDEX].oneOf.3.function_call.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].oneOf.3.function_call","typeLabel":"FunctionCall · object | null"},"name":{"type":"string","title":"Name","uniqueKey":"messages.items.[INDEX].oneOf.3.name","typeLabel":"string"},"refusal":{"oneOf":[{"type":"string","title":"Refusal","uniqueKey":"messages.items.[INDEX].oneOf.3.refusal.oneOf.0","typeLabel":"string"},{"type":"null","title":"Refusal","uniqueKey":"messages.items.[INDEX].oneOf.3.refusal.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].oneOf.3.refusal","typeLabel":"string | null"},"tool_calls":{"items":{"oneOf":[{"type":"object","title":"ChatCompletionMessageFunctionToolCallParam","description":"A call to a function tool created by the model.","required":["id","function","type"],"properties":{"id":{"type":"string","title":"Id","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.3.tool_calls.items.[INDEX].oneOf.0.id","typeLabel":"string"},"function":{"properties":{"arguments":{"type":"string","title":"Arguments","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.3.tool_calls.items.[INDEX].oneOf.0.function.arguments","typeLabel":"string"},"name":{"type":"string","title":"Name","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.3.tool_calls.items.[INDEX].oneOf.0.function.name","typeLabel":"string"}},"type":"object","required":["arguments","name"],"title":"Function","description":"The function that the model called.","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.3.tool_calls.items.[INDEX].oneOf.0.function","typeLabel":"Function · object"},"type":{"type":"string","const":"function","title":"Type","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.3.tool_calls.items.[INDEX].oneOf.0.type","typeLabel":"string"}},"uniqueKey":"messages.items.[INDEX].oneOf.3.tool_calls.items.[INDEX].oneOf.0","typeLabel":"ChatCompletionMessageFunctionToolCallParam · object"},{"type":"object","title":"ChatCompletionMessageCustomToolCallParam","description":"A call to a custom tool created by the model.","required":["id","custom","type"],"properties":{"id":{"type":"string","title":"Id","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.3.tool_calls.items.[INDEX].oneOf.1.id","typeLabel":"string"},"custom":{"properties":{"input":{"type":"string","title":"Input","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.3.tool_calls.items.[INDEX].oneOf.1.custom.input","typeLabel":"string"},"name":{"type":"string","title":"Name","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.3.tool_calls.items.[INDEX].oneOf.1.custom.name","typeLabel":"string"}},"type":"object","required":["input","name"],"title":"Custom","description":"The custom tool that the model called.","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.3.tool_calls.items.[INDEX].oneOf.1.custom","typeLabel":"Custom · object"},"type":{"type":"string","const":"custom","title":"Type","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.3.tool_calls.items.[INDEX].oneOf.1.type","typeLabel":"string"}},"uniqueKey":"messages.items.[INDEX].oneOf.3.tool_calls.items.[INDEX].oneOf.1","typeLabel":"ChatCompletionMessageCustomToolCallParam · object"}],"uniqueKey":"messages.items.[INDEX].oneOf.3.tool_calls.items.[INDEX]","typeLabel":"ChatCompletionMessageFunctionToolCallParam · object | ChatCompletionMessageCustomToolCallParam · object"},"type":"array","title":"Tool Calls","uniqueKey":"messages.items.[INDEX].oneOf.3.tool_calls","typeLabel":"(ChatCompletionMessageFunctionToolCallParam · object | ChatCompletionMessageCustomToolCallParam · object)[]"}},"uniqueKey":"messages.items.[INDEX].oneOf.3","typeLabel":"ChatCompletionAssistantMessageParam · object"},{"type":"object","title":"ChatCompletionToolMessageParam","required":["content","role","tool_call_id"],"properties":{"content":{"oneOf":[{"type":"string","title":"Content","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.4.content.oneOf.0","typeLabel":"string"},{"type":"array","items":{"properties":{"text":{"type":"string","title":"Text","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.4.content.oneOf.1.items.[INDEX].text","typeLabel":"string"},"type":{"type":"string","const":"text","title":"Type","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.4.content.oneOf.1.items.[INDEX].type","typeLabel":"string"}},"type":"object","required":["text","type"],"title":"ChatCompletionContentPartTextParam","description":"Learn about [text inputs](https://platform.openai.com/docs/guides/text-generation).","uniqueKey":"messages.items.[INDEX].oneOf.4.content.oneOf.1.items.[INDEX]","typeLabel":"ChatCompletionContentPartTextParam · object"},"title":"Content","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.4.content.oneOf.1","typeLabel":"ChatCompletionContentPartTextParam · object[]"}],"isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.4.content","typeLabel":"string | ChatCompletionContentPartTextParam · object[]"},"role":{"type":"string","const":"tool","title":"Role","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.4.role","typeLabel":"string"},"tool_call_id":{"type":"string","title":"Tool Call Id","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.4.tool_call_id","typeLabel":"string"}},"uniqueKey":"messages.items.[INDEX].oneOf.4","typeLabel":"ChatCompletionToolMessageParam · object"},{"type":"object","title":"ChatCompletionFunctionMessageParam","required":["content","name","role"],"properties":{"content":{"oneOf":[{"type":"string","title":"Content","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.5.content.oneOf.0","typeLabel":"string"},{"type":"null","title":"Content","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.5.content.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.5.content","typeLabel":"string | null"},"name":{"type":"string","title":"Name","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.5.name","typeLabel":"string"},"role":{"type":"string","const":"function","title":"Role","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.5.role","typeLabel":"string"}},"uniqueKey":"messages.items.[INDEX].oneOf.5","typeLabel":"ChatCompletionFunctionMessageParam · object"}],"uniqueKey":"messages.items.[INDEX]","typeLabel":"ChatCompletionDeveloperMessageParam · object | ChatCompletionSystemMessageParam · object | ChatCompletionUserMessageParam · object | ChatCompletionAssistantMessageParam · object | ChatCompletionToolMessageParam · object | ChatCompletionFunctionMessageParam · object"},"type":"array","title":"Messages","isRequired":true,"uniqueKey":"messages","typeLabel":"(ChatCompletionDeveloperMessageParam · object | ChatCompletionSystemMessageParam · object | ChatCompletionUserMessageParam · object | ChatCompletionAssistantMessageParam · object | ChatCompletionToolMessageParam · object | ChatCompletionFunctionMessageParam · object)[]"},"model":{"oneOf":[{"type":"string","title":"Model","isRequired":true,"uniqueKey":"model.oneOf.0","typeLabel":"string"},{"type":"string","title":"Model","enum":["gpt-5.2","gpt-5.2-2025-12-11","gpt-5.2-chat-latest","gpt-5.2-pro","gpt-5.2-pro-2025-12-11","gpt-5.1","gpt-5.1-2025-11-13","gpt-5.1-codex","gpt-5.1-mini","gpt-5.1-chat-latest","gpt-5","gpt-5-mini","gpt-5-nano","gpt-5-2025-08-07","gpt-5-mini-2025-08-07","gpt-5-nano-2025-08-07","gpt-5-chat-latest","gpt-4.1","gpt-4.1-mini","gpt-4.1-nano","gpt-4.1-2025-04-14","gpt-4.1-mini-2025-04-14","gpt-4.1-nano-2025-04-14","o4-mini","o4-mini-2025-04-16","o3","o3-2025-04-16","o3-mini","o3-mini-2025-01-31","o1","o1-2024-12-17","o1-preview","o1-preview-2024-09-12","o1-mini","o1-mini-2024-09-12","gpt-4o","gpt-4o-2024-11-20","gpt-4o-2024-08-06","gpt-4o-2024-05-13","gpt-4o-audio-preview","gpt-4o-audio-preview-2024-10-01","gpt-4o-audio-preview-2024-12-17","gpt-4o-audio-preview-2025-06-03","gpt-4o-mini-audio-preview","gpt-4o-mini-audio-preview-2024-12-17","gpt-4o-search-preview","gpt-4o-mini-search-preview","gpt-4o-search-preview-2025-03-11","gpt-4o-mini-search-preview-2025-03-11","chatgpt-4o-latest","codex-mini-latest","gpt-4o-mini","gpt-4o-mini-2024-07-18","gpt-4-turbo","gpt-4-turbo-2024-04-09","gpt-4-0125-preview","gpt-4-turbo-preview","gpt-4-1106-preview","gpt-4-vision-preview","gpt-4","gpt-4-0314","gpt-4-0613","gpt-4-32k","gpt-4-32k-0314","gpt-4-32k-0613","gpt-3.5-turbo","gpt-3.5-turbo-16k","gpt-3.5-turbo-0301","gpt-3.5-turbo-0613","gpt-3.5-turbo-1106","gpt-3.5-turbo-0125","gpt-3.5-turbo-16k-0613"],"isRequired":true,"uniqueKey":"model.oneOf.1","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"model","typeLabel":"string | enum\u003cstring>"},"audio":{"oneOf":[{"type":"object","title":"ChatCompletionAudioParam","description":"Parameters for audio output.\n\nRequired when audio output is requested with\n`modalities: [\"audio\"]`. [Learn more](https://platform.openai.com/docs/guides/audio).","required":["format","voice"],"properties":{"format":{"type":"string","enum":["wav","aac","mp3","flac","opus","pcm16"],"title":"Format","isRequired":true,"uniqueKey":"audio.oneOf.0.format","typeLabel":"enum\u003cstring>"},"voice":{"oneOf":[{"type":"string","title":"Voice","isRequired":true,"uniqueKey":"audio.oneOf.0.voice.oneOf.0","typeLabel":"string"},{"type":"string","title":"Voice","enum":["alloy","ash","ballad","coral","echo","sage","shimmer","verse","marin","cedar"],"isRequired":true,"uniqueKey":"audio.oneOf.0.voice.oneOf.1","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"audio.oneOf.0.voice","typeLabel":"string | enum\u003cstring>"}},"uniqueKey":"audio.oneOf.0","typeLabel":"ChatCompletionAudioParam · object"},{"type":"null","uniqueKey":"audio.oneOf.1","typeLabel":"null"}],"uniqueKey":"audio","typeLabel":"ChatCompletionAudioParam · object | null"},"frequency_penalty":{"oneOf":[{"type":"number","title":"Frequency Penalty","uniqueKey":"frequency_penalty.oneOf.0","typeLabel":"number"},{"type":"null","title":"Frequency Penalty","uniqueKey":"frequency_penalty.oneOf.1","typeLabel":"null"}],"uniqueKey":"frequency_penalty","typeLabel":"number | null"},"function_call":{"oneOf":[{"type":"string","title":"Function Call","enum":["none","auto"],"uniqueKey":"function_call.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"object","title":"ChatCompletionFunctionCallOptionParam","description":"Specifying a particular function via `{\"name\": \"my_function\"}` forces the model to call that function.","required":["name"],"properties":{"name":{"type":"string","title":"Name","isRequired":true,"uniqueKey":"function_call.oneOf.1.name","typeLabel":"string"}},"uniqueKey":"function_call.oneOf.1","typeLabel":"ChatCompletionFunctionCallOptionParam · object"},{"type":"null","title":"Function Call","uniqueKey":"function_call.oneOf.2","typeLabel":"null"}],"uniqueKey":"function_call","typeLabel":"enum\u003cstring> | ChatCompletionFunctionCallOptionParam · object | null"},"functions":{"oneOf":[{"type":"array","items":{"properties":{"name":{"type":"string","title":"Name","isRequired":true,"uniqueKey":"functions.oneOf.0.items.[INDEX].name","typeLabel":"string"},"description":{"type":"string","title":"Description","uniqueKey":"functions.oneOf.0.items.[INDEX].description","typeLabel":"string"},"parameters":{"additionalProperties":true,"type":"object","title":"Parameters","uniqueKey":"functions.oneOf.0.items.[INDEX].parameters","typeLabel":"Parameters · object"}},"type":"object","required":["name"],"title":"Function","uniqueKey":"functions.oneOf.0.items.[INDEX]","typeLabel":"Function · object"},"title":"Functions","uniqueKey":"functions.oneOf.0","typeLabel":"Function · object[]"},{"type":"null","title":"Functions","uniqueKey":"functions.oneOf.1","typeLabel":"null"}],"uniqueKey":"functions","typeLabel":"Function · object[] | null"},"logit_bias":{"oneOf":[{"type":"object","title":"Logit Bias","additionalProperties":{"type":"integer","uniqueKey":"logit_bias.oneOf.0.additionalProperties","typeLabel":"integer"},"uniqueKey":"logit_bias.oneOf.0","typeLabel":"Logit Bias · object"},{"type":"null","title":"Logit Bias","uniqueKey":"logit_bias.oneOf.1","typeLabel":"null"}],"uniqueKey":"logit_bias","typeLabel":"Logit Bias · object | null"},"logprobs":{"oneOf":[{"type":"boolean","title":"Logprobs","uniqueKey":"logprobs.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Logprobs","uniqueKey":"logprobs.oneOf.1","typeLabel":"null"}],"uniqueKey":"logprobs","typeLabel":"boolean | null"},"max_completion_tokens":{"oneOf":[{"type":"integer","title":"Max Completion Tokens","uniqueKey":"max_completion_tokens.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Max Completion Tokens","uniqueKey":"max_completion_tokens.oneOf.1","typeLabel":"null"}],"uniqueKey":"max_completion_tokens","typeLabel":"integer | null"},"max_tokens":{"oneOf":[{"type":"integer","title":"Max Tokens","uniqueKey":"max_tokens.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Max Tokens","uniqueKey":"max_tokens.oneOf.1","typeLabel":"null"}],"uniqueKey":"max_tokens","typeLabel":"integer | null"},"metadata":{"oneOf":[{"type":"object","title":"Metadata","additionalProperties":{"type":"string","uniqueKey":"metadata.oneOf.0.additionalProperties","typeLabel":"string"},"uniqueKey":"metadata.oneOf.0","typeLabel":"Metadata · object"},{"type":"null","title":"Metadata","uniqueKey":"metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"metadata","typeLabel":"Metadata · object | null"},"modalities":{"oneOf":[{"type":"array","items":{"type":"string","enum":["text","audio"],"uniqueKey":"modalities.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"title":"Modalities","uniqueKey":"modalities.oneOf.0","typeLabel":"enum\u003cstring>[]"},{"type":"null","title":"Modalities","uniqueKey":"modalities.oneOf.1","typeLabel":"null"}],"uniqueKey":"modalities","typeLabel":"enum\u003cstring>[] | null"},"n":{"oneOf":[{"type":"integer","title":"N","uniqueKey":"n.oneOf.0","typeLabel":"integer"},{"type":"null","title":"N","uniqueKey":"n.oneOf.1","typeLabel":"null"}],"uniqueKey":"n","typeLabel":"integer | null"},"parallel_tool_calls":{"oneOf":[{"type":"boolean","title":"Parallel Tool Calls","uniqueKey":"parallel_tool_calls.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Parallel Tool Calls","uniqueKey":"parallel_tool_calls.oneOf.1","typeLabel":"null"}],"uniqueKey":"parallel_tool_calls","typeLabel":"boolean | null"},"prediction":{"oneOf":[{"type":"object","title":"ChatCompletionPredictionContentParam","description":"Static predicted output content, such as the content of a text file that is\nbeing regenerated.","required":["content","type"],"properties":{"content":{"oneOf":[{"type":"string","title":"Content","isRequired":true,"uniqueKey":"prediction.oneOf.0.content.oneOf.0","typeLabel":"string"},{"type":"array","items":{"properties":{"text":{"type":"string","title":"Text","isRequired":true,"uniqueKey":"prediction.oneOf.0.content.oneOf.1.items.[INDEX].text","typeLabel":"string"},"type":{"type":"string","const":"text","title":"Type","isRequired":true,"uniqueKey":"prediction.oneOf.0.content.oneOf.1.items.[INDEX].type","typeLabel":"string"}},"type":"object","required":["text","type"],"title":"ChatCompletionContentPartTextParam","description":"Learn about [text inputs](https://platform.openai.com/docs/guides/text-generation).","uniqueKey":"prediction.oneOf.0.content.oneOf.1.items.[INDEX]","typeLabel":"ChatCompletionContentPartTextParam · object"},"title":"Content","isRequired":true,"uniqueKey":"prediction.oneOf.0.content.oneOf.1","typeLabel":"ChatCompletionContentPartTextParam · object[]"}],"isRequired":true,"uniqueKey":"prediction.oneOf.0.content","typeLabel":"string | ChatCompletionContentPartTextParam · object[]"},"type":{"type":"string","const":"content","title":"Type","isRequired":true,"uniqueKey":"prediction.oneOf.0.type","typeLabel":"string"}},"uniqueKey":"prediction.oneOf.0","typeLabel":"ChatCompletionPredictionContentParam · object"},{"type":"null","uniqueKey":"prediction.oneOf.1","typeLabel":"null"}],"uniqueKey":"prediction","typeLabel":"ChatCompletionPredictionContentParam · object | null"},"presence_penalty":{"oneOf":[{"type":"number","title":"Presence Penalty","uniqueKey":"presence_penalty.oneOf.0","typeLabel":"number"},{"type":"null","title":"Presence Penalty","uniqueKey":"presence_penalty.oneOf.1","typeLabel":"null"}],"uniqueKey":"presence_penalty","typeLabel":"number | null"},"reasoning_effort":{"oneOf":[{"type":"string","title":"Reasoning Effort","enum":["none","minimal","low","medium","high","xhigh"],"uniqueKey":"reasoning_effort.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Reasoning Effort","uniqueKey":"reasoning_effort.oneOf.1","typeLabel":"null"}],"uniqueKey":"reasoning_effort","typeLabel":"enum\u003cstring> | null"},"response_format":{"oneOf":[{"type":"object","title":"ResponseFormatText","description":"Default response format. Used to generate text responses.","required":["type"],"properties":{"type":{"type":"string","const":"text","title":"Type","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":true,"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":{"type":"string","const":"json_object","title":"Type","isRequired":true,"uniqueKey":"response_format.oneOf.2.type","typeLabel":"string"}},"uniqueKey":"response_format.oneOf.2","typeLabel":"ResponseFormatJSONObject · object"},{"type":"null","title":"Response Format","uniqueKey":"response_format.oneOf.3","typeLabel":"null"}],"uniqueKey":"response_format","typeLabel":"ResponseFormatText · object | ResponseFormatJSONSchema · object | ResponseFormatJSONObject · object | null"},"seed":{"oneOf":[{"type":"integer","title":"Seed","uniqueKey":"seed.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Seed","uniqueKey":"seed.oneOf.1","typeLabel":"null"}],"uniqueKey":"seed","typeLabel":"integer | 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"},"stop":{"oneOf":[{"type":"string","title":"Stop","uniqueKey":"stop.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"stop.oneOf.1.items.[INDEX]","typeLabel":"string"},"title":"Stop","uniqueKey":"stop.oneOf.1","typeLabel":"string[]"},{"type":"null","title":"Stop","uniqueKey":"stop.oneOf.2","typeLabel":"null"}],"uniqueKey":"stop","typeLabel":"string | string[] | null"},"store":{"oneOf":[{"type":"boolean","title":"Store","uniqueKey":"store.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Store","uniqueKey":"store.oneOf.1","typeLabel":"null"}],"uniqueKey":"store","typeLabel":"boolean | null"},"stream":{"oneOf":[{"type":"boolean","title":"Stream","uniqueKey":"stream.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Stream","uniqueKey":"stream.oneOf.1","typeLabel":"null"}],"uniqueKey":"stream","typeLabel":"boolean | null"},"stream_options":{"oneOf":[{"type":"object","title":"ChatCompletionStreamOptionsParam","description":"Options for streaming response. Only set this when you set `stream: true`.","properties":{"include_obfuscation":{"type":"boolean","title":"Include Obfuscation","uniqueKey":"stream_options.oneOf.0.include_obfuscation","typeLabel":"boolean"},"include_usage":{"type":"boolean","title":"Include Usage","uniqueKey":"stream_options.oneOf.0.include_usage","typeLabel":"boolean"}},"uniqueKey":"stream_options.oneOf.0","typeLabel":"ChatCompletionStreamOptionsParam · object"},{"type":"null","uniqueKey":"stream_options.oneOf.1","typeLabel":"null"}],"uniqueKey":"stream_options","typeLabel":"ChatCompletionStreamOptionsParam · object | null"},"temperature":{"oneOf":[{"type":"number","title":"Temperature","uniqueKey":"temperature.oneOf.0","typeLabel":"number"},{"type":"null","title":"Temperature","uniqueKey":"temperature.oneOf.1","typeLabel":"null"}],"uniqueKey":"temperature","typeLabel":"number | null"},"tool_choice":{"oneOf":[{"type":"string","title":"Tool Choice","enum":["none","auto","required"],"uniqueKey":"tool_choice.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"object","title":"ChatCompletionAllowedToolChoiceParam","description":"Constrains the tools available to the model to a pre-defined set.","required":["allowed_tools","type"],"properties":{"allowed_tools":{"properties":{"mode":{"type":"string","enum":["auto","required"],"title":"Mode","isRequired":true,"uniqueKey":"tool_choice.oneOf.1.allowed_tools.mode","typeLabel":"enum\u003cstring>"},"tools":{"items":{"additionalProperties":true,"type":"object","uniqueKey":"tool_choice.oneOf.1.allowed_tools.tools.items.[INDEX]","typeLabel":"object"},"type":"array","title":"Tools","isRequired":true,"uniqueKey":"tool_choice.oneOf.1.allowed_tools.tools","typeLabel":"Tools · object[]"}},"type":"object","required":["mode","tools"],"title":"ChatCompletionAllowedToolsParam","description":"Constrains the tools available to the model to a pre-defined set.","isRequired":true,"uniqueKey":"tool_choice.oneOf.1.allowed_tools","typeLabel":"ChatCompletionAllowedToolsParam · object"},"type":{"type":"string","const":"allowed_tools","title":"Type","isRequired":true,"uniqueKey":"tool_choice.oneOf.1.type","typeLabel":"string"}},"uniqueKey":"tool_choice.oneOf.1","typeLabel":"ChatCompletionAllowedToolChoiceParam · object"},{"type":"object","title":"ChatCompletionNamedToolChoiceParam","description":"Specifies a tool the model should use.\n\nUse to force the model to call a specific function.","required":["function","type"],"properties":{"function":{"properties":{"name":{"type":"string","title":"Name","isRequired":true,"uniqueKey":"tool_choice.oneOf.2.function.name","typeLabel":"string"}},"type":"object","required":["name"],"title":"Function","isRequired":true,"uniqueKey":"tool_choice.oneOf.2.function","typeLabel":"Function · object"},"type":{"type":"string","const":"function","title":"Type","isRequired":true,"uniqueKey":"tool_choice.oneOf.2.type","typeLabel":"string"}},"uniqueKey":"tool_choice.oneOf.2","typeLabel":"ChatCompletionNamedToolChoiceParam · object"},{"type":"object","title":"ChatCompletionNamedToolChoiceCustomParam","description":"Specifies a tool the model should use.\n\nUse to force the model to call a specific custom tool.","required":["custom","type"],"properties":{"custom":{"properties":{"name":{"type":"string","title":"Name","isRequired":true,"uniqueKey":"tool_choice.oneOf.3.custom.name","typeLabel":"string"}},"type":"object","required":["name"],"title":"Custom","isRequired":true,"uniqueKey":"tool_choice.oneOf.3.custom","typeLabel":"Custom · object"},"type":{"type":"string","const":"custom","title":"Type","isRequired":true,"uniqueKey":"tool_choice.oneOf.3.type","typeLabel":"string"}},"uniqueKey":"tool_choice.oneOf.3","typeLabel":"ChatCompletionNamedToolChoiceCustomParam · object"},{"type":"null","title":"Tool Choice","uniqueKey":"tool_choice.oneOf.4","typeLabel":"null"}],"uniqueKey":"tool_choice","typeLabel":"enum\u003cstring> | ChatCompletionAllowedToolChoiceParam · object | ChatCompletionNamedToolChoiceParam · object | ChatCompletionNamedToolChoiceCustomParam · object | null"},"tools":{"oneOf":[{"type":"array","items":{"properties":{"function":{"properties":{"name":{"type":"string","title":"Name","isRequired":true,"uniqueKey":"tools.oneOf.0.items.[INDEX].function.name","typeLabel":"string"},"description":{"type":"string","title":"Description","uniqueKey":"tools.oneOf.0.items.[INDEX].function.description","typeLabel":"string"},"parameters":{"additionalProperties":true,"type":"object","title":"Parameters","uniqueKey":"tools.oneOf.0.items.[INDEX].function.parameters","typeLabel":"Parameters · object"},"strict":{"oneOf":[{"type":"boolean","title":"Strict","uniqueKey":"tools.oneOf.0.items.[INDEX].function.strict.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Strict","uniqueKey":"tools.oneOf.0.items.[INDEX].function.strict.oneOf.1","typeLabel":"null"}],"uniqueKey":"tools.oneOf.0.items.[INDEX].function.strict","typeLabel":"boolean | null"}},"type":"object","required":["name"],"title":"FunctionDefinition","isRequired":true,"uniqueKey":"tools.oneOf.0.items.[INDEX].function","typeLabel":"FunctionDefinition · object"},"type":{"type":"string","const":"function","title":"Type","isRequired":true,"uniqueKey":"tools.oneOf.0.items.[INDEX].type","typeLabel":"string"}},"type":"object","required":["function","type"],"title":"ChatCompletionFunctionToolParam","description":"A function tool that can be used to generate a response.","uniqueKey":"tools.oneOf.0.items.[INDEX]","typeLabel":"ChatCompletionFunctionToolParam · object"},"title":"Tools","uniqueKey":"tools.oneOf.0","typeLabel":"ChatCompletionFunctionToolParam · object[]"},{"type":"null","title":"Tools","uniqueKey":"tools.oneOf.1","typeLabel":"null"}],"uniqueKey":"tools","typeLabel":"ChatCompletionFunctionToolParam · object[] | null"},"top_logprobs":{"oneOf":[{"type":"integer","title":"Top Logprobs","uniqueKey":"top_logprobs.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Top Logprobs","uniqueKey":"top_logprobs.oneOf.1","typeLabel":"null"}],"uniqueKey":"top_logprobs","typeLabel":"integer | null"},"top_p":{"oneOf":[{"type":"number","title":"Top P","uniqueKey":"top_p.oneOf.0","typeLabel":"number"},{"type":"null","title":"Top P","uniqueKey":"top_p.oneOf.1","typeLabel":"null"}],"uniqueKey":"top_p","typeLabel":"number | null"},"user":{"oneOf":[{"type":"string","title":"User","uniqueKey":"user.oneOf.0","typeLabel":"string"},{"type":"null","title":"User","uniqueKey":"user.oneOf.1","typeLabel":"null"}],"uniqueKey":"user","typeLabel":"string | null"},"web_search_options":{"oneOf":[{"type":"object","title":"WebSearchOptions","description":"This tool searches the web for relevant results to use in a response.\nLearn more about the [web search tool](https://platform.openai.com/docs/guides/tools-web-search?api-mode=chat).","properties":{"search_context_size":{"type":"string","enum":["low","medium","high"],"title":"Search Context Size","uniqueKey":"web_search_options.oneOf.0.search_context_size","typeLabel":"enum\u003cstring>"},"user_location":{"oneOf":[{"type":"object","title":"WebSearchOptionsUserLocation","description":"Approximate location parameters for the search.","required":["approximate","type"],"properties":{"approximate":{"properties":{"city":{"type":"string","title":"City","uniqueKey":"web_search_options.oneOf.0.user_location.oneOf.0.approximate.city","typeLabel":"string"},"country":{"type":"string","title":"Country","uniqueKey":"web_search_options.oneOf.0.user_location.oneOf.0.approximate.country","typeLabel":"string"},"region":{"type":"string","title":"Region","uniqueKey":"web_search_options.oneOf.0.user_location.oneOf.0.approximate.region","typeLabel":"string"},"timezone":{"type":"string","title":"Timezone","uniqueKey":"web_search_options.oneOf.0.user_location.oneOf.0.approximate.timezone","typeLabel":"string"}},"type":"object","title":"WebSearchOptionsUserLocationApproximate","description":"Approximate location parameters for the search.","isRequired":true,"uniqueKey":"web_search_options.oneOf.0.user_location.oneOf.0.approximate","typeLabel":"WebSearchOptionsUserLocationApproximate · object"},"type":{"type":"string","const":"approximate","title":"Type","isRequired":true,"uniqueKey":"web_search_options.oneOf.0.user_location.oneOf.0.type","typeLabel":"string"}},"uniqueKey":"web_search_options.oneOf.0.user_location.oneOf.0","typeLabel":"WebSearchOptionsUserLocation · object"},{"type":"null","uniqueKey":"web_search_options.oneOf.0.user_location.oneOf.1","typeLabel":"null"}],"uniqueKey":"web_search_options.oneOf.0.user_location","typeLabel":"WebSearchOptionsUserLocation · object | null"}},"uniqueKey":"web_search_options.oneOf.0","typeLabel":"WebSearchOptions · object"},{"type":"null","uniqueKey":"web_search_options.oneOf.1","typeLabel":"null"}],"uniqueKey":"web_search_options","typeLabel":"WebSearchOptions · object | null"}},"type":"object","required":["messages","model"],"title":"ChatCompletionRequest","description":"Corresponds to args to OpenAI `client.chat.completions.create(...)`","uniqueKey":"","typeLabel":"ChatCompletionRequest · object"},"examples":{"Example":{"title":"Example","value":{"messages":[{"content":"\u003cstring>","role":"developer","name":"\u003cstring>"}],"model":"\u003cstring>","audio":{"voice":"\u003cstring>"},"frequency_penalty":123,"functions":[{"name":"\u003cstring>","description":"\u003cstring>","parameters":{}}],"logit_bias":{},"logprobs":true,"max_completion_tokens":123,"max_tokens":123,"metadata":{},"modalities":[],"n":123,"parallel_tool_calls":true,"prediction":{"content":"\u003cstring>","type":"content"},"presence_penalty":123,"response_format":{"type":"text"},"seed":123,"stop":"\u003cstring>","store":true,"stream":true,"stream_options":{"include_obfuscation":true,"include_usage":true},"temperature":123,"tools":[{"function":{"name":"\u003cstring>","description":"\u003cstring>","parameters":{},"strict":true},"type":"function"}],"top_logprobs":123,"top_p":123,"user":"\u003cstring>","web_search_options":{"user_location":{"approximate":{"city":"\u003cstring>","country":"\u003cstring>","region":"\u003cstring>","timezone":"\u003cstring>"},"type":"approximate"}}}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"21dbe828-0d97-4f70-96c2-cff36a104154":{"description":"Successful Response","content":{"application/json":{"schema":{}}},"exampleType":"generated"},"1a47815f-d98e-4e5f-bfd6-8127d1bfa530":{"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":{"type":"string","title":"Message","isRequired":true,"uniqueKey":"detail.items.[INDEX].msg","typeLabel":"string"},"type":{"type":"string","title":"Error Type","isRequired":true,"uniqueKey":"detail.items.[INDEX].type","typeLabel":"string"},"input":{"oneOf":[{"title":"Input"}],"uniqueKey":"detail.items.[INDEX].input","typeLabel":"any"},"ctx":{"type":"object","title":"Context","uniqueKey":"detail.items.[INDEX].ctx","typeLabel":"Context · object"}},"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>","input":"\u003cunknown>","ctx":{}}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"3da5fabd-1784-4b15-a719-f6b0ba3b125e":{"HTTPBasic":{"type":"http","scheme":"basic","scopes":[]}},"5df34faa-532e-4131-900f-cf3213c675a0":{"HTTPBearer":{"type":"http","scheme":"bearer","scopes":[]}}},"servers":{},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"basic","scopes":[]},"schema":{"title":"Basic Auth","type":"object","description":"Basic authentication header of the form `Basic \u003cencoded-value>`, where `\u003cencoded-value>` is the base64-encoded string `username:password`.","isRequired":true,"properties":{"username":{"type":"string","uniqueKey":"username","isRequired":true,"typeLabel":"string","deprecated":false},"password":{"type":"string","uniqueKey":"password","isRequired":true,"typeLabel":"string","deprecated":false}},"additionalProperties":false,"deprecated":false},"schemeName":"HTTPBasic","name":"Authorization"}],"title":"HTTPBasic"},{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"HTTPBearer","name":"Authorization"}],"title":"HTTPBearer"}]},"originalFileLocation":"development/api-reference/openapi.json"},"subdomain":"ibm-8c0b5b62","siteName":"Agent Stack","title":"Create Chat Completion - Agent Stack","navMaps":{"firstHrefInVersion":{"stable":{"href":"/api-reference/openai/create-chat-completion","matchLevel":0},"development":{"href":"/api-reference/openai/create-chat-completion","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-09-03T00:21:40.884Z","originalFileLocation":"api-reference/openai/create-chat-completion.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=\"application-name\" content=\"Agent Stack\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/ibm-8c0b5b62/S3J3bk0sD_SosZ0N/_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/ibm-8c0b5b62/S3J3bk0sD_SosZ0N/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/ibm-8c0b5b62/S3J3bk0sD_SosZ0N/_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/ibm-8c0b5b62/S3J3bk0sD_SosZ0N/_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/ibm-8c0b5b62/S3J3bk0sD_SosZ0N/_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/ibm-8c0b5b62/S3J3bk0sD_SosZ0N/_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/ibm-8c0b5b62/S3J3bk0sD_SosZ0N/_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/ibm-8c0b5b62/S3J3bk0sD_SosZ0N/_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/ibm-8c0b5b62/S3J3bk0sD_SosZ0N/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create Chat Completion - Agent Stack\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Agent Stack\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://agentstack.beeai.dev/api-reference/openai/create-chat-completion\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://ibm-8c0b5b62.mintlify.app/_mintlify/api/og/v2?division=openai\u0026amp;title=Create+Chat+Completion\u0026amp;theme=c17ed13d629449bfd1da77d6\u0026amp;signature=2db10f52e70865128793979851cfe3d2e5c88063d3bc63185fd171876cb9eef5\">\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=\"Create Chat Completion - Agent Stack\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://ibm-8c0b5b62.mintlify.app/_mintlify/api/og/v2?division=openai\u0026amp;title=Create+Chat+Completion\u0026amp;theme=c17ed13d629449bfd1da77d6\u0026amp;signature=2db10f52e70865128793979851cfe3d2e5c88063d3bc63185fd171876cb9eef5\">\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/ibm-8c0b5b62/S3J3bk0sD_SosZ0N/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Agent Stack\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#000000\">\u003clink data-mint-head rel=\"canonical\" href=\"https://agentstack.beeai.dev/api-reference/openai/create-chat-completion\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/openai/create-chat-completion.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://agentstack.beeai.dev/#organization\",\"name\":\"Agent Stack\",\"url\":\"https://agentstack.beeai.dev\"},{\"@type\":\"WebSite\",\"@id\":\"https://agentstack.beeai.dev#website\",\"name\":\"Agent Stack\",\"url\":\"https://agentstack.beeai.dev\",\"publisher\":{\"@id\":\"https://agentstack.beeai.dev/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://agentstack.beeai.dev/api-reference/openai/create-chat-completion#webpage\",\"url\":\"https://agentstack.beeai.dev/api-reference/openai/create-chat-completion\",\"name\":\"Create Chat Completion\",\"dateModified\":\"2026-09-03T00:21:40.884Z\",\"isPartOf\":{\"@id\":\"https://agentstack.beeai.dev#website\"},\"breadcrumb\":{\"@id\":\"https://agentstack.beeai.dev/api-reference/openai/create-chat-completion#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://agentstack.beeai.dev/api-reference/openai/create-chat-completion#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Reference\",\"item\":\"https://agentstack.beeai.dev/stable/reference/cli-reference\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API Reference\",\"item\":\"https://agentstack.beeai.dev/api-reference/user/get-user\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create Chat Completion\",\"item\":\"https://agentstack.beeai.dev/api-reference/openai/create-chat-completion\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://agentstack.beeai.dev/api-reference/openai/create-chat-completion#apireference\",\"headline\":\"Create Chat Completion\",\"name\":\"Create Chat Completion\",\"url\":\"https://agentstack.beeai.dev/api-reference/openai/create-chat-completion\",\"mainEntityOfPage\":{\"@id\":\"https://agentstack.beeai.dev/api-reference/openai/create-chat-completion#webpage\"},\"dateModified\":\"2026-09-03T00:21:40.884Z\",\"publisher\":{\"@id\":\"https://agentstack.beeai.dev/#organization\"},\"isPartOf\":{\"@id\":\"https://agentstack.beeai.dev#website\"}}]}\u003c/script>","siteName":"Agent Stack","nav":{"global":null,"versions":[{"version":"stable","groups":[{"group":"Introduction","pages":[{"title":"Welcome","href":"/stable/introduction/welcome"},{"title":"Quickstart","href":"/stable/introduction/quickstart"}]},{"group":"Deploy Agents","pages":[{"title":"Wrap Your Existing Agents","href":"/stable/deploy-agents/wrap-existing-agents"},{"title":"Build New Agents","href":"/stable/deploy-agents/building-agents"},{"title":"Deploy Your Agents","href":"/stable/deploy-agents/deploy-your-agents"},{"title":"Connect A2A Agents","href":"/stable/deploy-agents/a2a-agents"}]},{"group":"Agent Integration","pages":[{"title":"Server SDK (Python)","href":"/stable/agent-integration/overview"},{"title":"Working with Messages","href":"/stable/agent-integration/messages"},{"title":"Multi-Turn Conversations","href":"/stable/agent-integration/multi-turn"},{"title":"Working with Files","href":"/stable/agent-integration/files"},{"title":"Customize Agent Details","href":"/stable/agent-integration/agent-details"},{"title":"LLM Proxy Service","href":"/stable/agent-integration/llm-proxy-service"},{"title":"Visualize Agent Trajectories","href":"/stable/agent-integration/trajectory"},{"title":"Add Citations to Agent Responses","href":"/stable/agent-integration/citations"},{"title":"Collect Input with Forms","href":"/stable/agent-integration/forms"},{"title":"Configure Agent Settings","href":"/stable/agent-integration/agent-settings"},{"title":"Manage Runtime Secrets","href":"/stable/agent-integration/secrets"},{"title":"Build RAG Pipelines","href":"/stable/agent-integration/rag"},{"title":"MCP integration","href":"/stable/agent-integration/mcp"},{"title":"Environment Variables","href":"/stable/agent-integration/env-variables"},{"title":"Handle Errors","href":"/stable/agent-integration/error"},{"title":"Approve Tool Calls","href":"/stable/agent-integration/tool-calls"},{"title":"Work with Canvas","href":"/stable/agent-integration/canvas"},{"title":"Monitoring \u0026 Observability","href":"/stable/agent-integration/observability"}]},{"group":"Reference","pages":[{"title":"CLI Reference","href":"/stable/reference/cli-reference"},{"group":"API Reference","pages":[{"group":"user","pages":[{"title":"Get User","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/user","href":"/api-reference/user/get-user"}]},{"group":"users","pages":[{"title":"Get Me","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/users/me","href":"/api-reference/users/get-me"}]},{"group":"a2a","pages":[{"title":"Get Agent Card","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/a2a/{provider_id}/.well-known/agent-card.json","href":"/api-reference/a2a/get-agent-card"},{"title":"A2A Proxy Jsonrpc Transport","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json post /api/v1/a2a/{provider_id}/","href":"/api-reference/a2a/a2a-proxy-jsonrpc-transport"},{"title":"A2A Proxy Jsonrpc Transport","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json post /api/v1/a2a/{provider_id}","href":"/api-reference/a2a/a2a-proxy-jsonrpc-transport-1"},{"title":"A2A Proxy Http Transport","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/a2a/{provider_id}/http/{path}","href":"/api-reference/a2a/a2a-proxy-http-transport"},{"title":"A2A Proxy Http Transport","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json put /api/v1/a2a/{provider_id}/http/{path}","href":"/api-reference/a2a/a2a-proxy-http-transport-1"},{"title":"A2A Proxy Http Transport","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json post /api/v1/a2a/{provider_id}/http/{path}","href":"/api-reference/a2a/a2a-proxy-http-transport-2"},{"title":"A2A Proxy Http Transport","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json delete /api/v1/a2a/{provider_id}/http/{path}","href":"/api-reference/a2a/a2a-proxy-http-transport-3"},{"title":"A2A Proxy Http Transport","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json options /api/v1/a2a/{provider_id}/http/{path}","href":"/api-reference/a2a/a2a-proxy-http-transport-4"},{"title":"A2A Proxy Http Transport","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json head /api/v1/a2a/{provider_id}/http/{path}","href":"/api-reference/a2a/a2a-proxy-http-transport-5"},{"title":"A2A Proxy Http Transport","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json patch /api/v1/a2a/{provider_id}/http/{path}","href":"/api-reference/a2a/a2a-proxy-http-transport-6"},{"title":"A2A Proxy Http Transport","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/a2a/{provider_id}/http","href":"/api-reference/a2a/a2a-proxy-http-transport-7"},{"title":"A2A Proxy Http Transport","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json put /api/v1/a2a/{provider_id}/http","href":"/api-reference/a2a/a2a-proxy-http-transport-8"},{"title":"A2A Proxy Http Transport","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json post /api/v1/a2a/{provider_id}/http","href":"/api-reference/a2a/a2a-proxy-http-transport-9"},{"title":"A2A Proxy Http Transport","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json delete /api/v1/a2a/{provider_id}/http","href":"/api-reference/a2a/a2a-proxy-http-transport-10"},{"title":"A2A Proxy Http Transport","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json options /api/v1/a2a/{provider_id}/http","href":"/api-reference/a2a/a2a-proxy-http-transport-11"},{"title":"A2A Proxy Http Transport","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json head /api/v1/a2a/{provider_id}/http","href":"/api-reference/a2a/a2a-proxy-http-transport-12"},{"title":"A2A Proxy Http Transport","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json patch /api/v1/a2a/{provider_id}/http","href":"/api-reference/a2a/a2a-proxy-http-transport-13"}]},{"group":"providers","pages":[{"title":"List Providers","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/providers","href":"/api-reference/providers/list-providers"},{"title":"Create Provider","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json post /api/v1/providers","href":"/api-reference/providers/create-provider"},{"title":"Get Provider","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/providers/{id}","href":"/api-reference/providers/get-provider"},{"title":"Delete Provider","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json delete /api/v1/providers/{id}","href":"/api-reference/providers/delete-provider"},{"title":"Patch Provider","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json patch /api/v1/providers/{id}","href":"/api-reference/providers/patch-provider"},{"title":"Preview Provider","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json post /api/v1/providers/preview","href":"/api-reference/providers/preview-provider"},{"title":"Get Provider By Location","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/providers/by-location/{location}","href":"/api-reference/providers/get-provider-by-location"},{"title":"Stream Logs","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/providers/{id}/logs","href":"/api-reference/providers/stream-logs"},{"title":"List Provider Variables","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/providers/{id}/variables","href":"/api-reference/providers/list-provider-variables"},{"title":"Update Provider Variables","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json put /api/v1/providers/{id}/variables","href":"/api-reference/providers/update-provider-variables"}]},{"group":"provider_discovery","pages":[{"title":"Create Provider Discovery","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json post /api/v1/providers/discovery","href":"/api-reference/provider_discovery/create-provider-discovery"},{"title":"Get Provider Discovery","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/providers/discovery/{id}","href":"/api-reference/provider_discovery/get-provider-discovery"}]},{"group":"provider_builds","pages":[{"title":"List Provider Builds","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/provider_builds","href":"/api-reference/provider_builds/list-provider-builds"},{"title":"Create Provider Build","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json post /api/v1/provider_builds","href":"/api-reference/provider_builds/create-provider-build"},{"title":"Preview Provider Build","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json post /api/v1/provider_builds/preview","href":"/api-reference/provider_builds/preview-provider-build"},{"title":"Get Provider Build","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/provider_builds/{id}","href":"/api-reference/provider_builds/get-provider-build"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json delete /api/v1/provider_builds/{id}","href":"/api-reference/provider_builds/delete"},{"title":"Stream Logs","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/provider_builds/{id}/logs","href":"/api-reference/provider_builds/stream-logs"}]},{"group":"model_providers","pages":[{"title":"List Model Providers","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/model_providers","href":"/api-reference/model_providers/list-model-providers"},{"title":"Create Model Provider","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json post /api/v1/model_providers","href":"/api-reference/model_providers/create-model-provider"},{"title":"Get Model Provider","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/model_providers/{model_provider_id}","href":"/api-reference/model_providers/get-model-provider"},{"title":"Delete Model Provider","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json delete /api/v1/model_providers/{model_provider_id}","href":"/api-reference/model_providers/delete-model-provider"},{"title":"Match","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json post /api/v1/model_providers/match","href":"/api-reference/model_providers/match"}]},{"group":"configurations","pages":[{"title":"Get Configuration","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/configurations/system","href":"/api-reference/configurations/get-configuration"},{"title":"Update Configuration","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json put /api/v1/configurations/system","href":"/api-reference/configurations/update-configuration"}]},{"group":"files","pages":[{"title":"List Files","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/files","href":"/api-reference/files/list-files"},{"title":"Upload File","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json post /api/v1/files","href":"/api-reference/files/upload-file"},{"title":"Get File","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/files/{file_id}","href":"/api-reference/files/get-file"},{"title":"Delete File","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json delete /api/v1/files/{file_id}","href":"/api-reference/files/delete-file"},{"title":"Get File Content","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/files/{file_id}/content","href":"/api-reference/files/get-file-content"},{"title":"Get Text File Content","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/files/{file_id}/text_content","href":"/api-reference/files/get-text-file-content"},{"title":"Get Text Extraction","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/files/{file_id}/extraction","href":"/api-reference/files/get-text-extraction"},{"title":"Create Text Extraction","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json post /api/v1/files/{file_id}/extraction","href":"/api-reference/files/create-text-extraction"},{"title":"Delete Text Extraction","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json delete /api/v1/files/{file_id}/extraction","href":"/api-reference/files/delete-text-extraction"}]},{"group":"variables","pages":[{"title":"List User Variables","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/variables","href":"/api-reference/variables/list-user-variables"},{"title":"Update User Variables","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json put /api/v1/variables","href":"/api-reference/variables/update-user-variables"}]},{"group":"contexts","pages":[{"title":"List Context","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/contexts","href":"/api-reference/contexts/list-context"},{"title":"Create Context","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json post /api/v1/contexts","href":"/api-reference/contexts/create-context"},{"title":"Get Context","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/contexts/{context_id}","href":"/api-reference/contexts/get-context"},{"title":"Update Context","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json put /api/v1/contexts/{context_id}","href":"/api-reference/contexts/update-context"},{"title":"Delete Context","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json delete /api/v1/contexts/{context_id}","href":"/api-reference/contexts/delete-context"},{"title":"Patch Context Metadata","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json patch /api/v1/contexts/{context_id}/metadata","href":"/api-reference/contexts/patch-context-metadata"},{"title":"Generate Context Token","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json post /api/v1/contexts/{context_id}/token","href":"/api-reference/contexts/generate-context-token"},{"title":"List Context History","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/contexts/{context_id}/history","href":"/api-reference/contexts/list-context-history"},{"title":"Add Context History Item","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json post /api/v1/contexts/{context_id}/history","href":"/api-reference/contexts/add-context-history-item"},{"title":"Delete Context History From Id","description":null,"deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json delete /api/v1/contexts/{context_id}/history","href":"/api-reference/contexts/delete-context-history-from-id"}]},{"group":"openai","pages":[{"title":"Create Chat Completion","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json post /api/v1/openai/chat/completions","href":"/api-reference/openai/create-chat-completion"},{"title":"Create Embedding","description":null,"deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json post /api/v1/openai/embeddings","href":"/api-reference/openai/create-embedding"},{"title":"List Models","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/openai/models","href":"/api-reference/openai/list-models"}]},{"group":"vector_stores","pages":[{"title":"Create Vector Store","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json post /api/v1/vector_stores","href":"/api-reference/vector_stores/create-vector-store"},{"title":"Get Vector Store","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/vector_stores/{vector_store_id}","href":"/api-reference/vector_stores/get-vector-store"},{"title":"Add Items","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json put /api/v1/vector_stores/{vector_store_id}","href":"/api-reference/vector_stores/add-items"},{"title":"Delete Vector Store","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json delete /api/v1/vector_stores/{vector_store_id}","href":"/api-reference/vector_stores/delete-vector-store"},{"title":"Search With Vector","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json post /api/v1/vector_stores/{vector_store_id}/search","href":"/api-reference/vector_stores/search-with-vector"},{"title":"List Documents","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/vector_stores/{vector_store_id}/documents","href":"/api-reference/vector_stores/list-documents"},{"title":"Delete Document","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json delete /api/v1/vector_stores/{vector_store_id}/documents/{document_id}","href":"/api-reference/vector_stores/delete-document"}]},{"group":"user_feedback","pages":[{"title":"List User Feedback","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/user_feedback","href":"/api-reference/user_feedback/list-user-feedback"},{"title":"User Feedback","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json post /api/v1/user_feedback","href":"/api-reference/user_feedback/user-feedback"}]},{"group":"connectors","pages":[{"title":"List Presets","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/connectors/presets","href":"/api-reference/connectors/list-presets"},{"title":"List Connectors","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/connectors","href":"/api-reference/connectors/list-connectors"},{"title":"Create Connector","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json post /api/v1/connectors","href":"/api-reference/connectors/create-connector"},{"title":"Read Connector","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/connectors/{connector_id}","href":"/api-reference/connectors/read-connector"},{"title":"Delete Connector","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json delete /api/v1/connectors/{connector_id}","href":"/api-reference/connectors/delete-connector"},{"title":"Connect Connector","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json post /api/v1/connectors/{connector_id}/connect","href":"/api-reference/connectors/connect-connector"},{"title":"Disconnect Connector","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json post /api/v1/connectors/{connector_id}/disconnect","href":"/api-reference/connectors/disconnect-connector"},{"title":"Mcp","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/connectors/{connector_id}/mcp","href":"/api-reference/connectors/mcp"},{"title":"Mcp","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json post /api/v1/connectors/{connector_id}/mcp","href":"/api-reference/connectors/mcp-1"},{"title":"Oauth Callback","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/connectors/oauth/callback","href":"/api-reference/connectors/oauth-callback"}]},{"group":"auth","pages":[{"title":"Protected Resource Metadata","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /.well-known/oauth-protected-resource/{resource}","href":"/api-reference/auth/protected-resource-metadata"},{"title":"Jwks","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /.well-known/jwks","href":"/api-reference/auth/jwks"}]}]}]},{"group":"Deploy Agent Stack","pages":[{"title":"Agent Stack Deployment Guide","href":"/stable/deploy-agent-stack/deployment-guide"},{"title":"Webhooks","href":"/stable/deploy-agent-stack/webhooks"},{"title":"Connect CLI to Remote Server","href":"/stable/deploy-agent-stack/authenticate-cli-to-server"}]},{"group":"Custom UI Integration","pages":[{"title":"Getting Started","href":"/stable/custom-ui/getting-started"},{"title":"Custom UI Architecture Guide","href":"/stable/custom-ui/architecture-guide"},{"title":"A2A Client Integration","href":"/stable/custom-ui/a2a-client"},{"title":"Agent Requirements","href":"/stable/custom-ui/agent-requirements"},{"title":"Platform API Client","href":"/stable/custom-ui/platform-api-client"},{"title":"Error Handling","href":"/stable/custom-ui/error-handling"},{"title":"Agent Responses","href":"/stable/custom-ui/agent-responses"},{"title":"User Messages","href":"/stable/custom-ui/user-messages"},{"title":"Permissions and Tokens","href":"/stable/custom-ui/permissions-and-tokens"}]},{"group":"Experimental","pages":[{"title":"MCP Connectors","href":"/stable/experimental/connectors"}]},{"group":"Community","pages":[{"title":"Contribute","href":"/stable/community/contribute"}]}]},{"version":"development","groups":[{"group":"Introduction","pages":[{"title":"Welcome","href":"/development/introduction/welcome"},{"title":"Quickstart","href":"/development/introduction/quickstart"}]},{"group":"Deploy Agents","pages":[{"title":"Wrap Your Existing Agents","href":"/development/deploy-agents/wrap-existing-agents"},{"title":"Build New Agents","href":"/development/deploy-agents/building-agents"},{"title":"Deploy Your Agents","href":"/development/deploy-agents/deploy-your-agents"},{"title":"Connect A2A Agents","href":"/development/deploy-agents/a2a-agents"}]},{"group":"Agent Integration","pages":[{"title":"Server SDK (Python)","href":"/development/agent-integration/overview"},{"title":"Working with Messages","href":"/development/agent-integration/messages"},{"title":"Multi-Turn Conversations","href":"/development/agent-integration/multi-turn"},{"title":"Working with Files","href":"/development/agent-integration/files"},{"title":"Customize Agent Details","href":"/development/agent-integration/agent-details"},{"title":"LLM Proxy Service","href":"/development/agent-integration/llm-proxy-service"},{"title":"Visualize Agent Trajectories","href":"/development/agent-integration/trajectory"},{"title":"Add Citations to Agent Responses","href":"/development/agent-integration/citations"},{"title":"Collect Input with Forms","href":"/development/agent-integration/forms"},{"title":"Configure Agent Settings","href":"/development/agent-integration/agent-settings"},{"title":"Manage Runtime Secrets","href":"/development/agent-integration/secrets"},{"title":"Build RAG Pipelines","href":"/development/agent-integration/rag"},{"title":"MCP integration","href":"/development/agent-integration/mcp"},{"title":"Environment Variables","href":"/development/agent-integration/env-variables"},{"title":"Handle Errors","href":"/development/agent-integration/error"},{"title":"Approve Tool Calls","href":"/development/agent-integration/tool-calls"},{"title":"Work with Canvas","href":"/development/agent-integration/canvas"},{"title":"Monitoring \u0026 Observability","href":"/development/agent-integration/observability"}]},{"group":"Reference","pages":[{"title":"CLI Reference","href":"/development/reference/cli-reference"},{"title":"Changelog","href":"/development/reference/changelog"},{"group":"API Reference","pages":[{"group":"user","pages":[{"title":"Get User","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/user","href":"/api-reference/user/get-user"}]},{"group":"users","pages":[{"title":"Get Me","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/users/me","href":"/api-reference/users/get-me"}]},{"group":"a2a","pages":[{"title":"Get Agent Card","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/a2a/{provider_id}/.well-known/agent-card.json","href":"/api-reference/a2a/get-agent-card"},{"title":"A2A Proxy Jsonrpc Transport","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json post /api/v1/a2a/{provider_id}/","href":"/api-reference/a2a/a2a-proxy-jsonrpc-transport"},{"title":"A2A Proxy Jsonrpc Transport","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json post /api/v1/a2a/{provider_id}","href":"/api-reference/a2a/a2a-proxy-jsonrpc-transport-1"},{"title":"A2A Proxy Http Transport","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/a2a/{provider_id}/http/{path}","href":"/api-reference/a2a/a2a-proxy-http-transport"},{"title":"A2A Proxy Http Transport","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json put /api/v1/a2a/{provider_id}/http/{path}","href":"/api-reference/a2a/a2a-proxy-http-transport-1"},{"title":"A2A Proxy Http Transport","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json post /api/v1/a2a/{provider_id}/http/{path}","href":"/api-reference/a2a/a2a-proxy-http-transport-2"},{"title":"A2A Proxy Http Transport","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json delete /api/v1/a2a/{provider_id}/http/{path}","href":"/api-reference/a2a/a2a-proxy-http-transport-3"},{"title":"A2A Proxy Http Transport","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json options /api/v1/a2a/{provider_id}/http/{path}","href":"/api-reference/a2a/a2a-proxy-http-transport-4"},{"title":"A2A Proxy Http Transport","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json head /api/v1/a2a/{provider_id}/http/{path}","href":"/api-reference/a2a/a2a-proxy-http-transport-5"},{"title":"A2A Proxy Http Transport","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json patch /api/v1/a2a/{provider_id}/http/{path}","href":"/api-reference/a2a/a2a-proxy-http-transport-6"},{"title":"A2A Proxy Http Transport","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/a2a/{provider_id}/http","href":"/api-reference/a2a/a2a-proxy-http-transport-7"},{"title":"A2A Proxy Http Transport","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json put /api/v1/a2a/{provider_id}/http","href":"/api-reference/a2a/a2a-proxy-http-transport-8"},{"title":"A2A Proxy Http Transport","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json post /api/v1/a2a/{provider_id}/http","href":"/api-reference/a2a/a2a-proxy-http-transport-9"},{"title":"A2A Proxy Http Transport","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json delete /api/v1/a2a/{provider_id}/http","href":"/api-reference/a2a/a2a-proxy-http-transport-10"},{"title":"A2A Proxy Http Transport","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json options /api/v1/a2a/{provider_id}/http","href":"/api-reference/a2a/a2a-proxy-http-transport-11"},{"title":"A2A Proxy Http Transport","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json head /api/v1/a2a/{provider_id}/http","href":"/api-reference/a2a/a2a-proxy-http-transport-12"},{"title":"A2A Proxy Http Transport","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json patch /api/v1/a2a/{provider_id}/http","href":"/api-reference/a2a/a2a-proxy-http-transport-13"}]},{"group":"providers","pages":[{"title":"List Providers","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/providers","href":"/api-reference/providers/list-providers"},{"title":"Create Provider","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json post /api/v1/providers","href":"/api-reference/providers/create-provider"},{"title":"Get Provider","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/providers/{id}","href":"/api-reference/providers/get-provider"},{"title":"Delete Provider","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json delete /api/v1/providers/{id}","href":"/api-reference/providers/delete-provider"},{"title":"Patch Provider","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json patch /api/v1/providers/{id}","href":"/api-reference/providers/patch-provider"},{"title":"Preview Provider","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json post /api/v1/providers/preview","href":"/api-reference/providers/preview-provider"},{"title":"Get Provider By Location","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/providers/by-location/{location}","href":"/api-reference/providers/get-provider-by-location"},{"title":"Stream Logs","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/providers/{id}/logs","href":"/api-reference/providers/stream-logs"},{"title":"List Provider Variables","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/providers/{id}/variables","href":"/api-reference/providers/list-provider-variables"},{"title":"Update Provider Variables","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json put /api/v1/providers/{id}/variables","href":"/api-reference/providers/update-provider-variables"}]},{"group":"provider_discovery","pages":[{"title":"Create Provider Discovery","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json post /api/v1/providers/discovery","href":"/api-reference/provider_discovery/create-provider-discovery"},{"title":"Get Provider Discovery","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/providers/discovery/{id}","href":"/api-reference/provider_discovery/get-provider-discovery"}]},{"group":"provider_builds","pages":[{"title":"List Provider Builds","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/provider_builds","href":"/api-reference/provider_builds/list-provider-builds"},{"title":"Create Provider Build","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json post /api/v1/provider_builds","href":"/api-reference/provider_builds/create-provider-build"},{"title":"Preview Provider Build","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json post /api/v1/provider_builds/preview","href":"/api-reference/provider_builds/preview-provider-build"},{"title":"Get Provider Build","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/provider_builds/{id}","href":"/api-reference/provider_builds/get-provider-build"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json delete /api/v1/provider_builds/{id}","href":"/api-reference/provider_builds/delete"},{"title":"Stream Logs","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/provider_builds/{id}/logs","href":"/api-reference/provider_builds/stream-logs"}]},{"group":"model_providers","pages":[{"title":"List Model Providers","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/model_providers","href":"/api-reference/model_providers/list-model-providers"},{"title":"Create Model Provider","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json post /api/v1/model_providers","href":"/api-reference/model_providers/create-model-provider"},{"title":"Get Model Provider","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/model_providers/{model_provider_id}","href":"/api-reference/model_providers/get-model-provider"},{"title":"Delete Model Provider","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json delete /api/v1/model_providers/{model_provider_id}","href":"/api-reference/model_providers/delete-model-provider"},{"title":"Match","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json post /api/v1/model_providers/match","href":"/api-reference/model_providers/match"}]},{"group":"configurations","pages":[{"title":"Get Configuration","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/configurations/system","href":"/api-reference/configurations/get-configuration"},{"title":"Update Configuration","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json put /api/v1/configurations/system","href":"/api-reference/configurations/update-configuration"}]},{"group":"files","pages":[{"title":"List Files","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/files","href":"/api-reference/files/list-files"},{"title":"Upload File","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json post /api/v1/files","href":"/api-reference/files/upload-file"},{"title":"Get File","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/files/{file_id}","href":"/api-reference/files/get-file"},{"title":"Delete File","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json delete /api/v1/files/{file_id}","href":"/api-reference/files/delete-file"},{"title":"Get File Content","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/files/{file_id}/content","href":"/api-reference/files/get-file-content"},{"title":"Get Text File Content","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/files/{file_id}/text_content","href":"/api-reference/files/get-text-file-content"},{"title":"Get Text Extraction","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/files/{file_id}/extraction","href":"/api-reference/files/get-text-extraction"},{"title":"Create Text Extraction","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json post /api/v1/files/{file_id}/extraction","href":"/api-reference/files/create-text-extraction"},{"title":"Delete Text Extraction","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json delete /api/v1/files/{file_id}/extraction","href":"/api-reference/files/delete-text-extraction"}]},{"group":"variables","pages":[{"title":"List User Variables","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/variables","href":"/api-reference/variables/list-user-variables"},{"title":"Update User Variables","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json put /api/v1/variables","href":"/api-reference/variables/update-user-variables"}]},{"group":"contexts","pages":[{"title":"List Context","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/contexts","href":"/api-reference/contexts/list-context"},{"title":"Create Context","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json post /api/v1/contexts","href":"/api-reference/contexts/create-context"},{"title":"Get Context","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/contexts/{context_id}","href":"/api-reference/contexts/get-context"},{"title":"Update Context","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json put /api/v1/contexts/{context_id}","href":"/api-reference/contexts/update-context"},{"title":"Delete Context","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json delete /api/v1/contexts/{context_id}","href":"/api-reference/contexts/delete-context"},{"title":"Patch Context Metadata","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json patch /api/v1/contexts/{context_id}/metadata","href":"/api-reference/contexts/patch-context-metadata"},{"title":"Generate Context Token","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json post /api/v1/contexts/{context_id}/token","href":"/api-reference/contexts/generate-context-token"},{"title":"List Context History","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/contexts/{context_id}/history","href":"/api-reference/contexts/list-context-history"},{"title":"Add Context History Item","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json post /api/v1/contexts/{context_id}/history","href":"/api-reference/contexts/add-context-history-item"},{"title":"Delete Context History From Id","description":null,"deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json delete /api/v1/contexts/{context_id}/history","href":"/api-reference/contexts/delete-context-history-from-id"}]},{"group":"openai","pages":[{"title":"Create Chat Completion","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json post /api/v1/openai/chat/completions","href":"/api-reference/openai/create-chat-completion"},{"title":"Create Embedding","description":null,"deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json post /api/v1/openai/embeddings","href":"/api-reference/openai/create-embedding"},{"title":"List Models","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/openai/models","href":"/api-reference/openai/list-models"}]},{"group":"vector_stores","pages":[{"title":"Create Vector Store","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json post /api/v1/vector_stores","href":"/api-reference/vector_stores/create-vector-store"},{"title":"Get Vector Store","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/vector_stores/{vector_store_id}","href":"/api-reference/vector_stores/get-vector-store"},{"title":"Add Items","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json put /api/v1/vector_stores/{vector_store_id}","href":"/api-reference/vector_stores/add-items"},{"title":"Delete Vector Store","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json delete /api/v1/vector_stores/{vector_store_id}","href":"/api-reference/vector_stores/delete-vector-store"},{"title":"Search With Vector","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json post /api/v1/vector_stores/{vector_store_id}/search","href":"/api-reference/vector_stores/search-with-vector"},{"title":"List Documents","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/vector_stores/{vector_store_id}/documents","href":"/api-reference/vector_stores/list-documents"},{"title":"Delete Document","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json delete /api/v1/vector_stores/{vector_store_id}/documents/{document_id}","href":"/api-reference/vector_stores/delete-document"}]},{"group":"user_feedback","pages":[{"title":"List User Feedback","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/user_feedback","href":"/api-reference/user_feedback/list-user-feedback"},{"title":"User Feedback","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json post /api/v1/user_feedback","href":"/api-reference/user_feedback/user-feedback"}]},{"group":"connectors","pages":[{"title":"List Presets","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/connectors/presets","href":"/api-reference/connectors/list-presets"},{"title":"List Connectors","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/connectors","href":"/api-reference/connectors/list-connectors"},{"title":"Create Connector","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json post /api/v1/connectors","href":"/api-reference/connectors/create-connector"},{"title":"Read Connector","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/connectors/{connector_id}","href":"/api-reference/connectors/read-connector"},{"title":"Delete Connector","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json delete /api/v1/connectors/{connector_id}","href":"/api-reference/connectors/delete-connector"},{"title":"Connect Connector","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json post /api/v1/connectors/{connector_id}/connect","href":"/api-reference/connectors/connect-connector"},{"title":"Disconnect Connector","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json post /api/v1/connectors/{connector_id}/disconnect","href":"/api-reference/connectors/disconnect-connector"},{"title":"Mcp","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/connectors/{connector_id}/mcp","href":"/api-reference/connectors/mcp"},{"title":"Mcp","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json post /api/v1/connectors/{connector_id}/mcp","href":"/api-reference/connectors/mcp-1"},{"title":"Oauth Callback","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /api/v1/connectors/oauth/callback","href":"/api-reference/connectors/oauth-callback"}]},{"group":"auth","pages":[{"title":"Protected Resource Metadata","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /.well-known/oauth-protected-resource/{resource}","href":"/api-reference/auth/protected-resource-metadata"},{"title":"Jwks","deprecated":null,"version":null,"openapi":"/development/api-reference/openapi.json get /.well-known/jwks","href":"/api-reference/auth/jwks"}]}]}]},{"group":"Deploy Agent Stack","pages":[{"title":"Agent Stack Deployment Guide","href":"/development/deploy-agent-stack/deployment-guide"},{"title":"Webhooks","href":"/development/deploy-agent-stack/webhooks"},{"title":"Connect CLI to Remote Server","href":"/development/deploy-agent-stack/authenticate-cli-to-server"}]},{"group":"Custom UI Integration","pages":[{"title":"Getting Started","href":"/development/custom-ui/getting-started"},{"title":"Custom UI Architecture Guide","href":"/development/custom-ui/architecture-guide"},{"title":"A2A Client Integration","href":"/development/custom-ui/a2a-client"},{"title":"Agent Requirements","href":"/development/custom-ui/agent-requirements"},{"title":"Platform API Client","href":"/development/custom-ui/platform-api-client"},{"title":"Error Handling","href":"/development/custom-ui/error-handling"},{"title":"Agent Responses","href":"/development/custom-ui/agent-responses"},{"title":"User Messages","href":"/development/custom-ui/user-messages"},{"title":"Permissions and Tokens","href":"/development/custom-ui/permissions-and-tokens"}]},{"group":"Experimental","pages":[{"title":"MCP Connectors","href":"/development/experimental/connectors"}]},{"group":"Community","pages":[{"title":"Contribute","href":"/development/community/contribute"}]}]}]},"title":"Create Chat Completion - Agent Stack","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-rfhihCWU.js","utils-BmH1XFxk.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BcNsxPKB.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BAES3tkd.js","snippetPresets-DCMQBKLP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-D5fEM6aW.js","ApiExamples-D6l_bzE9.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BOktbnNh.js","shallow-BCs8SgM7.js","getApiPlaygroundDisplay-DEmW5bJB.js","CodeSnippet-CpZOpB9C.js","CodeSnippets-BOBDqibl.js","getPastedJson-DH2JBvmr.js","icon-BBJH-kKh.js","MethodPill-D2Sd5NLC.js","DuplicateIcon-CGgfL2qN.js","createIcon-BKudBBzi.js","DynamicMarkdown-85clUA0i.js","SectionHeading-D0JiMgDx.js","axios-vUo_bRtp.js","Markdown-Cfiy0xZO.js","clsx-rL8ZCCw4.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-aeztFa9U.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BywkCr5C.js"]}