GET
/v1/schemas/grok/chat/v1%2Fresponses?kind=output
Accept:
Response body
32 properties · 18 required · 40 $defs| property | type | description | constraints |
|---|---|---|---|
| background* | boolean | OpenResponses compatibility fields. Not used at the moment. Just for OpenResponses compatibility. Whether to process the response asynchronously in the background. | default: false |
| created_at* | integer | The Unix timestamp (in seconds) for the response creation time. | format: int64 |
| frequency_penalty* | number | (NOT SUPPORTED in Responses API) 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. | format: float |
| id* | string | Unique ID of the response. | |
| metadata* | any | Only included for compatibility. | |
| model* | string | Model name used to generate the response. | |
| object* | string | The object type of this resource. Always set to `response`. | |
| output* | ModelOutput[] | The response generated by the model. | |
| parallel_tool_calls* | boolean | Whether to allow the model to run parallel tool calls. | |
| presence_penalty* | number | (NOT SUPPORTED in Responses API) 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. | format: float |
| service_tier* | enum | Specifies the processing tier used for serving the request. | default | priority |
| status* | string | Status of the response. One of `completed`, `in_progress` or `incomplete`. | |
| store* | boolean | Whether to store the input message(s) and model response for later retrieval. | default: true |
| text* | ModelResponseConfiguration | Settings for customizing a text response from the model. | |
| tool_choice* | string | object | Controls which (if any) tool is called by the model. auto means the model can pick between generating a message or calling one or more tools. required means the model must call one or more tools. Specifying a particular tool via `{"type": "function", "function… | |
| tools* | ModelTool[] | A list of tools the model may call in JSON-schema. Currently, only functions and web search are supported as tools. A max of 128 tools are supported. | items ≤ 128 |
| top_logprobs* | integer | An integer between 0 and 8 specifying the number of most likely tokens to return at each token position. | format: int32 |
| truncation* | string | The truncation strategy to use for the model response. | default: "disabled" |
| completed_at | any | The Unix timestamp (in seconds) for the response completion time. Only set when the response is completed. | format: int64 |
| error | any | An error object returned when the model fails to generate a response. | |
| incomplete_details | object | object | object | Details about why the response is incomplete. | nullable |
| instructions | any | A system (or developer) message inserted into the model's context. | |
| max_output_tokens | any | Max number of tokens that can be generated in a response. This includes both output and reasoning tokens. | format: int32 |
| max_tool_calls | any | The maximum number of tool calls allowed for this response. | format: int32 |
| previous_response_id | any | The ID of the previous response from the model. | |
| prompt_cache_key | any | The cache key used for the prompt for routing to the correct engine. | |
| reasoning | ReasoningConfiguration | Reasoning configuration. Only for reasoning models. | nullable |
| safety_identifier | any | A stable identifier used to help detect users of your application that may be violating xAI's usage policies. | |
| temperature | any | What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. | 0 ≤ n ≤ 2 · format: float · default: 1 |
| top_p | any | An alternative to sampling with `temperature`, called nucleus sampling, where the model considers the results of the tokens with `top_p` probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. It is generally reco… | 0 < n ≤ 1 · format: float · default: 1 |
| usage | ModelUsage | Token usage information. | nullable |
| user | any | A unique identifier representing your end-user, which can help xAI to monitor and detect abuse. |
Validate a payload
before you spend tokensshell
$ curl -X POST https://modelschemas.com/v1/validate \
-d '{"provider":"grok","endpointId":"v1/responses","payload":{…}}'
→ {"valid": false, "errors": [{"path": "#", "keyword": "required", …}]}