client-python API reference

158 public APIs from client-python (mistralai/client-python) — 143 classes, 3 functions, 12 methods. Signatures extracted by static analysis of the actual source.

Repository: mistralai/client-python

Kind	Count
Classes	143
Functions	3
Methods	12

API list

classpackages.azure.src.mistralai.azure.client.chat.Chat

Chat Completion API.

classpackages.azure.src.mistralai.azure.client.errors.mistralazureerror.MistralAzureError

The base class for all HTTP error responses.

classpackages.azure.src.mistralai.azure.client.errors.sdkerror.SDKError

The fallback error class if no more specific error class is matched.

funcpackages.gcp.src.mistralai.gcp.client._hooks.registration.init_hooks(_hooks:Hooks) -> None

Initialize hooks.

classpackages.gcp.src.mistralai.gcp.client.chat.Chat

Chat Completion API.

classpackages.gcp.src.mistralai.gcp.client.fim.Fim

Fill-in-the-middle API.

classsrc.mistralai.client.accesses.Accesses

(beta) Libraries API - manage access to a library.

classsrc.mistralai.client.agents.Agents

Agents API.

classsrc.mistralai.client.beta_agents.BetaAgents

(beta) Agents API

method

src.mistralai.client.beta_agents.BetaAgents.get(*agent_id:str, *agent_version:OptionalNullable[Union[models.AgentsAPIV1AgentsGetAgentVersion, models.AgentsAPIV1AgentsGetAgentVersionTypedDict]]=UNSET, *retries:OptionalNullable[utils.RetryConfig]=UNSET, *server_url:Optional[str]=None, *timeout_ms:Optional[int]=None, *http_headers:Optional[Mapping[str, str]]=None) -> models.Agent

Retrieve an agent entity.

classsrc.mistralai.client.chat.Chat

Chat Completion API.

classsrc.mistralai.client.classifiers.Classifiers

Classifiers API.

classsrc.mistralai.client.connectors.Connectors

(beta) Connectors API - manage your connectors

classsrc.mistralai.client.conversations.Conversations

(beta) Conversations API

classsrc.mistralai.client.documents.Documents

(beta) Libraries API - manage documents in a library.

classsrc.mistralai.client.embeddings.Embeddings

Embeddings API.

classsrc.mistralai.client.errors.mistralerror.MistralError

The base class for all HTTP error responses.

classsrc.mistralai.client.errors.sdkerror.SDKError

The fallback error class if no more specific error class is matched.

classsrc.mistralai.client.files.Files

Files API

classsrc.mistralai.client.fim.Fim

Fill-in-the-middle API.

classsrc.mistralai.client.models.agent.UnknownAgentTool

A AgentTool variant the SDK doesn't recognize.

classsrc.mistralai.client.models.audiocontent.AudioContent

Audio content for a message.

classsrc.mistralai.client.models.audiocontent.AudioContentTypedDict

Audio content for a message.

classsrc.mistralai.client.models.blobresourcecontents.BlobResourceContents

Binary contents of a resource.

classsrc.mistralai.client.models.blobresourcecontents.BlobResourceContentsTypedDict

Binary contents of a resource.

classsrc.mistralai.client.models.clientcapabilities.ClientCapabilities

Capabilities a client may support.

classsrc.mistralai.client.models.clientcapabilities.ClientCapabilitiesTypedDict

Capabilities a client may support.

classsrc.mistralai.client.models.clienttaskscapability.ClientTasksCapability

Capability for client tasks operations.

classsrc.mistralai.client.models.clienttaskscapability.ClientTasksCapabilityTypedDict

Capability for client tasks operations.

classsrc.mistralai.client.models.completionargs.CompletionArgs

White-listed arguments from the completion API

classsrc.mistralai.client.models.completionargs.CompletionArgsTypedDict

White-listed arguments from the completion API

classsrc.mistralai.client.models.completiontokensdetails.CompletionTokensDetails

Token usage details for the completion.

classsrc.mistralai.client.models.completiontokensdetails.CompletionTokensDetailsTypedDict

Token usage details for the completion.

classsrc.mistralai.client.models.connectorcalltoolrequest.ConnectorCallToolRequest

Request body for calling an MCP tool.

classsrc.mistralai.client.models.connectorcalltoolrequest.ConnectorCallToolRequestTypedDict

Request body for calling an MCP tool.

classsrc.mistralai.client.models.connectortoolcallresponse.ConnectorToolCallResponse

Response from calling an MCP tool.

classsrc.mistralai.client.models.connectortoolcallresponse.ConnectorToolCallResponseTypedDict

Response from calling an MCP tool.

classsrc.mistralai.client.models.contentchunk.UnknownContentChunk

A ContentChunk variant the SDK doesn't recognize.

classsrc.mistralai.client.models.conversationhistory.ConversationHistory

