GET
/v1/schemas/azure/chat/responses
Accept:
Request body
28 properties · 0 required · 28 $defs| property | type | description | constraints |
|---|---|---|---|
| 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 | This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use `prompt_cache_key` instead to maintain caching optimizations. A stable identifier for your end-users. Used to boost cache hit rates by better bucketing similar requests and to help… | 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 | |
| previous_response_id | string | nullable | |
| 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. | |
| reasoning | OpenAI.Reasoning | **gpt-5 and o-series models only** Configuration options for [reasoning models](https://platform.openai.com/docs/guides/reasoning). | nullable |
| background | boolean | nullable | |
| max_tool_calls | integer | nullable | |
| text | OpenAI.ResponseTextParam | Configuration options for a text response from the model. Can be plain text or structured JSON data. Learn more: - [Text inputs and outputs](/docs/guides/text) - [Structured Outputs](/docs/guides/structured-outputs) | |
| tools | OpenAI.Tool[] | An array of tools the model may call while generating a response. You can specify which tool to use by setting the `tool_choice` parameter. | |
| tool_choice | enum | object | ||
| prompt | OpenAI.Prompt | Reference to a prompt template and its variables. [Learn more](/docs/guides/text?api-mode=responses#reusable-prompts). | |
| truncation | enum | auto | disabled · nullable | |
| input | string | OpenAI.InputItem[] | Text, image, or file inputs to the model, used to generate a response. Learn more: - [Text inputs and outputs](/docs/guides/text) - [Image inputs](/docs/guides/images) - [File inputs](/docs/guides/pdf-files) - [Conversation state](/docs/guides/conversation-sta… | |
| include | OpenAI.IncludeEnum[] | nullable | |
| parallel_tool_calls | boolean | nullable | |
| store | boolean | nullable | |
| instructions | string | nullable | |
| stream | boolean | nullable | |
| stream_options | OpenAI.ResponseStreamOptions | Options for streaming responses. Only set this when you set `stream: true`. | nullable |
| conversation | string | Conversation object | The conversation that this response belongs to. Items from this conversation are prepended to `input_items` for this response request. Input items and output items from this response are automatically added to this conversation after this response completes. | nullable |
| context_management | OpenAI.ContextManagementParam[] | Context management configuration for this request. | nullable |
| max_output_tokens | integer | nullable |
Validate a payload
before you spend tokensshell
$ curl -X POST https://modelschemas.com/v1/validate \
-d '{"provider":"azure","endpointId":"responses","payload":{…}}'
→ {"valid": false, "errors": [{"path": "#", "keyword": "required", …}]}