/v1/schemas/azure/chat/chat/completions
| field | recorded source |
|---|---|
| schema | Source linked above. upstream-spec Source trace9fade08c5d30751828e67fecca63b3800567c802d1d6c4c91bba3d193843f7a8{
"fetchedAt": 1791349936,
"extractorVersion": "1",
"verifiedAt": null
} |
Request body
34 properties · 2 required · 33 $defs| property | type | description | constraints |
|---|---|---|---|
| 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* | string | Model 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. | |
| metadata | OpenAI.Metadata | Set 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_logprobs | integer | nullable | |
| temperature | number | nullable | |
| top_p | number | nullable | |
| user | string | A unique identifier representing your end-user, which can help to monitor and detect abuse. | deprecated |
| safety_identifier | string | A 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_key | string | Used 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_retention | enum | in_memory | 24h · nullable | |
| modalities | enum[] | 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 |
| verbosity | enum | Constrains 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_effort | enum | Constrains 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_tokens | integer | An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens. | nullable |
| frequency_penalty | number | Number 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_penalty | number | Number 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_format | OpenAI.CreateChatCompletionRequestResponseFormat | An 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… | |
| audio | OpenAI.CreateChatCompletionRequestAudio | Parameters for audio output. Required when audio output is requested with `modalities: ["audio"]`. | nullable |
| store | boolean | Whether or not to store the output of this chat completion request for use in model distillation or evals products. | nullable |
| stream | boolean | If set to true, the model response data will be streamed to the client as it is generated using server-sent events. | nullable |
| stop | string | 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_bias | object | Modify 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 |
| logprobs | boolean | Whether 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_tokens | integer | The 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 |
| n | integer | How 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 |
| prediction | OpenAI.PredictionContent | Static predicted output content, such as the content of a text file that is being regenerated. | nullable |
| seed | integer | This 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_options | OpenAI.ChatCompletionStreamOptions | Options for streaming response. Only set this when you set `stream: true`. | nullable |
| tools | OpenAI.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_choice | enum | Allowed tools | Function tool choice | … | 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_calls | boolean | Whether to enable [parallel function calling](/docs/guides/function-calling#configuring-parallel-function-calling) during tool use. | default: true |
| function_call | enum | object | Deprecated 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 |
| functions | OpenAI.ChatCompletionFunctions[] | Deprecated in favor of `tools`. A list of functions the model may generate JSON inputs for. | items ≥ 1 · items ≤ 128 · deprecated |
| user_security_context | AzureUserSecurityContext | User 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… |
Types
33 $defsAzureUserSecurityContextobject
User 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…
| application_name | string | The name of the application. Sensitive personal information should not be included in this field. | |
| end_user_id | string | This identifier is the Microsoft Entra ID (formerly Azure Active Directory) user object ID used to authenticate end-users within the generative AI application. Sensitive personal information should not be included in this field. | |
| end_user_tenant_id | string | The Microsoft 365 tenant ID the end user belongs to. It's required when the generative AI application is multitenant. | |
| source_ip | string | Captures the original client's IP address. |
OpenAI.ChatCompletionAllowedToolsobject
Constrains the tools available to the model to a pre-defined set.
| mode* | enum | Constrains the tools available to the model to a pre-defined set. `auto` allows the model to pick from among the allowed tools and generate a message. `required` requires the model to call one or more of the allowed tools. | auto | required |
| tools* | object[] | A list of tool definitions that the model should be allowed to call. For the Chat Completions API, the list of tool definitions might look like: ```json [ { "type": "function", "function": { "name": "get_weather" } }, { "type": "function", "function": { "name"… |
OpenAI.ChatCompletionAllowedToolsChoiceobject
Constrains the tools available to the model to a pre-defined set.
| type* | enum | Allowed tool configuration type. Always `allowed_tools`. | allowed_tools |
| allowed_tools* | OpenAI.ChatCompletionAllowedTools | Constrains the tools available to the model to a pre-defined set. |
OpenAI.ChatCompletionFunctionCallOptionobject
Specifying a particular function via `{"name": "my_function"}` forces the model to call that function.
| name* | string | The name of the function to call. |
OpenAI.ChatCompletionFunctionsobject
| description | string | A description of what the function does, used by the model to choose when and how to call the function. | |
| name* | string | The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. | |
| parameters | OpenAI.FunctionParameters | The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitti… |
OpenAI.ChatCompletionNamedToolChoiceobject
Specifies a tool the model should use. Use to force the model to call a specific function.
| type* | enum | For function calling, the type is always `function`. | function |
| function* | OpenAI.ChatCompletionNamedToolChoiceFunction |
OpenAI.ChatCompletionNamedToolChoiceCustomobject
Specifies a tool the model should use. Use to force the model to call a specific custom tool.
| type* | enum | For custom tool calling, the type is always `custom`. | custom |
| custom* | OpenAI.ChatCompletionNamedToolChoiceCustomCustom |
OpenAI.ChatCompletionNamedToolChoiceCustomCustomobject
| name* | string |
OpenAI.ChatCompletionNamedToolChoiceFunctionobject
| name* | string |
OpenAI.ChatCompletionRequestMessageobject
| role* | string | enum |
OpenAI.ChatCompletionRequestMessageContentPartTextobject
| type* | enum | The type of the content part. | text |
| text* | string | The text content. |
OpenAI.ChatCompletionRequestMessageTypestring | enum
OpenAI.ChatCompletionStreamOptionsobject
Options for streaming response. Only set this when you set `stream: true`.
| include_usage | boolean | If set, an additional chunk will be streamed before the `data: [DONE]` message. The `usage` field on this chunk shows the token usage statistics for the entire request, and the `choices` field will always be an empty array. All other chunks will also include a… | |
| include_obfuscation | boolean | When true, stream obfuscation will be enabled. Stream obfuscation adds random characters to an `obfuscation` field on streaming delta events to normalize payload sizes as a mitigation to certain side-channel attacks. These obfuscation fields are included by de… |
OpenAI.ChatCompletionToolobject
A function tool that can be used to generate a response.
| type* | enum | The type of the tool. Currently, only `function` is supported. | function |
| function* | OpenAI.FunctionObject |
OpenAI.ChatCompletionToolChoiceOptionenum | Allowed tools | Function tool choice | …
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 …
OpenAI.CreateChatCompletionRequestAudioobject
| voice* | string | enum | object | A built-in voice name or a custom voice reference. | |
| format* | enum | wav | aac | mp3 | flac | opus | pcm16 |
OpenAI.CreateChatCompletionRequestResponseFormatobject
An 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…
| type* | string | enum |
OpenAI.CreateChatCompletionRequestResponseFormatTypestring | enum
OpenAI.CustomToolChatCompletionsobject
A custom tool that processes input using a specified format.
| type* | enum | The type of the custom tool. Always `custom`. | custom |
| custom* | OpenAI.CustomToolChatCompletionsCustom | Properties of the custom tool. |
OpenAI.CustomToolChatCompletionsCustomobject
| name* | string | ||
| description | string | ||
| format | object | object |
OpenAI.CustomToolChatCompletionsCustomFormatGrammarobject
| type* | enum | grammar | |
| grammar* | OpenAI.CustomToolChatCompletionsCustomFormatGrammarGrammar |
OpenAI.CustomToolChatCompletionsCustomFormatGrammarGrammarobject
| definition* | string | ||
| syntax* | enum | lark | regex |
OpenAI.CustomToolChatCompletionsCustomFormatTextobject
| type* | enum | text |
OpenAI.FunctionObjectobject
| description | string | A description of what the function does, used by the model to choose when and how to call the function. | |
| name* | string | The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. | |
| parameters | OpenAI.FunctionParameters | The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitti… | |
| strict | boolean | nullable |
OpenAI.FunctionParametersobject
The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitti…
OpenAI.Metadataobject
Set 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…
OpenAI.PredictionContentobject
Static predicted output content, such as the content of a text file that is being regenerated.
| type* | enum | The type of the predicted content you want to provide. This type is currently always `content`. | content |
| content* | string | OpenAI.ChatCompletionRequestMessageContentPartText[] | The content that should be matched when generating a model response. If generated tokens would match this content, the entire model response can be returned much more quickly. |
OpenAI.ReasoningEffortenum
Constrains 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
OpenAI.ResponseModalitiesenum[]
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
OpenAI.StopConfigurationstring | 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.
OpenAI.Verbosityenum
Constrains 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
OpenAI.VoiceIdsOrCustomVoicestring | enum | object
A built-in voice name or a custom voice reference.
Validate a payload
before you spend tokens$ curl -X POST https://modelschemas.com/v1/validate \
-d '{"provider":"azure","endpointId":"chat/completions","payload":{…}}'
→ {"valid": false, "errors": [{"path": "#", "keyword": "required", …}]}