Retrieve all entries in a conversation.

classsrc.mistralai.client.models.conversationhistory.ConversationHistoryTypedDict

Retrieve all entries in a conversation.

classsrc.mistralai.client.models.createconnectorrequest.CreateConnectorRequest

Public create schema for MCP connectors.

classsrc.mistralai.client.models.createconnectorrequest.CreateConnectorRequestTypedDict

Public create schema for MCP connectors.

classsrc.mistralai.client.models.customtaskcanceledresponse.CustomTaskCanceledResponse

Emitted when a custom task is canceled.

classsrc.mistralai.client.models.customtaskfailedattributes.CustomTaskFailedAttributes

Attributes for custom task failed events.

classsrc.mistralai.client.models.customtaskfailedresponse.CustomTaskFailedResponse

Emitted when a custom task fails.

classsrc.mistralai.client.models.customtaskfailedresponse.CustomTaskFailedResponseTypedDict

Emitted when a custom task fails.

classsrc.mistralai.client.models.elicitationcapability.ElicitationCapability

Capability for elicitation operations.

classsrc.mistralai.client.models.elicitationcapability.ElicitationCapabilityTypedDict

Capability for elicitation operations.

classsrc.mistralai.client.models.ftmodelcard.FTModelCard

Extra fields for fine-tuned models.

classsrc.mistralai.client.models.ftmodelcard.FTModelCardTypedDict

Extra fields for fine-tuned models.

classsrc.mistralai.client.models.imagecontent.ImageContent

Image content for a message.

classsrc.mistralai.client.models.imagecontent.ImageContentTypedDict

Image content for a message.

classsrc.mistralai.client.models.jsonpatch.UnknownJSONPatch

A JSONPatch variant the SDK doesn't recognize.

classsrc.mistralai.client.models.jsonpayloadresponse.JSONPayloadResponse

A payload containing arbitrary JSON data.

classsrc.mistralai.client.models.jsonpayloadresponse.JSONPayloadResponseTypedDict

A payload containing arbitrary JSON data.

classsrc.mistralai.client.models.mcpservercardmeta.MCPServerCardMeta

Typed _meta for MCP server cards.

classsrc.mistralai.client.models.mcpservercardmeta.MCPServerCardMetaTypedDict

Typed _meta for MCP server cards.

classsrc.mistralai.client.models.mcpservericon.MCPServerIcon

An icon for display in user interfaces.

classsrc.mistralai.client.models.mcpservericon.MCPServerIconTypedDict

An icon for display in user interfaces.

classsrc.mistralai.client.models.mcpserverremote.MCPServerRemote

Remote transport endpoint (SEP-2127).

classsrc.mistralai.client.models.mcpserverremote.MCPServerRemoteTypedDict

Remote transport endpoint (SEP-2127).

classsrc.mistralai.client.models.mcpserverrepository.MCPServerRepository

Source repository information (SEP-2127).

classsrc.mistralai.client.models.mcpserverrepository.MCPServerRepositoryTypedDict

Source repository information (SEP-2127).

classsrc.mistralai.client.models.mcptoolmeta.MCPToolMeta

Typed _meta for MCP tools.

classsrc.mistralai.client.models.mcptoolmeta.MCPToolMetaTypedDict

Typed _meta for MCP tools.

classsrc.mistralai.client.models.mcpuitoolmeta.MCPUIToolMeta

UI metadata for tools that reference UI resources.

classsrc.mistralai.client.models.modellist.UnknownModelListData

A ModelListData variant the SDK doesn't recognize.

classsrc.mistralai.client.models.ocrpageobject.UnknownBlock

A Block variant the SDK doesn't recognize.

classsrc.mistralai.client.models.ocrsignatureblock.OCRSignatureBlock

Signature region.

classsrc.mistralai.client.models.ocrsignatureblock.OCRSignatureBlockTypedDict

Signature region.

classsrc.mistralai.client.models.partialscheduledefinition.PartialScheduleDefinition

Schedule definition for partial updates.

classsrc.mistralai.client.models.promptargument.PromptArgument

An argument for a prompt template.

classsrc.mistralai.client.models.promptargument.PromptArgumentTypedDict

An argument for a prompt template.

classsrc.mistralai.client.models.promptdefinition.PromptDefinition

Versioned prompt content.

classsrc.mistralai.client.models.promptdefinition.PromptDefinitionTypedDict

Versioned prompt content.

classsrc.mistralai.client.models.promptscapability.PromptsCapability

Capability for prompts operations.

classsrc.mistralai.client.models.promptscapability.PromptsCapabilityTypedDict

Capability for prompts operations.

classsrc.mistralai.client.models.prompttokensdetails.PromptTokensDetails

Token usage details for the prompt.

