GET

/v1/schemas/mistral/chat/v1/agents/completions

kind inputactivity chathash a71bcc97…extracted Nov 5, 2026version currentsource upstream spec ↗
fieldrecorded source
schemaSource linked above.

upstream-spec

Source trace
7b344504336785172c86cd826ce4b1cbfd12be228a8432cf046b2b8fdafacf72
{
  "fetchedAt": 1793856071,
  "extractorVersion": "1",
  "verifiedAt": null
}

Request body

27 properties · 2 required · 46 $defs
propertytypedescriptionconstraints
messages*SystemMessage | UserMessage | AssistantMessage[]The prompt(s) to generate completions for, encoded as a list of dict with role and content.
agent_id*stringThe ID of the agent to use for this completion.
max_tokensintegerThe maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length.n ≥ 0 · nullable
streambooleanWhether to stream back partial progress. If set, tokens will be sent as data-only server-side events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until com…default: false
stopstring | string[]Stop generation if this token is detected. Or if one of these tokens is detected when providing an arraynullable
random_seedintegerThe seed to use for random sampling. If set, different calls will generate deterministic results.n ≥ 0 · nullable
metadataobjectnullable
response_formatResponseFormatSpecify the format that the model must output. By default it will use `{ "type": "text" }`. Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the m…
toolsTool | ImageGenerationTool | DocumentLibraryTool[]nullable
tool_choiceToolChoice | enumdefault: "auto"
presence_penaltynumberThe `presence_penalty` determines how much the model penalizes the repetition of words or phrases. A higher presence penalty encourages the model to use a wider variety of words and phrases, making the output more diverse and creative.-2 ≤ n ≤ 2 · nullable
frequency_penaltynumberThe `frequency_penalty` penalizes the repetition of words based on their frequency in the generated text. A higher frequency penalty discourages the model from repeating words that have already appeared frequently in the output, promoting diversity and reducing repetition.-2 ≤ n ≤ 2 · nullable
min_tokensintegern ≥ 0 · nullable
repetition_penaltynumber0 < n ≤ 2 · nullable
top_kintegern ≥ -1 · nullable
logprobsbooleannullable
top_logprobsintegernullable
prompt_logprobsbooleannullable
top_prompt_logprobsintegernullable
nintegerNumber of completions to return for each request, input tokens are only billed once.n ≥ 1 · nullable
predictionPredictionEnable users to specify expected results, optimizing response times by leveraging known or predictable content. This approach is especially effective for updating text documents or code files with minimal changes, reducing latency while maintaining high-qualit…
parallel_tool_callsbooleandefault: true
reasoning_effortenumnone | minimal | low | medium | high | xhigh · +1 more · nullable
prompt_modeenumAvailable options to the prompt_mode argument on the chat completion endpoint. Values represent high-level intent. Assignment to actual SPs is handled internally. System prompt may include knowledge cutoff date, model capabilities, tone to use, safety guidelin…reasoning · nullable
guardrailsGuardrailConfig[]nullable
prompt_cache_keystringnullable
service_tierenumDetermines whether to serve the request using priority or standard capacity.auto | standard_only · nullable

Types

46 $defs

APIKeyAuthobject

typeenumapi-key · default: "api-key"
value*string

AssistantMessageobject

roleconst"assistant" · default: "assistant"
contentstring | ContentChunk[]nullable
tool_callsToolCall[]nullable
prefixbooleanSet this to `true` when adding an assistant message as prefix to condition the model response. The role of the prefix message is to force the model to start its answer by the content of the message.default: false

AudioChunkobject

typeconst"input_audio" · default: "input_audio"
input_audio*string | string

BuiltInConnectorsenum

web_search | web_search_premium | code_interpreter | image_generation | document_library | mistral_mcp

ContentChunkTextChunk | ImageURLChunk | DocumentURLChunk | …

CustomConnectorobject

typeenumconnector · default: "connector"
connector_id*string
authorizationOAuth2TokenAuth | APIKeyAuthDeprecated: per-request connector credentials will be removed. Authenticate the connector through the Connectors API instead.nullable · deprecated
tool_configurationToolConfigurationnullable

DocumentLibraryToolobject

tool_configurationToolConfigurationnullable
typeenumdocument_library · default: "document_library"
library_ids*string[]Ids of the library in which to search.items ≥ 1

DocumentURLChunkobject

typeconst"document_url" · default: "document_url"
document_url*string
document_namestringThe filename of the documentnullable

FileChunkobject

typeconst"file" · default: "file"
file_id*stringformat: uuid

Functionobject

name*string
descriptionstringdefault: ""
strictbooleandefault: false
parameters*object

FunctionCallobject

name*string
arguments*object | string

FunctionNameobject

this restriction of `Function` is used to select a specific function to call

name*string

GuardrailConfigobject

block_on_errorbooleanIf true, return HTTP 403 and block request in the event of a server-side errordefault: false
moderation_llm_v1ModerationLLMV1Confignullable
moderation_llm_v2ModerationLLMV2Confignullable

ImageDetailenum

low | auto | high

ImageGenerationToolobject

tool_configurationToolConfigurationnullable
typeenumimage_generation · default: "image_generation"

ImageURLobject

url*string
detailenumlow | auto | high · nullable

ImageURLChunkobject

{"type":"image_url","image_url":"data:image/png;base64,iVBORw0"}

typeconst"image_url" · default: "image_url"
image_url*ImageURL | string

JsonSchemaobject

name*string
descriptionstringnullable
schema*object
strictbooleandefault: false

MistralPromptModeenum

Available options to the prompt_mode argument on the chat completion endpoint. Values represent high-level intent. Assignment to actual SPs is handled internally. System prompt may include knowledge cutoff date, model capabilities, tone to use, safety guidelin…

reasoning

ModerationLLMActionenum

none | block

ModerationLLMV1CategoryThresholdsobject

sexualnumbernullable
hate_and_discriminationnumbernullable
violence_and_threatsnumbernullable
dangerous_and_criminal_contentnumbernullable
selfharmnumbernullable
healthnumbernullable
financialnumbernullable
lawnumbernullable
piinumbernullable

ModerationLLMV1Configobject

model_namestringOverride model name. Should be omitted in general.default: "mistral-moderation-2411"
custom_category_thresholdsModerationLLMV1CategoryThresholdsnullable
ignore_other_categoriesbooleanIf true, only evaluate categories in custom_category_thresholds; others are ignored.default: false
actionenumAction to take if any score is above the threshold for any category.none | block

ModerationLLMV2CategoryThresholdsobject

sexualnumbernullable
hate_and_discriminationnumbernullable
violence_and_threatsnumbernullable
dangerousnumbernullable
criminalnumbernullable
selfharmnumbernullable
healthnumbernullable
financialnumbernullable
lawnumbernullable
piinumbernullable
jailbreakingnumbernullable

ModerationLLMV2Configobject

model_namestringOverride model name. Should be omitted in general.default: "mistral-moderation-2603"
custom_category_thresholdsModerationLLMV2CategoryThresholdsnullable
ignore_other_categoriesbooleanIf true, only evaluate categories in custom_category_thresholds; others are ignored.default: false
actionenumAction to take if any score is above the threshold for any category.none | block

OAuth2TokenAuthobject

typeenumoauth2-token · default: "oauth2-token"
value*string

Predictionobject

Enable users to specify an expected completion, optimizing response times by leveraging known or predictable content.

typeconst"content" · default: "content"
contentstringdefault: ""

ReasoningEffortenum

none | minimal | low | medium | high | xhigh · +1 more

ReferenceChunkobject

typeconst"reference" · default: "reference"
reference_ids*integer | string[]

RequestedServiceTierenum

auto | standard_only

ResourceChunkobject

typeconst"resource" · default: "resource"
uri*string
content*TextChunk | ImageURLChunk

ResourceLinkChunkobject

typeconst"resource_link" · default: "resource_link"
uri*string
metadataobjectnullable

ResponseFormatobject

Specify the format that the model must output. By default it will use `{ "type": "text" }`. Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the m…

typeenumtext | json_object | json_schema
json_schemaJsonSchemanullable

ResponseFormatsenum

text | json_object | json_schema

SystemMessageobject

roleconst"system" · default: "system"
content*string | SystemMessageContentChunks[]

SystemMessageContentChunksTextChunk | ThinkChunk

TextChunkobject

typeconst"text" · default: "text"
text*string

ThinkChunkobject

typeconst"thinking" · default: "thinking"
thinking*TextChunk | ToolReferenceChunk | ReferenceChunk[]
signaturestringSignature to replay some reasoning blocks across turns.nullable
closedbooleanWhether the thinking chunk is closed or not. Currently only used for prefixing.default: true

Toolobject

typeenumfunction
function*Function

ToolCallobject

idstringdefault: "null"
typeenumfunction
function*FunctionCall
indexintegerdefault: 0

ToolChoiceobject

ToolChoice is either a ToolChoiceEnum or a ToolChoice

typeenumfunction
function*FunctionNamethis restriction of `Function` is used to select a specific function to call

ToolChoiceEnumenum

auto | none | any | required

ToolConfigurationobject

excludestring[]nullable
includestring[]nullable
requires_confirmationstring[]nullable

ToolMessageobject

roleconst"tool" · default: "tool"
content*string | ContentChunk[]nullable
tool_call_idstringnullable
namestringnullable

ToolReferenceChunkobject

typeconst"tool_reference" · default: "tool_reference"
tool*enum | string
title*string
urlstringnullable
faviconstringnullable
descriptionstringnullable

ToolTypesenum

function

UserMessageobject

roleconst"user" · default: "user"
content*string | ContentChunk[]nullable

Validate a payload

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