Reference

Archive Fine-Tuned Model

Archive a fine-tuned model so it is unavailable until restored.

Count Chat Completion Field Options

Count values of a chat completion field after optional filtering.

Create Batch Job

Create and queue a Mistral batch inference job.

Create Speech

Generate JSON-encoded speech audio from text without streaming.

Get Batch Job

Get details and optionally inline results for a batch job.

Get campaign

Retrieve an observability campaign by its UUID.

Get campaign status

Return the execution status of an observability campaign.

Get Chat Completion Event

Retrieve one observability chat completion event by UUID.

Get Chat Completion Field Options

Get available values for a chat completion field and filter operator.

Get Connector

Get a connector by ID or name without requesting customer data or secrets.

Get Connector Authentication Methods

Get a connector's public authentication methods and required headers.

Get dataset

Retrieve an observability dataset by its UUID.

Get dataset import task

Retrieve the status and progress of one dataset import task.

Get dataset record

Retrieve a conversation record from an observability dataset.

Get Judge

Retrieve a saved observability judge by UUID.

Get Similar Chat Completion Events

Retrieve observability events similar to a specified event.

Get Voice

Get saved voice metadata without sample audio.

Get Voice Sample

Download a saved voice's sample as a WAV audio file.

Get Workflow

Retrieve a workflow definition and its active-worker status by name or ID.

Get Workflow Deployment

Retrieve a workflow deployment and its registered workers.

Get Workflow Execution

Retrieve the current state and result of a workflow execution.

Get Workflow Execution History

Retrieve the event history for a workflow execution.

Get Workflow Execution OpenTelemetry Trace

Retrieve raw OpenTelemetry trace data for a workflow execution.

Get Workflow Execution Trace Events

Retrieve trace events for a workflow execution.

Get Workflow Execution Trace Summary

Retrieve a hierarchical trace summary for a workflow execution.

Get Workflow Metrics

Retrieve aggregate execution, error, latency, and retry metrics for a workflow.

Get Workflow Registration

Retrieve one workflow registration and its worker availability.

Get Workflow Run

Retrieve a workflow run's status, timing, execution IDs, and result.

Get Workflow Run History

Retrieve the event history for a workflow run.

Judge Chat Completion Event

Evaluate one chat completion event with an inline judge definition.

Judge Conversation

Run a saved observability judge against a supplied conversation.

Judge dataset record

Evaluate one dataset record with a supplied non-durable judge definition.

List campaign selected events

List chat-completion events selected by an observability campaign.

List campaigns

List observability campaigns, optionally filtering them by a text query.

List Chat Completion Fields

List fields and operators available for observability event filtering.

List Connector Tools

List tools exposed by an MCP connector.

List Connectors

List custom MCP connectors without returning connection secrets.

List dataset import tasks

List import tasks associated with an observability dataset.

List dataset records

List conversation records stored in an observability dataset.

List datasets

List observability datasets, optionally filtering them by a text query.

List Judges

List saved observability judges with filtering, search, and pagination.

List Voices

List saved voices without sample audio data.

List Workflow Deployments

List workflow worker deployments, optionally filtering to active deployments or a workflow.

List Workflow Events

List durable workflow lifecycle and task events with cursor pagination.

List Workflow Registrations

List workflow registrations with sharing, activity, archival, and cursor filters.

List Workflow Runs

List workflow runs with status, search, and cursor pagination filters.

List Workflow Schedules

List workflow schedules with timing, time zone, and execution policy details.

Query Workflow Execution

Invoke a read-only query handler on a running workflow execution.

Search Chat Completion Events

Search observability chat completion events and return previews or only IDs.

Unarchive Fine-Tuned Model

Restore an archived fine-tuned model.

Update Fine-Tuned Model

Update the name or description of a fine-tuned model.

Append to conversation

Tool to append new entries to an existing conversation in Mistral AI.

Create Agent

Tool to create a new AI agent with custom configuration (Beta).

Create Agents Completion

Processes messages and generates responses using a Mistral AI agent that can follow instructions, use integrated tools, and maintain conversation context across multiple turns.

Create Audio Transcription

Transcribe audio files to text using Mistral AI's Voxtral models.

Create Chat Completion

Generates intelligent conversational responses using Mistral AI to power chatbots, Q&A systems, and automated assistance for solopreneurs and small teams.

Create Chat Moderation

Tool to classify chat content for moderation purposes across 9 categories.

Create Embeddings

Converts text into numerical vectors (embeddings) that capture semantic meaning, enabling similarity search, clustering, and retrieval-augmented generation.

Create FIM Completion

Generate code completions using fill-in-the-middle functionality.

Create library

Tool to create a new document library.

Create library share

Create or update sharing permissions for a library.

Create Moderation

Tool to classify text content for moderation purposes across 9 categories.

Create OCR

Extract text and structured data from images and documents using Mistral AI's OCR capabilities.

Create or Update Agent Alias

Tool to create or update an agent version alias.

Delete agent

Permanently deletes an agent by its ID (Beta feature).

Delete Conversation

Permanently removes a specific conversation by its ID, helping you organize and manage your AI chat history.

Delete File

Permanently removes a file and its metadata from Mistral AI, helping you maintain a clean and organized file storage by deleting outdated, test, or sensitive files.

Delete library

Permanently deletes a library and all of its documents from Mistral AI.

Delete library document

Permanently deletes a document from a Mistral AI library.

Delete library share

Remove sharing permissions for a library from a user, workspace, or organization.

Download File

Download the content of a previously uploaded file from Mistral AI.

Get Agent

Retrieves the full configuration of a specific Mistral AI agent, including its model, instructions, and tools, allowing you to inspect or verify its settings.

Get Agent Version

Retrieve a specific version of an agent (Beta).

Get Conversation

Tool to retrieve details of a specific conversation.

Get Conversation History

Retrieves the complete history of a conversation, including messages, tool calls, function results, and agent handoffs, so you can review context or export the data for analysis.

Get Conversation Messages

Retrieve all messages from a Mistral AI conversation.

Get document extracted text URL

Retrieve a signed URL to download the extracted text from a document in a Mistral AI library.

Get document signed URL

Get a signed URL to download a document from a Mistral AI library.

Get Document Status

Retrieve the processing status of a document in a Mistral AI library.

Get Document Text Content

Retrieve the extracted text content of a specific document from a Mistral AI library (Beta).

Get File Signed URL

Get a time-limited signed URL for downloading a file from Mistral AI.

Get library

Fetch complete metadata for a specific library, including name, description, document count, size, timestamps, and ownership details, to evaluate its contents and manage your knowledge base effectively.

Get Library Document

Retrieve metadata for a specific document in a Mistral AI library.

Get Model

Tool to retrieve detailed information about a specific Mistral AI model by its ID.

List agent aliases

Retrieve all aliases for an agent version.

List Agent Versions

List all versions of a specific agent.

List Agents

Tool to list all configured agents (Beta).

List Batch Jobs

Tool to retrieve a list of all batch jobs with optional filtering and pagination.

List Conversations

List all created conversations (Beta).

List Files

Lists all files that have been uploaded to the user's account, enabling easy management and retrieval of documents for use in AI tasks.

List Fine Tuning Jobs

List fine-tuning jobs with optional filtering and pagination.

List libraries

List all document libraries accessible to your organization.

List Library Documents

List all documents in a Mistral AI document library.

List library shares

List all sharing permissions for a document library.

List Models

Tool to retrieve all available Mistral AI models including base models and fine-tuned models.

Reprocess document

Reprocess a document in a Mistral AI library (Beta).

Restart Conversation

Creates a new conversation branch by replaying from a chosen message, allowing you to explore alternative directions without losing the original thread

Retrieve File

Retrieve metadata of a file uploaded to Mistral AI.

Start Conversation

Tool to start a new conversation with a Mistral AI agent or base model.

Update Agent

Modifies an existing AI agent's configuration, including name, instructions, model, or tools, to adapt to evolving business needs without recreating the agent.

Update agent version

Tool to update the current version of an agent (Beta).

Update library

Tool to update an existing document library's properties.

Update library document

Update the metadata of a document in a Mistral AI library.

Upload File

Uploads files (JSONL, documents) to Mistral AI for fine-tuning models, batch processing, or OCR, enabling AI customization and data extraction for your business workflows.

Upload Library Document

Upload a document to a Mistral AI library for use with RAG-enabled agents.