classsrc.mistralai.client.models.prompttokensdetails.PromptTokensDetailsTypedDict

Token usage details for the prompt.

classsrc.mistralai.client.models.resourcescapability.ResourcesCapability

Capability for resources operations.

classsrc.mistralai.client.models.resourcescapability.ResourcesCapabilityTypedDict

Capability for resources operations.

classsrc.mistralai.client.models.responseformat.ResponseFormat

Specify the format that the model must output.

classsrc.mistralai.client.models.responseformat.ResponseFormatTypedDict

Specify the format that the model must output.

classsrc.mistralai.client.models.rootscapability.RootsCapability

Capability for root operations.

classsrc.mistralai.client.models.rootscapability.RootsCapabilityTypedDict

Capability for root operations.

classsrc.mistralai.client.models.scalarmetric.ScalarMetric

Scalar metric with a single value.

classsrc.mistralai.client.models.scalarmetric.ScalarMetricTypedDict

Scalar metric with a single value.

classsrc.mistralai.client.models.servercapabilities.ServerCapabilities

Capabilities that a server may support.

classsrc.mistralai.client.models.servercapabilities.ServerCapabilitiesTypedDict

Capabilities that a server may support.

classsrc.mistralai.client.models.servertaskscapability.ServerTasksCapability

Capability for server tasks operations.

classsrc.mistralai.client.models.servertaskscapability.ServerTasksCapabilityTypedDict

Capability for server tasks operations.

classsrc.mistralai.client.models.skilldefinition.SkillDefinition

Versioned skill content.

classsrc.mistralai.client.models.skilldefinition.SkillDefinitionTypedDict

Versioned skill content.

classsrc.mistralai.client.models.speech_v1_audio_speech_postop.SpeechResponse

Speech audio data.

classsrc.mistralai.client.models.speech_v1_audio_speech_postop.SpeechResponseTypedDict

Speech audio data.

classsrc.mistralai.client.models.speech_v1_audio_speech_postop.SpeechStreamEvents

Speech audio data.

classsrc.mistralai.client.models.speech_v1_audio_speech_postop.SpeechStreamEventsTypedDict

Speech audio data.

classsrc.mistralai.client.models.taskssamplingcapability.TasksSamplingCapability

Capability for tasks sampling operations.

classsrc.mistralai.client.models.taskssamplingcapability.TasksSamplingCapabilityTypedDict

Capability for tasks sampling operations.

classsrc.mistralai.client.models.taskstoolscapability.TasksToolsCapability

Capability for tasks tools operations.

classsrc.mistralai.client.models.taskstoolscapability.TasksToolsCapabilityTypedDict

Capability for tasks tools operations.

classsrc.mistralai.client.models.tempogettraceresponse.TempoGetTraceResponse

Trace response in OpenTelemetry format.

classsrc.mistralai.client.models.tempogettraceresponse.TempoGetTraceResponseTypedDict

Trace response in OpenTelemetry format.

classsrc.mistralai.client.models.textcontent.TextContent

Text content for a message.

classsrc.mistralai.client.models.textcontent.TextContentTypedDict

Text content for a message.

classsrc.mistralai.client.models.textresourcecontents.TextResourceContents

Text contents of a resource.

classsrc.mistralai.client.models.textresourcecontents.TextResourceContentsTypedDict

Text contents of a resource.

classsrc.mistralai.client.models.timeseriesmetric.TimeSeriesMetric

Time-series metric with timestamp-value pairs.

classsrc.mistralai.client.models.toolchoice.ToolChoice

ToolChoice is either a ToolChoiceEnum or a ToolChoice

classsrc.mistralai.client.models.toolexecution.ToolExecution

Execution-related properties for a tool.

classsrc.mistralai.client.models.toolexecution.ToolExecutionTypedDict

Execution-related properties for a tool.

classsrc.mistralai.client.models.toolscapability.ToolsCapability

Capability for tools operations.

classsrc.mistralai.client.models.toolscapability.ToolsCapabilityTypedDict

Capability for tools operations.

classsrc.mistralai.client.models.voicelistresponse.VoiceListResponse

Schema for voice list response

classsrc.mistralai.client.models.voicelistresponse.VoiceListResponseTypedDict

Schema for voice list response

classsrc.mistralai.client.models.voiceresponse.VoiceResponse

Schema for voice response

classsrc.mistralai.client.models.voiceresponse.VoiceResponseTypedDict

Schema for voice response

classsrc.mistralai.client.models.workflowmetrics.WorkflowMetrics

Complete metrics for a specific workflow.

classsrc.mistralai.client.models.workflowmetrics.WorkflowMetricsTypedDict

Complete metrics for a specific workflow.

classsrc.mistralai.client.models.workflowtaskfailedresponse.WorkflowTaskFailedResponse

Emitted when a workflow task fails.

