Skip to main content
Server path: /mistral-core | Type: Application | PCID required: Yes

Tools

ToolDescription
mistral_core_audio_api_v1_transcriptions_postCreate Transcription
mistral_core_chat_classifications_v1_chat_classifications_postChat Classifications
mistral_core_chat_completion_v1_chat_completions_postChat Completion
mistral_core_chat_moderations_v1_chat_moderations_postChat Moderations
mistral_core_classifications_v1_classifications_postClassifications
mistral_core_create_voice_v1_audio_voices_postCreate a new voice
mistral_core_delete_model_v1_models_model_id_deleteDelete Model
mistral_core_delete_voice_v1_audio_voices_voice_id_deleteDelete a custom voice
mistral_core_embeddings_v1_embeddings_postEmbeddings
mistral_core_files_api_routes_delete_fileDelete File
mistral_core_files_api_routes_download_fileDownload File
mistral_core_files_api_routes_get_signed_urlGet Signed Url
mistral_core_files_api_routes_list_filesList Files
mistral_core_files_api_routes_retrieve_fileRetrieve File
mistral_core_files_api_routes_upload_fileUpload File
mistral_core_fim_completion_v1_fim_completions_postFim Completion
mistral_core_get_voice_sample_audio_v1_audio_voices_voice_id_sample_getGet voice sample audio
mistral_core_get_voice_v1_audio_voices_voice_id_getGet voice details
mistral_core_jobs_api_routes_batch_cancel_batch_jobCancel Batch Job
mistral_core_jobs_api_routes_batch_create_batch_jobCreate Batch Job
mistral_core_jobs_api_routes_batch_get_batch_jobGet Batch Job
mistral_core_jobs_api_routes_batch_get_batch_jobsGet Batch Jobs
mistral_core_jobs_api_routes_fine_tuning_archive_fine_tuned_modelArchive Fine Tuned Model
mistral_core_jobs_api_routes_fine_tuning_unarchive_fine_tuned_modelUnarchive Fine Tuned Model
mistral_core_jobs_api_routes_fine_tuning_update_fine_tuned_modelUpdate Fine Tuned Model
mistral_core_list_models_v1_models_getList Models
mistral_core_list_voices_v1_audio_voices_getList all voices
mistral_core_moderations_v1_moderations_postModerations
mistral_core_ocr_v1_ocr_postOCR
mistral_core_retrieve_model_v1_models_model_id_getRetrieve Model
mistral_core_speech_v1_audio_speech_postSpeech
mistral_core_update_voice_v1_audio_voices_voice_id_patchUpdate voice metadata

mistral_core_audio_api_v1_transcriptions_post

Create Transcription Parameters:
ParameterTypeRequiredDefaultDescription
context_biasstring[]NoContext Bias
diarizebooleanNoThe diarize value
filestringNoThe 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_idstringNoID of a file uploaded to /v1/files
file_urlstringNoUrl of a file to be transcribed
languagestringNoLanguage of the audio, e.g. ‘en’. Providing the language can boost accuracy.
modelstringYesID of the model to be used.
streambooleanNoThe stream value
temperaturenumberNoThe temperature value
timestamp_granularitiesstring[]NoGranularities of timestamps to include in the response.

mistral_core_chat_classifications_v1_chat_classifications_post

Chat Classifications Parameters:
ParameterTypeRequiredDefaultDescription
inputobject[]YesChat to classify
modelstringYesThe model value

mistral_core_chat_completion_v1_chat_completions_post

Chat Completion Parameters:
ParameterTypeRequiredDefaultDescription
frequency_penaltynumberNoThe 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.
guardrailsobject[]NoA 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_tokensintegerNoThe 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.
messagesany[]YesThe prompt(s) to generate completions for, encoded as a list of dict with role and content.
metadataobjectNoThe metadata value
modelstringYesID 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.
nintegerNoNumber of completions to return for each request, input tokens are only billed once.
parallel_tool_callsbooleanNoWhether to enable parallel function calling during tool use, when enabled the model can call multiple tools in parallel.
predictionobjectNoEnable users to specify an expected completion, optimizing response times by leveraging known or predictable content.
presence_penaltynumberNoThe 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_modestringNoAllows 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_seedintegerNoThe seed to use for random sampling. If set, different calls will generate deterministic results.
reasoning_effortstringNoControls the reasoning effort level for reasoning models. “high” enables comprehensive reasoning traces, “none” disables reasoning effort.
response_formatobjectNoSpecify 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_promptbooleanNoWhether to inject a safety prompt before all conversations.
stopstring[]NoStop generation if this token is detected. Or if one of these tokens is detected when providing an array
streambooleanNoWhether 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.
temperaturenumberNoWhat 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_choiceobjectNoControls 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.
toolsobject[]NoA list of tools the model may call. Use this to provide a list of functions the model may generate JSON inputs for.
top_pnumberNoNucleus 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:
ParameterTypeRequiredDefaultDescription
inputobjectYesChat to classify
modelstringYesThe model value

