pypi / mistralai
mistralai
What changed in mistralai 2 to 3, from its official release notes, upgrade guides and advisories. Sources checked 2026-11-12.
198 breaking1 security2 deprecations178 new APIs and options8 behavior and defaults3 fixes and other
See which of these apply to your code, ranked, in your agent:
npx @unstale/cli initmistralai 3124 changes
Breaking changes 48
The context field is now required on the existing beta model.
The gender field now uses VoiceGender instead of str.
The slug field was removed from voice creation requests.
Beta managed-index operations were removed, including listing, creation, search, document ingestion, and index-summary operations.
Removed the definitions and description fields from pipeline_configs[] responses to update_pipeline, get_pipeline, and create_pipeline.
Removed the detection, export, judge, and moderation enum values; the corresponding v1 values were added.
Removed this beta operation for creating a pipeline configuration.
The response definition no longer includes DetectionDefinition, ExportDefinition, JudgeDefinition, or ModerationDefinition; it includes their V1 variants instead.
Removed this beta operation for deleting a pipeline configuration.
Removed this beta operation for retrieving a pipeline configuration.
The response definition no longer includes DetectionDefinition, ExportDefinition, JudgeDefinition, or ModerationDefinition; it includes their V1 variants instead.
Removed this beta operation for listing pipeline configurations.
The response definition no longer includes DetectionDefinition, ExportDefinition, JudgeDefinition, or ModerationDefinition; it includes their V1 variants instead.
Removed this beta operation for updating a pipeline configuration.
The response definition no longer includes DetectionDefinition, ExportDefinition, JudgeDefinition, or ModerationDefinition; it includes their V1 variants instead.
Removed this field from the beta connector update request.
Authentication fields and parameters previously typed as OutboundAuthenticationType now use AuthenticationType across beta models and connector requests.
slug is now required on the existing beta Dataset model.
slug is now required on the existing beta DatasetPreview model.
The beta field type changed from Records to DatasetsRecords.
optimizations is now required on the existing beta Evaluations model.
projects is now required on the existing beta Evaluations model.
records is now required on the existing beta Evaluations model.
runs is now required on the existing beta Evaluations model.
Removed Records and its bulk_delete, delete, fetch, judge, update_payload, and update_properties methods from the beta surface.
Removed Runs and its get_run, get_run_async, get_run_history, get_run_history_async, list_runs, and list_runs_async methods from the stable API surface.
Removed this field from HTTP and MCP connector responses and from the corresponding beta connector model surface.
The stable field type changed from Runs to WorkflowsRuns.
Adds a connector credentials deletion operation, replacing the separate workspace, organization, and user deletion operations.
The Koyeb deployment backend is replaced by DeploymentMistralCloudBackendSpec.
Introduces the replacement deployment backend spec for the mistral_cloud backend.
The SDK now uses HTTPX2; clients passed as client= or async_client= and raw requests, responses, and transport errors must use httpx2 types.
The code_interpreter, web_search, and web_search_premium tool variants are no longer accepted; use these tools through the Conversations API or an agent.
The code_interpreter, web_search, and web_search_premium tool variants are no longer accepted; use these tools through the Conversations API or an agent.
Removed in favor of delete_credentials().
Removed in favor of delete_credentials().
Removed in favor of delete_credentials().
The fetch_customer_data request field has been removed.
The active field has been removed from request query_filters.
The page request field has been removed.
The request now requires definition; the definitions request field has been removed.
The request now requires definition; the definitions request field has been removed.
The code_interpreter, web_search, and web_search_premium tool variants are no longer accepted; use these tools through the Conversations API or an agent.
The code_interpreter, web_search, and web_search_premium tool variants are no longer accepted; use these tools through the Conversations API or an agent.
Request resource fields cpu_limit, cpu_request, memory_limit, and memory_request have been removed.
Request resource fields cpu_limit, cpu_request, memory_limit, and memory_request have been removed.
Introduces the renamed type for unknown deployment backend specs.
This type is renamed UnknownBackendSpec.
Deprecations 1
This beta operation is deprecated.
New APIs and options 70
Workflow deployment responses now include archive_id, and deployment creation and update requests accept it.
Connector list, create, get, and update responses now include openapi_spec.
Workflow deployment responses now include requested_roles.
The response now includes the kind field.
The response now includes the spec field.
Adds an operation for adding tags to workflows.
Deployment creation requests now accept archive_id.
Adds an operation for retrieving a deployment archive.
Deployment update requests now accept archive_id.
Beta observability logs, traces, and spans responses now include service_account_id.
Added min_tokens, repetition_penalty, top_k, top_logprobs, and top_prompt_logprobs request fields, plus logprobs and prompt_logprobs request and response fields.
Added the sampling request field.
Added sampling to the response.
Added slug to the response.
Added a beta operation to search pipeline results.
Added a beta operation for retrieving the current user's identity.
Added the logprobs request and response fields.
Added the min_tokens request field.
Added prompt_logprobs as a request and response field.
Added the repetition_penalty request field.
Added the top_k request field.
Added the top_logprobs request field.
Added the top_prompt_logprobs request field.
Added logprobs and prompt_logprobs response fields.
Added this enum value to file list and upload requests and file list, upload, and retrieve responses.
Added this enum value across beta observability judges, datasets, evaluations, logs, traces, and spans operations.
Added this content variant to chat, agent, and classifier requests, and chat, FIM, and agent responses.
Added a beta API operation to get an evaluation.
Added a beta API operation to list evaluations.
Added a beta API operation to get an evaluation optimization.
Added a beta API operation to list evaluation optimizations.
Added a beta API operation to list optimization trials.
Added a beta API operation to get an evaluation project.
Added a beta API operation to list evaluation projects.
Added a beta API operation to get an evaluation record.
Added a beta API operation to search evaluation records.
Added a beta API operation to compute evaluation run statistics.
Added a beta API operation to get an evaluation run.
Added a beta API operation to get evaluation run statistics.
Added a beta API operation to search evaluation runs.
Added a beta API operation to search all evaluation runs.
Added a slug response field to beta observability dataset list, create, fetch, and update operations.
The definitions field is now optional in beta pipeline updates.
The selectors field is now optional in beta pipeline updates.
Added this request field to get_workflow_registrations.
Adds a client that calls connectors directly through the Connectors Gateway; gateway failures raise ConnectorsGatewayError.
Adds a client that calls connectors directly through the Connectors Gateway; gateway failures raise ConnectorsGatewayError.
Gateway failures from the new direct connector clients raise this error.
Adds mistral_mcp as a request and response enum value across the listed chat, agents, conversations, classifiers, and FIM APIs.
Mistral() can authenticate using a service-account token at the path specified by this environment variable.
Adds an operation to search audio voices.
Adds the client_scopes request field.
Adds the client_scopes request field.
Adds an operation to import datasets from spans.
Adds an operation to create an evaluation pipeline.
Adds an operation to delete an evaluation pipeline.
Adds an operation to get an evaluation pipeline.
Adds an operation to list evaluation pipelines.
Adds an operation to update an evaluation pipeline.
Adds an operation to aggregate span evaluations.
Adds an operation to get a managed-index chunk.
Adds a grep operation for managed indexes.
Adds creator_id, name, and status request fields for filtering managed indexes.
Adds a navigate operation for managed indexes.
Adds a read operation for managed indexes.
Adds the max_candidates request field and rrf request variant.
Adds order and q request fields.
Adds the log_type request field.
Adds the owner request field.
Adds an operation to unharden a workflow deployment.
Behavior and default changes 5
The github_url request field changed to allow nullable or omitted values.
Changed the sample_audio request field type from str to OptionalNullable[str].
This beta connector request field is now nullable and optional.
The enabled field is now optional in beta pipeline updates.
The name field is now optional in beta pipeline updates.
mistralai 2266 changes
Breaking changes 150
Removed definition and replaced it with required definitions.
CreatePipelineConfigRequest now requires definitions, a list of PipelineConfigDefinition values.
DeploymentDetailResponse now requires last_heartbeat.
DeploymentResponse now requires last_heartbeat.
DeploymentWorkerResponse now requires last_heartbeat.
HTTPConnector now requires supports_mcp.
Removed the model field; JudgeDefinition now requires slug and may include mapping.
Removed the prompt field; JudgeDefinition now requires slug and may include mapping.
JudgeDefinition now requires slug.
Removed the group query parameter.
MCPConnector now requires supports_mcp.
Or is an object again, with type and matches, rather than a union alias.
Removed definition and replaced it with required definitions.
Removed definition_hash from PipelineConfig.
PipelineConfig now requires definitions, a list of PipelineConfigDefinition values.
Removed group from PipelineConfig.
Removed slug from PipelineConfig.
Rag now requires managed_indexes.
Removed definition and replaced it with required definitions.
UpdatePipelineConfigRequest now requires definitions, a list of PipelineConfigDefinition values.
VoiceResponse now requires type.
Workflow execution and task event responses now require nullable chain_run_id.
search_keys values are now nullable.
search_keys values are now nullable.
search_keys values are now nullable.
search_keys values are now nullable.
Removed the campaigns.create API.
Removed the campaigns.delete API.
Removed the campaigns.fetch API.
Removed the campaigns.fetch_status API.
Removed the campaigns.list API.
Removed the campaigns.list_events API.
Removed the chatcompletionevents.fetch API.
Removed the chatcompletionevents.fetch_similar_events API.
Removed the chatcompletionevents.judge API.
Removed the chatcompletionevents.search API.
Removed the chatcompletionevents.search_ids API.
Connector is now a union of HTTPConnector and MCPConnector, discriminated on protocol; variant-specific fields now live on each variant.
connectors.create now takes a single request object instead of named arguments.
Removed the connectors.create_or_update_organization_credentials API.
Removed the connectors.create_or_update_user_credentials API.
Removed the connectors.create_or_update_workspace_credentials API.
The create payload now requires protocol in TypeScript; it no longer defaults to mcp. Python still defaults it.
connectors.update now takes a request_body; named arguments are no longer accepted.
Removed the datasets.import_from_campaign API.
Removed the datasets.import_from_explorer API.
Three fields are now required.
Removed the fields.fetch_option_counts API.
Removed the fields.fetch_options API.
Removed the fields.list API.
Removed the service_tier field.
The response field changed in a breaking change.
The response field changed in a breaking change.
The response field changed in a breaking change.
The response field changed in a breaking change.
The response field changed in a breaking change.
The request.name field changed in this breaking update.
The request.name field changed in this breaking update.
The list operation's response array changed.
The register operation's response changed.
The get_schedules operation's response.schedules array changed.
The request.id field was removed from mistral.ocr.process().
The completion event results’ extra_fields type now includes Map<string>.
The response’s extra_fields type now includes Map<string>.
The completion event results’ extra_fields type now includes Map<string>.
The completion event results’ extra_fields type now includes Map<string>.
The request no longer includes encoded_input.
The request no longer includes encoded_input.
The request metadata changed, which may require updates to speech completion requests.
The successful response changed, which may require updates to sample-audio consumers.
Request and response metadata changed, which may require updates to agent creation calls and their consumers.
The response metadata changed, which may require updates to code consuming agents.
The response metadata changed, which may require updates to code consuming agent versions.
Listed agent metadata changed, which may require updates to consumers.
Listed agent version metadata changed, which may require updates to consumers.
Request and response metadata changed, which may require updates to agent update calls and their consumers.
The response metadata changed, which may require updates to code consuming agent versions.
The response no longer includes tools.
The response no longer includes tools.
Listed connector items no longer include tools.
The response no longer includes tools.
The response changed, which may require updates to code consuming conversations.
The response changed, which may require updates to code consuming conversation lists.
The request changed; conversation output also adds ThinkChunk.signature.
The request changed; streamed conversation output also adds ThinkChunk.signature.
The request changed; conversation output also adds ThinkChunk.signature.
The request changed; streamed conversation output also adds ThinkChunk.signature.
The request changed, which may require updates to document text-content calls.
The response changed, which may require updates to code consuming workflow execution trace events.
The response changed, which may require updates to code consuming workflow execution trace data.
The response changed, which may require updates to code consuming workflow execution trace summaries.
The workflow_registrations response items changed, which may require updates to consumers.
The streaming response delta changed for chat.stream(), fim.stream(), and agents.stream().
The response field changed for chat.complete(), agents.complete(), and fim.complete(); the notes mark this as breaking.
The response.choices[] field changed.
The request changed; the notes mark this as a breaking change.
The response.pages[] field changed.
The request.event_source field changed.
This error response field changed across beta observability operations.
The tool-call type field in the classify-chat request changed.
The tool-call type field in the moderate-chat request changed.
The tool-call type field changed in FIM completion responses.
The tool-call type field changed in FIM stream responses.
The response field changed, which may require updates to code consuming fine-tuned job data.
The response field changed, which may require updates to code consuming fine-tuned job data.
The request input field changed; callers may need to update their workflow execution input.
The request input field changed; callers may need to update their workflow execution input.
The workflow_registration response changed, which may require updates to consumers.
The workflow registrations response field changed.
The whoami workflow worker API was removed.
The request changed; callers may need to update how they construct requests.
The response.choices[] field changed.
The request.tools[] field changed, which may require updates to agent-creation requests.
The response.tools[] field changed, which may require updates to agent-creation response handling.
The response.tools[] field changed, which may require updates to agent response handling.
The response.tools[] field changed, which may require updates to agent-version response handling.
The agent-list response tools[] field changed, which may require updates to response handling.
The agent-version list response tools[] field changed, which may require updates to response handling.
The request.tools[] field changed, which may require updates to agent-update requests.
The response.tools[] field changed, which may require updates to agent-update response handling.
The response.tools[] field changed, which may require updates to agent-version response handling.
The conversation response tools[] field changed, which may require updates to response handling.
The conversation-list response tools[] field changed, which may require updates to response handling.
The request.tools[] field changed, which may require updates to conversation-start requests.
The request.tools[] field changed, which may require updates to conversation-start stream requests.
The request changed; callers may need to update how they construct requests.
The response.choices[] field changed, which may require updates to chat completion response handling.
The response.choices[] field changed.
The response.choices[] field changed in a breaking way.
The response.choices[] field changed in a breaking way.
The response.choices[] field changed in a breaking way.
The request changed in a breaking way; callers may need to update their request construction.
The request changed; callers may need to update how they construct requests.
The request changed in a breaking way; callers may need to update their request construction.
The response changed in a breaking way; callers may need to update their handling.
The response changed in a breaking way; callers may need to update their handling.
The response changed in a breaking way; callers may need to update their handling.
The response items changed in a breaking way; callers may need to update their handling.
The response items changed in a breaking way; callers may need to update their handling.
The request changed in a breaking way; callers may need to update their request construction.
The response changed in a breaking way; callers may need to update their handling.
The response changed in a breaking way; callers may need to update their handling.
The response changed in a breaking way; callers may need to update their handling.
The response items changed in a breaking way; callers may need to update their handling.
The request changed in a breaking way; callers may need to update their request construction.
The request changed in a breaking way; callers may need to update their request construction.
The request changed in a breaking way; callers may need to update their request construction.
The request changed in a breaking way; callers may need to update their request construction.
The request changed in a breaking way; callers may need to update their request construction.
The request changed; callers may need to update how they construct requests.
Security 1
Activating OpenTelemetry now redacts most PII and secrets using a default regex-based policy while retaining observability value.
Deprecations 1
Deployment models now emit a DeprecationWarning for updated_at; use last_heartbeat instead.
New APIs and options 108
JudgeDefinition may now include an optional mapping of strings to strings.
Added the managed index creation API operation.
Added the managed index deletion API operation.
Added the managed index document deletion API operation.
Added the API operation to retrieve a managed index.
Added the managed index document ingestion API operation.
Added the API operation to list managed indexes.
Added the managed index search API operation.
Added the managed index update API operation.
Added the connectors.create_credentials API.
Added the connectors.share_to_organization API.
Added the connectors.unshare_from_organization API.
Added the connectors.update_credentials API.
Added the evaluations.create_pipeline_config API.
Added the evaluations.delete_pipeline_config API.
Added the evaluations.get_pipeline_config API.
Added the evaluations.list_pipeline_configs API.
Added the evaluations.update_pipeline_config API.
Added the serviceaccounts.create API.
Added the serviceaccounts.delete API.
Added the serviceaccounts.get API.
Added the serviceaccounts.list API.
Added the serviceaccounts.list_assignable_roles API.
Added the serviceaccounts.list_roles API.
Added the serviceaccounts.set_roles API.
Added the serviceaccounts.update API.
The response adds the has_default_credentials field.
Added request.pipeline_composition to register ingestion pipeline configurations.
Added the update_run_info operation for ingestion pipeline configurations.
Added the pause_schedule operation for workflow schedules.
Added the resume_schedule operation for workflow schedules.
Added request.schedule.max_executions to workflow scheduling requests.
Added the register() method for RAG ingestion pipeline configurations.
The request adds the prompt_cache_key field.
The request adds the prompt_cache_key field.
The connector create request and response add a title field.
The connector response adds a title field.
Connector list items add a title field.
The connector update request and response add a title field.
The request adds the prompt_cache_key field.
The request adds the prompt_cache_key field.
The request adds the prompt_cache_key field.
The request adds the prompt_cache_key field.
The request changed; response content also adds the thinking signature field.
The request changed; streamed response content also adds the thinking signature field.
Adds an API for creating or updating organization credentials for connectors.
Adds an API for creating or updating user credentials for connectors.
Adds an API for creating or updating workspace credentials for connectors.
Adds an API for deleting organization credentials for connectors.
Adds an API for deleting user credentials for connectors.
Adds an API for deleting workspace credentials for connectors.
The request adds credentials_name.
Adds an API for retrieving connector authentication methods.
Adds an API for listing organization credentials for connectors.
The request adds credentials_name.
Adds an API for listing user credentials for connectors.
Adds an API for listing workspace credentials for connectors.
Conversation append inputs and outputs add ThinkChunk.signature.
Conversation history entries add ThinkChunk.signature.
Conversation messages add ThinkChunk.signature.
Library creation requests add the owner_type field.
Field definitions add the enum(map) type.
Adds an API for listing RAG ingestion pipeline configurations.
The request changed; response content also adds the thinking signature field.
The request changed; streamed response content also adds the thinking signature field.
Chat classification inputs add the thinking chunk signature field.
Chat moderation inputs add the thinking chunk signature field.
Workflow execution started events add attributes.display_name.
Workflow execution started events add attributes.display_name.
The request changed; response content also adds the thinking signature field.
The request changed; streamed response content also adds the thinking signature field.
Workflow responses add on_behalf_of.
Deployment responses add location.
Deployment list items add location.
Workflow execution started events add attributes.display_name.
Workflow execution started events add attributes.display_name.
Execution requests add extensions, and the response adds run_id.
Execution requests add extensions, and the response adds run_id.
Workflow execution responses add run_id.
Workflow execution started events add attributes.display_name.
Workflow responses add on_behalf_of.
Run responses add run_id.
Run listing requests add user_id, and execution results add run_id.
Workflow responses add on_behalf_of.
Workflow responses add on_behalf_of.
The get_deployment() response adds the is_active field to workers.
Added the API for listing tools from beta connectors.
Adds an API to complete audio speech.
Adds an API to create an audio voice.
Adds an API to delete an audio voice.
Adds an API to get an audio voice.
Adds an API to get sample audio for a voice.
Adds an API to list audio voices.
Adds an API to update audio voices.
The request completion arguments add reasoning_effort.
The request completion arguments add reasoning_effort.
The model list response adds capabilities.reasoning.
The model retrieval response adds capabilities.reasoning.
Added request.reasoning_effort to agent completion requests.
Added request.reasoning_effort to agent streaming requests.
Added an API to get an authentication URL.
Added request.reasoning_effort to chat completion requests.
Added request.reasoning_effort to chat streaming requests.
Added request.guardrails to agents.complete() requests.
Added request.guardrails to agents.stream() requests.
Added judge_conversation() to the Python SDK.
Added request.guardrails to chat.complete() requests.
Added request.guardrails to chat.stream() requests.
Behavior and default changes 3
workspace_id is now optional.
authorization_endpoint is now optional.
The request for beta.libraries.list() changed.
Fixes and other changes 3
And is an object again, with type and matches, rather than a union alias.
Transcription segment end is now nullable, allowing diarized transcriptions with a null value to parse.
Transcription segment start is now nullable, allowing diarized transcriptions with a null value to parse.