classsrc.mistralai.client.models.workflowtaskfailedresponse.WorkflowTaskFailedResponseTypedDict

Emitted when a workflow task fails.

classsrc.mistralai.client.models.workflowtasktimedoutresponse.WorkflowTaskTimedOutResponse

Emitted when a workflow task times out.

classsrc.mistralai.client.models_.Models

Model Management API

classsrc.mistralai.client.ocr.Ocr

OCR API

classsrc.mistralai.client.transcriptions.Transcriptions

API for audio transcription.

funcsrc.mistralai.client.utils.annotations.get_field_discriminator(field:Any) -> Optional[str]

Search for the discriminator attribute in a given field.

classsrc.mistralai.extra.exceptions.DeferralReason

Reason why a tool call was deferred.

classsrc.mistralai.extra.exceptions.DeferredToolCallEntry

Represents a tool call that requires confirmation.

method

src.mistralai.extra.exceptions.DeferredToolCallEntry.from_dict(data:DeferredToolCallEntrySchema) -> DeferredToolCallEntry

Deserialize from a dictionary.

methodsrc.mistralai.extra.exceptions.DeferredToolCallEntry.reject(message:str='Rejected by user') -> DeferredToolCallRejection

Create a rejection response for this tool call.

methodsrc.mistralai.extra.exceptions.DeferredToolCallEntry.to_function_result(result:str) -> dict[str, str]

Convert to function result dict for use as input.

classsrc.mistralai.extra.exceptions.DeferredToolCallRejection

Response indicating tool should not be executed.

classsrc.mistralai.extra.exceptions.MCPAuthException

MCP authentication errors.

classsrc.mistralai.extra.exceptions.MCPException

MCP operation errors.

classsrc.mistralai.extra.exceptions.MistralClientException

Base exception for client errors.

classsrc.mistralai.extra.exceptions.RealtimeTranscriptionException

Base realtime transcription exception.

classsrc.mistralai.extra.exceptions.RunException

Conversation run errors.

classsrc.mistralai.extra.exceptions.WorkflowPayloadCompressionException

Workflow payload compression exception

classsrc.mistralai.extra.exceptions.WorkflowPayloadEncryptionException

Workflow payload encryption exception

classsrc.mistralai.extra.exceptions.WorkflowPayloadOffloadingException

Workflow payload offloading exception

classsrc.mistralai.extra.mcp.auth.OAuthParams

Required params for authorization.

classsrc.mistralai.extra.mcp.sse.MCPClientSSE

MCP client that uses sse for communication.

methodsrc.mistralai.extra.mcp.sse.MCPClientSSE.refresh_auth_token()

Refresh an expired token.

methodsrc.mistralai.extra.mcp.sse.MCPClientSSE.set_auth_token(token:OAuth2Token) -> None

classsrc.mistralai.extra.mcp.sse.SSEServerParams

Parameters required for a MCPClient with SSE transport

classsrc.mistralai.extra.mcp.stdio.MCPClientSTDIO

MCP client that uses stdio for communication.

classsrc.mistralai.extra.observability.redaction_policies.AttributeRedactionPolicy

Key-oriented hybrid policy.

classsrc.mistralai.extra.observability.redaction_policies.RedactionPolicy

Base class for redaction policies.

methodsrc.mistralai.extra.observability.redaction_policies.RedactionPolicy.redact_span_name(name:str) -> str

Return the span name to export.

method

src.mistralai.extra.observability.redaction_policies.RedactionPolicy.redact_status_description(description:str | None) -> str | None

Return the status description to export.

classsrc.mistralai.extra.observability.redaction_policies.RegexRedactionPolicy

Content-oriented policy based on regexes.

methodsrc.mistralai.extra.run.context.RunContext.get_tools() -> list[FunctionTool]

Get the tools that are part of the context.

methodsrc.mistralai.extra.run.context.RunContext.register_func(func:Callable, requires_confirmation:bool=False)

Add a function to the context.

method

src.mistralai.extra.run.context.RunContext.register_mcp_client(mcp_client:MCPClientProtocol, tool_configuration:dict[str, list[str]] | None=None) -> None

Add a MCP client to the context.

methodsrc.mistralai.extra.run.context.RunContext.requires_confirmation(tool_name:str) -> bool

Check if tool requires confirmation.

funcsrc.mistralai.extra.run.result.reconstitute_function_call_args(chunks:list[str]) -> FunctionCallEntryArguments

Recreates function call arguments from stream

classsrc.mistralai.extra.workflows.connector_slot.ConnectorBindings

Container for a list of connector bindings.

classsrc.mistralai.extra.workflows.encoding.storage.blob_storage.BlobNotFoundError

Raised when a blob is not found in storage.

About this data

These signatures were extracted from the public source of mistralai/client-python using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries