/mistral-core | Type: Application | PCID required: Yes
Tools
mistral_core_audio_api_v1_transcriptions_post
Create Transcription Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
context_bias | string[] | No | — | Context Bias |
diarize | boolean | No | — | The diarize value |
file | string | No | — | The File object (not file name) to be uploaded. To upload a file and specify a custom file name you should format your request as such: bash file=@path/to/your/file.jsonl;filename=custom_name.jsonl Otherwise, you can just keep the original file name: bash file=@path/to/your/file.jsonl |
file_id | string | No | — | ID of a file uploaded to /v1/files |
file_url | string | No | — | Url of a file to be transcribed |
language | string | No | — | Language of the audio, e.g. ‘en’. Providing the language can boost accuracy. |
model | string | Yes | — | ID of the model to be used. |
stream | boolean | No | — | The stream value |
temperature | number | No | — | The temperature value |
timestamp_granularities | string[] | No | — | Granularities of timestamps to include in the response. |
mistral_core_chat_classifications_v1_chat_classifications_post
Chat Classifications Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
input | object[] | Yes | — | Chat to classify |
model | string | Yes | — | The model value |
mistral_core_chat_completion_v1_chat_completions_post
Chat Completion Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
frequency_penalty | number | No | — | The 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. |
guardrails | object[] | No | — | A list of guardrail configurations to apply to this request. Each guardrail specifies a moderation type, categories with thresholds to evaluate, and an action to take on violation. |
max_tokens | integer | No | — | The 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. |
messages | any[] | Yes | — | The prompt(s) to generate completions for, encoded as a list of dict with role and content. |
metadata | object | No | — | The metadata value |
model | string | Yes | — | ID of the model to use. You can use the List Available Models API to see all of your available models, or see our Model overview for model descriptions. |
n | integer | No | — | Number of completions to return for each request, input tokens are only billed once. |
parallel_tool_calls | boolean | No | — | Whether to enable parallel function calling during tool use, when enabled the model can call multiple tools in parallel. |
prediction | object | No | — | Enable users to specify an expected completion, optimizing response times by leveraging known or predictable content. |
presence_penalty | number | No | — | The 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. |
prompt_mode | string | No | — | Allows toggling between the reasoning mode and no system prompt. When set to reasoning the system prompt for reasoning models will be used. Deprecated for reasoning models - use reasoning_effort parameter instead. |
random_seed | integer | No | — | The seed to use for random sampling. If set, different calls will generate deterministic results. |
reasoning_effort | string | No | — | Controls the reasoning effort level for reasoning models. “high” enables comprehensive reasoning traces, “none” disables reasoning effort. |
response_format | object | No | — | 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 model to produce JSON yourself with a system or a user message. Setting to { "type": "json_schema" } enables JSON schema mode, which guarantees the message the model generates is in JSON and follows the schema you provide. |
safe_prompt | boolean | No | — | Whether to inject a safety prompt before all conversations. |
stop | string[] | No | — | Stop generation if this token is detected. Or if one of these tokens is detected when providing an array |
stream | boolean | No | — | Whether 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 completion, with the response containing the full result as JSON. |
temperature | number | No | — | What sampling temperature to use, we recommend between 0.0 and 0.7. Higher values like 0.7 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. The default value varies depending on the model you are targeting. Call the /models endpoint to retrieve the appropriate value. |
tool_choice | object | No | — | 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. any or required means the model must call one or more tools. Specifying a particular tool via {"type": "function", "function": {"name": "my_function"}} forces the model to call that tool. |
tools | object[] | No | — | A list of tools the model may call. Use this to provide a list of functions the model may generate JSON inputs for. |
top_p | number | No | — | 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 altering this or temperature but not both. |
mistral_core_chat_moderations_v1_chat_moderations_post
Chat Moderations Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
input | object | Yes | — | Chat to classify |
model | string | Yes | — | The model value |
mistral_core_classifications_v1_classifications_post
Classifications Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
input | string[] | Yes | — | Text to classify. |
metadata | object | No | — | The metadata value |
model | string | Yes | — | ID of the model to use. |
mistral_core_create_voice_v1_audio_voices_post
Create a new voice Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
age | integer | No | — | The age value |
color | string | No | — | The color value |
gender | string | No | — | The gender value |
languages | string[] | No | — | The languages value |
name | string | Yes | — | The name value |
retention_notice | integer | No | — | Retention Notice |
sample_audio | string | Yes | — | Base64-encoded audio file |
sample_filename | string | No | — | Original filename for extension detection |
slug | string | No | — | The slug value |
tags | string[] | No | — | The tags value |
mistral_core_delete_model_v1_models_model_id_delete
Delete Model Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
model_id | string | Yes | — | The ID of the model to delete. |
mistral_core_delete_voice_v1_audio_voices_voice_id_delete
Delete a custom voice Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
voice_id | string | Yes | — | Voice Id |
mistral_core_embeddings_v1_embeddings_post
Embeddings Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
encoding_format | string | No | — | Encoding Format |
input | string[] | Yes | — | Text to embed. |
metadata | object | No | — | The metadata value |
model | string | Yes | — | ID of the model to use. |
output_dimension | integer | No | — | The dimension of the output embeddings when feature available. If not provided, a default output dimension will be used. |
output_dtype | string | No | — | Output Dtype |
mistral_core_files_api_routes_delete_file
Delete File Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
file_id | string | Yes | — | File Id |
mistral_core_files_api_routes_download_file
Download File Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
file_id | string | Yes | — | File Id |
mistral_core_files_api_routes_get_signed_url
Get Signed Url Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
file_id | string | Yes | — | File Id |
expiry | integer | No | — | Number of hours before the url becomes invalid. Defaults to 24h |
mistral_core_files_api_routes_list_files
List Files Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number for pagination |
page_size | integer | No | — | Number of results per page |
include_total | boolean | No | — | Include Total |
sample_type | string[] | No | — | Sample Type |
source | string[] | No | — | The source value |
search | string | No | — | The search value |
purpose | string | No | — | The purpose value |
mimetypes | string[] | No | — | The mimetypes value |
mistral_core_files_api_routes_retrieve_file
Retrieve File Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
file_id | string | Yes | — | File Id |
mistral_core_files_api_routes_upload_file
Upload File Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expiry | integer | No | — | The expiry value |
file | string | Yes | — | The File object (not file name) to be uploaded. To upload a file and specify a custom file name you should format your request as such: bash file=@path/to/your/file.jsonl;filename=custom_name.jsonl Otherwise, you can just keep the original file name: bash file=@path/to/your/file.jsonl |
purpose | string | No | — | The purpose value |
visibility | object | No | — | The visibility value |
mistral_core_fim_completion_v1_fim_completions_post
Fim Completion Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
max_tokens | integer | No | — | The 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. |
metadata | object | No | — | The metadata value |
min_tokens | integer | No | — | The minimum number of tokens to generate in the completion. |
model | string | Yes | — | ID of the model with FIM to use. |
prompt | string | Yes | — | The text/code to complete. |
random_seed | integer | No | — | The seed to use for random sampling. If set, different calls will generate deterministic results. |
stop | string[] | No | — | Stop generation if this token is detected. Or if one of these tokens is detected when providing an array |
stream | boolean | No | — | Whether 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 completion, with the response containing the full result as JSON. |
suffix | string | No | — | Optional text/code that adds more context for the model. When given a prompt and a suffix the model will fill what is between them. When suffix is not provided, the model will simply execute completion starting with prompt. |
temperature | number | No | — | What sampling temperature to use, we recommend between 0.0 and 0.7. Higher values like 0.7 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. The default value varies depending on the model you are targeting. Call the /models endpoint to retrieve the appropriate value. |
top_p | number | No | — | 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 altering this or temperature but not both. |
mistral_core_get_voice_sample_audio_v1_audio_voices_voice_id_sample_get
Get voice sample audio Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
voice_id | string | Yes | — | Voice Id |
mistral_core_get_voice_v1_audio_voices_voice_id_get
Get voice details Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
voice_id | string | Yes | — | Voice Id |
mistral_core_jobs_api_routes_batch_cancel_batch_job
Cancel Batch Job Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
job_id | string | Yes | — | Job Id |
mistral_core_jobs_api_routes_batch_create_batch_job
Create Batch Job Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
agent_id | string | No | — | In case you want to use a specific agent from the deprecated agents api for batch inference, you can specify the agent ID here. |
endpoint | string | Yes | — | The endpoint value |
input_files | string[] | No | — | The list of input files to be used for batch inference, these files should be jsonl files, containing the input data corresponding to the bory request for the batch inference in a “body” field. An example of such file is the following: json {"custom_id": "0", "body": {"max_tokens": 100, "messages": [{"role": "user", "content": "What is the best French cheese?"}]}} {"custom_id": "1", "body": {"max_tokens": 100, "messages": [{"role": "user", "content": "What is the best French wine?"}]}} |
metadata | object | No | — | The metadata of your choice to be associated with the batch inference job. |
model | string | No | — | The model to be used for batch inference. |
requests | object[] | No | — | The requests value |
timeout_hours | integer | No | — | The timeout in hours for the batch inference job. |
mistral_core_jobs_api_routes_batch_get_batch_job
Get Batch Job Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
job_id | string | Yes | — | Job Id |
inline | boolean | No | — | The inline value |
mistral_core_jobs_api_routes_batch_get_batch_jobs
Get Batch Jobs Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number for pagination |
page_size | integer | No | — | Number of results per page |
model | string | No | — | The model value |
agent_id | string | No | — | Agent Id |
metadata | object | No | — | The metadata value |
created_after | string | No | — | Created After |
created_by_me | boolean | No | — | Created By Me |
status | string[] | No | — | The status value |
order_by | string | No | — | Order By |
mistral_core_jobs_api_routes_fine_tuning_archive_fine_tuned_model
Archive Fine Tuned Model Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
model_id | string | Yes | — | The ID of the model to archive. |
mistral_core_jobs_api_routes_fine_tuning_unarchive_fine_tuned_model
Unarchive Fine Tuned Model Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
model_id | string | Yes | — | The ID of the model to unarchive. |
mistral_core_jobs_api_routes_fine_tuning_update_fine_tuned_model
Update Fine Tuned Model Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
model_id | string | Yes | — | The ID of the model to update. |
description | string | No | — | The description value |
name | string | No | — | The name value |
mistral_core_list_models_v1_models_get
List Models Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
provider | string | No | — | The provider value |
model | string | No | — | The model value |
mistral_core_list_voices_v1_audio_voices_get
List all voices Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Maximum number of voices to return |
offset | integer | No | — | Offset for pagination |
mistral_core_moderations_v1_moderations_post
Moderations Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
input | string[] | Yes | — | Text to classify. |
metadata | object | No | — | The metadata value |
model | string | Yes | — | ID of the model to use. |
mistral_core_ocr_v1_ocr_post
OCR Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
bbox_annotation_format | object | No | — | Structured output class for extracting useful information from each extracted bounding box / image from document. Only json_schema is valid for this field |
document | object | Yes | — | Document to run OCR on |
document_annotation_format | object | No | — | Structured output class for extracting useful information from the entire document. Only json_schema is valid for this field |
document_annotation_prompt | string | No | — | Optional prompt to guide the model in extracting structured output from the entire document. A document_annotation_format must be provided. |
extract_footer | boolean | No | — | Extract Footer |
extract_header | boolean | No | — | Extract Header |
id | string | No | — | The id value |
image_limit | integer | No | — | Max images to extract |
image_min_size | integer | No | — | Minimum height and width of image to extract |
include_image_base64 | boolean | No | — | Include image URLs in response |
model | string | Yes | — | The model value |
pages | integer[] | No | — | Specific pages user wants to process in various formats: single number, range, or list of both. Starts from 0 |
table_format | string | No | — | Table Format |
mistral_core_retrieve_model_v1_models_model_id_get
Retrieve Model Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
model_id | string | Yes | — | The ID of the model to retrieve. |
mistral_core_speech_v1_audio_speech_post
Speech Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
input | string | Yes | — | Text to generate speech from. |
model | string | No | — | The model value |
ref_audio | string | No | — | The base64-encoded audio reference for zero-shot voice cloning. |
response_format | string | No | — | Response Format |
stream | boolean | No | — | The stream value |
voice_id | string | No | — | The preset or custom voice to use for generating the speech. |
mistral_core_update_voice_v1_audio_voices_voice_id_patch
Update voice metadata Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
voice_id | string | Yes | — | Voice Id |
age | integer | No | — | The age value |
gender | string | No | — | The gender value |
languages | string[] | No | — | The languages value |
name | string | No | — | The name value |
tags | string[] | No | — | The tags value |