mistral_core_classifications_v1_classifications_post

Classifications Parameters:
ParameterTypeRequiredDefaultDescription
inputstring[]YesText to classify.
metadataobjectNoThe metadata value
modelstringYesID of the model to use.

mistral_core_create_voice_v1_audio_voices_post

Create a new voice Parameters:
ParameterTypeRequiredDefaultDescription
ageintegerNoThe age value
colorstringNoThe color value
genderstringNoThe gender value
languagesstring[]NoThe languages value
namestringYesThe name value
retention_noticeintegerNoRetention Notice
sample_audiostringYesBase64-encoded audio file
sample_filenamestringNoOriginal filename for extension detection
slugstringNoThe slug value
tagsstring[]NoThe tags value

mistral_core_delete_model_v1_models_model_id_delete

Delete Model Parameters:
ParameterTypeRequiredDefaultDescription
model_idstringYesThe ID of the model to delete.

mistral_core_delete_voice_v1_audio_voices_voice_id_delete

Delete a custom voice Parameters:
ParameterTypeRequiredDefaultDescription
voice_idstringYesVoice Id

mistral_core_embeddings_v1_embeddings_post

Embeddings Parameters:
ParameterTypeRequiredDefaultDescription
encoding_formatstringNoEncoding Format
inputstring[]YesText to embed.
metadataobjectNoThe metadata value
modelstringYesID of the model to use.
output_dimensionintegerNoThe dimension of the output embeddings when feature available. If not provided, a default output dimension will be used.
output_dtypestringNoOutput Dtype

mistral_core_files_api_routes_delete_file

Delete File Parameters:
ParameterTypeRequiredDefaultDescription
file_idstringYesFile Id

mistral_core_files_api_routes_download_file

Download File Parameters:
ParameterTypeRequiredDefaultDescription
file_idstringYesFile Id

mistral_core_files_api_routes_get_signed_url

Get Signed Url Parameters:
ParameterTypeRequiredDefaultDescription
file_idstringYesFile Id
expiryintegerNoNumber of hours before the url becomes invalid. Defaults to 24h

mistral_core_files_api_routes_list_files

List Files Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number for pagination
page_sizeintegerNoNumber of results per page
include_totalbooleanNoInclude Total
sample_typestring[]NoSample Type
sourcestring[]NoThe source value
searchstringNoThe search value
purposestringNoThe purpose value
mimetypesstring[]NoThe mimetypes value

mistral_core_files_api_routes_retrieve_file

Retrieve File Parameters:
ParameterTypeRequiredDefaultDescription
file_idstringYesFile Id

mistral_core_files_api_routes_upload_file

Upload File Parameters:
ParameterTypeRequiredDefaultDescription
expiryintegerNoThe expiry value
filestringYesThe 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
purposestringNoThe purpose value
visibilityobjectNoThe visibility value

mistral_core_fim_completion_v1_fim_completions_post

Fim Completion Parameters:
ParameterTypeRequiredDefaultDescription
max_tokensintegerNoThe 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.
metadataobjectNoThe metadata value
min_tokensintegerNoThe minimum number of tokens to generate in the completion.
modelstringYesID of the model with FIM to use.
promptstringYesThe text/code to complete.
random_seedintegerNoThe seed to use for random sampling. If set, different calls will generate deterministic results.
stopstring[]NoStop generation if this token is detected. Or if one of these tokens is detected when providing an array
streambooleanNoWhether 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.
suffixstringNoOptional 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.
temperaturenumberNoWhat 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_pnumberNoNucleus 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:
ParameterTypeRequiredDefaultDescription
voice_idstringYesVoice Id

mistral_core_get_voice_v1_audio_voices_voice_id_get

Get voice details Parameters:
ParameterTypeRequiredDefaultDescription
voice_idstringYesVoice Id

mistral_core_jobs_api_routes_batch_cancel_batch_job

