GET
/v1/schemas/groq/chat/openai%2Fv1%2Fchat%2Fcompletions
Accept:
Request body
35 properties · 2 required · 27 $defs| property | type | description | constraints |
|---|---|---|---|
| messages* | ChatCompletionRequestMessage[] | A list of messages comprising the conversation so far. | items ≥ 1 |
| model* | string | enum | ID of the model to use. For details on which models are compatible with the Chat API, see available [models](https://console.groq.com/docs/models) | |
| disable_tool_validation | boolean | If set to true, groq will return called tools without validating that the tool is present in request.tools. tool_choice=required/none will still be enforced, but the request cannot require a specific tool be used. | default: false |
| frequency_penalty | number | This is not yet supported by any of our models. 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. | -2 ≤ n ≤ 2 · default: 0 |
| include_reasoning | boolean | Whether to include reasoning in the response. If true, the response will include a `reasoning` field. If false, the model's reasoning will not be included in the response. This field is mutually exclusive with `reasoning_format`. | |
| logit_bias | object | This is not yet supported by any of our models. Modify the likelihood of specified tokens appearing in the completion. | default: null |
| logprobs | boolean | This is not yet supported by any of our models. 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`. | default: false |
| top_logprobs | integer | This is not yet supported by any of our models. An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability. `logprobs` must be set to `true` if this parameter is used. | 0 ≤ n ≤ 20 |
| max_tokens | integer | Deprecated in favor of `max_completion_tokens`. The maximum number of tokens that can be generated in the chat completion. The total length of input tokens and generated tokens is limited by the model's context length. | deprecated |
| max_completion_tokens | integer | The maximum number of tokens that can be generated in the chat completion. The total length of input tokens and generated tokens is limited by the model's context length. | |
| n | integer | How many chat completion choices to generate for each input message. Note that the current moment, only n=1 is supported. Other values will result in a 400 response. | 1 ≤ n ≤ 1 · default: 1 |
| presence_penalty | number | This is not yet supported by any of our models. 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. | -2 ≤ n ≤ 2 · default: 0 |
| response_format | Text | JSON schema | JSON object | 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. `json_schema` response format is only available on… | |
| seed | integer | 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` respons… | |
| service_tier | enum | The service tier to use for the request. Defaults to `on_demand`. - `auto` will automatically select the highest tier available within the rate limits of your organization. - `flex` uses the flex tier, which will succeed or fail quickly. | auto | on_demand | flex | performance | null |
| stop | string | string[] | Up to 4 sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence. | default: null |
| reasoning_effort | enum | qwen3 models support `none` to disable reasoning and `default` or null to use the model default. | none | default | minimal | low | medium | high · +2 more · default: null |
| reasoning_format | enum | Specifies how to output reasoning tokens This field is mutually exclusive with `include_reasoning`. | hidden | raw | parsed · default: null |
| stream | boolean | If set, partial message deltas will be sent. Tokens will be sent as data-only [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) as they become available, with the stream termi… | default: false |
| temperature | number | 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. We generally recommend altering this or top_p but not both. | 0 ≤ n ≤ 2 · default: 1 |
| top_p | number | 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. We generally recommend a… | 0 ≤ n ≤ 1 · default: 1 |
| tools | ChatCompletionTool[] | A list of tools the model may call. Currently, only functions are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for. A max of 128 functions are supported. | items ≤ 128 |
| tool_choice | enum | object | 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 during tool use. | default: true |
| user | string | A unique identifier representing your end-user, which can help us monitor and detect abuse. | |
| function_call | enum | object | Deprecated in favor of `tool_choice`. | deprecated |
| functions | ChatCompletionFunctions[] | Deprecated in favor of `tools`. | items ≥ 0 · items ≤ 128 · deprecated |
| metadata | object | This parameter is not currently supported. | |
| store | boolean | This parameter is not currently supported. | |
| include_domains | string[] | Deprecated: Use search_settings.include_domains instead. A list of domains to include in the search results when the model uses a web search tool. | deprecated |
| exclude_domains | string[] | Deprecated: Use search_settings.exclude_domains instead. A list of domains to exclude from the search results when the model uses a web search tool. | deprecated |
| search_settings | object | Settings for web search functionality when the model uses a web search tool. | |
| compound_custom | object | Custom configuration of models and tools for Compound. | |
| documents | ChatCompletionDocument[] | A list of documents to provide context for the conversation. Each document contains text that can be referenced by the model. | |
| citation_options | enum | Whether to enable citations in the response. When enabled, the model will include citations for information retrieved from provided documents or web searches. | enabled | disabled · default: "enabled" |
Validate a payload
before you spend tokensshell
$ curl -X POST https://modelschemas.com/v1/validate \
-d '{"provider":"groq","endpointId":"openai/v1/chat/completions","payload":{…}}'
→ {"valid": false, "errors": [{"path": "#", "keyword": "required", …}]}