GET

/v1/schemas/azure/chat/chat%2Fcompletions

kind inputactivity chathash 2673dae3…extracted Oct 7, 2026version currentsource upstream spec ↗

Request body

34 properties · 2 required · 33 $defs
propertytypedescriptionconstraints
messages*OpenAI.ChatCompletionRequestMessage[]A list of messages comprising the conversation so far. Depending on the model you use, different message types (modalities) are supported, like text, images, and audio.items ≥ 1
model*stringModel ID used to generate the response, like `gpt-4o` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](/docs/models) to browse and compare available models.
metadataOpenAI.MetadataSet of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characte…nullable
top_logprobsintegernullable
temperaturenumbernullable
top_pnumbernullable
userstringA unique identifier representing your end-user, which can help to monitor and detect abuse.deprecated
safety_identifierstringA stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email…length ≤ 64
prompt_cache_keystringUsed by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](/docs/guides/prompt-caching).
prompt_cache_retentionenumin_memory | 24h · nullable
modalitiesenum[]Output types that you would like the model to generate. Most models are capable of generating text, which is the default: `["text"]` The `gpt-4o-audio-preview` model can also be used to [generate audio](/docs/guides/audio). To request that this model generate both text and audio responses, you can use: `["text", "audio"]`nullable
verbosityenumConstrains the verbosity of the model's response. Lower values will result in more concise responses, while higher values will result in more verbose responses. Currently supported values are `low`, `medium`, and `high`.low | medium | high · nullable
reasoning_effortenumConstrains effort on reasoning for [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response. - `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1. - All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`. - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort. - `xhigh` is supported for all models after `gpt-5.1-codex-max`.none | minimal | low | medium | high | xhigh · nullable
max_completion_tokensintegerAn upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens.nullable
frequency_penaltynumberNumber between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.nullable
presence_penaltynumberNumber between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.nullable
response_formatOpenAI.CreateChatCompletionRequestResponseFormatAn object specifying the format that the model must output. Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema. Learn more in the [Structured Outputs guide](/docs…
audioOpenAI.CreateChatCompletionRequestAudioParameters for audio output. Required when audio output is requested with `modalities: ["audio"]`.nullable
storebooleanWhether or not to store the output of this chat completion request for use in model distillation or evals products.nullable
streambooleanIf set to true, the model response data will be streamed to the client as it is generated using server-sent events.nullable
stopstring | string[]Not supported with latest reasoning models `o3` and `o4-mini`. Up to 4 sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence.nullable
logit_biasobjectModify the likelihood of specified tokens appearing in the completion. Accepts a JSON object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token.nullable
logprobsbooleanWhether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the `content` of `message`.nullable
max_tokensintegerThe maximum number of tokens that can be generated in the chat completion. This value can be used to control costs for text generated via API. This value is now deprecated in favor of `max_completion_tokens`, and is not compatible with o1 series models.nullable · deprecated
nintegerHow many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep `n` as `1` to minimize costs.nullable
predictionOpenAI.PredictionContentStatic predicted output content, such as the content of a text file that is being regenerated.nullable
seedintegerThis feature is in Beta. If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same `seed` and parameters should return the same result. Determinism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend.format: int64 · nullable · deprecated
stream_optionsOpenAI.ChatCompletionStreamOptionsOptions for streaming response. Only set this when you set `stream: true`.nullable
toolsOpenAI.ChatCompletionTool | OpenAI.CustomToolChatCompletions[]A list of tools the model may call. You can provide either [custom tools](/docs/guides/function-calling#custom-tools) or [function tools](/docs/guides/function-calling).
tool_choiceenum | Allowed tools | Function tool cho…Controls which (if any) tool is called by the model. `none` means the model will not call any tool and instead generates a message. `auto` means the model can pick between generating a message or calling one or more tools. `required` means the model must call …
parallel_tool_callsbooleanWhether to enable [parallel function calling](/docs/guides/function-calling#configuring-parallel-function-calling) during tool use.default: true
function_callenum | objectDeprecated in favor of `tool_choice`. Controls which (if any) function is called by the model. `none` means the model will not call a function and instead generates a message. `auto` means the model can pick between generating a message or calling a function. …deprecated
functionsOpenAI.ChatCompletionFunctions[]Deprecated in favor of `tools`. A list of functions the model may generate JSON inputs for.items ≥ 1 · items ≤ 128 · deprecated
user_security_contextAzureUserSecurityContextUser security context contains several parameters that describe the application itself, and the end user that interacts with the application. These fields assist your security operations teams to investigate and mitigate security incidents by providing a compr…

Validate a payload

before you spend tokens
shell
$ curl -X POST https://modelschemas.com/v1/validate \
    -d '{"provider":"azure","endpointId":"chat/completions","payload":{…}}'
→ {"valid": false, "errors": [{"path": "#", "keyword": "required", …}]}