Cancel Batch Job Parameters:
ParameterTypeRequiredDefaultDescription
job_idstringYesJob Id

mistral_core_jobs_api_routes_batch_create_batch_job

Create Batch Job Parameters:
ParameterTypeRequiredDefaultDescription
agent_idstringNoIn case you want to use a specific agent from the deprecated agents api for batch inference, you can specify the agent ID here.
endpointstringYesThe endpoint value
input_filesstring[]NoThe 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?"}]}}
metadataobjectNoThe metadata of your choice to be associated with the batch inference job.
modelstringNoThe model to be used for batch inference.
requestsobject[]NoThe requests value
timeout_hoursintegerNoThe timeout in hours for the batch inference job.

mistral_core_jobs_api_routes_batch_get_batch_job

Get Batch Job Parameters:
ParameterTypeRequiredDefaultDescription
job_idstringYesJob Id
inlinebooleanNoThe inline value

mistral_core_jobs_api_routes_batch_get_batch_jobs

Get Batch Jobs Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number for pagination
page_sizeintegerNoNumber of results per page
modelstringNoThe model value
agent_idstringNoAgent Id
metadataobjectNoThe metadata value
created_afterstringNoCreated After
created_by_mebooleanNoCreated By Me
statusstring[]NoThe status value
order_bystringNoOrder By

mistral_core_jobs_api_routes_fine_tuning_archive_fine_tuned_model

Archive Fine Tuned Model Parameters:
ParameterTypeRequiredDefaultDescription
model_idstringYesThe ID of the model to archive.

mistral_core_jobs_api_routes_fine_tuning_unarchive_fine_tuned_model

Unarchive Fine Tuned Model Parameters:
ParameterTypeRequiredDefaultDescription
model_idstringYesThe ID of the model to unarchive.

mistral_core_jobs_api_routes_fine_tuning_update_fine_tuned_model

Update Fine Tuned Model Parameters:
ParameterTypeRequiredDefaultDescription
model_idstringYesThe ID of the model to update.
descriptionstringNoThe description value
namestringNoThe name value

mistral_core_list_models_v1_models_get

List Models Parameters:
ParameterTypeRequiredDefaultDescription
providerstringNoThe provider value
modelstringNoThe model value

mistral_core_list_voices_v1_audio_voices_get

List all voices Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoMaximum number of voices to return
offsetintegerNoOffset for pagination

mistral_core_moderations_v1_moderations_post

Moderations Parameters:
ParameterTypeRequiredDefaultDescription
inputstring[]YesText to classify.
metadataobjectNoThe metadata value
modelstringYesID of the model to use.

mistral_core_ocr_v1_ocr_post

OCR Parameters:
ParameterTypeRequiredDefaultDescription
bbox_annotation_formatobjectNoStructured output class for extracting useful information from each extracted bounding box / image from document. Only json_schema is valid for this field
documentobjectYesDocument to run OCR on
document_annotation_formatobjectNoStructured output class for extracting useful information from the entire document. Only json_schema is valid for this field
document_annotation_promptstringNoOptional prompt to guide the model in extracting structured output from the entire document. A document_annotation_format must be provided.
extract_footerbooleanNoExtract Footer
extract_headerbooleanNoExtract Header
idstringNoThe id value
image_limitintegerNoMax images to extract
image_min_sizeintegerNoMinimum height and width of image to extract
include_image_base64booleanNoInclude image URLs in response
modelstringYesThe model value
pagesinteger[]NoSpecific pages user wants to process in various formats: single number, range, or list of both. Starts from 0
table_formatstringNoTable Format

mistral_core_retrieve_model_v1_models_model_id_get

Retrieve Model Parameters:
ParameterTypeRequiredDefaultDescription
model_idstringYesThe ID of the model to retrieve.

mistral_core_speech_v1_audio_speech_post

Speech Parameters:
ParameterTypeRequiredDefaultDescription
inputstringYesText to generate speech from.
modelstringNoThe model value
ref_audiostringNoThe base64-encoded audio reference for zero-shot voice cloning.
response_formatstringNoResponse Format
streambooleanNoThe stream value
voice_idstringNoThe preset or custom voice to use for generating the speech.

mistral_core_update_voice_v1_audio_voices_voice_id_patch

Update voice metadata Parameters:
ParameterTypeRequiredDefaultDescription
voice_idstringYesVoice Id
ageintegerNoThe age value
genderstringNoThe gender value
languagesstring[]NoThe languages value
namestringNoThe name value
tagsstring[]NoThe tags value