Change8

Migrating to Mistral Client v2.4.5

Version v2.4.5 introduces 5 breaking changes. This guide details how to update your code.

Released: 5/7/2026

5
Breaking Changes
5
Migration Steps
6
Affected Symbols

⚠️ Check Your Code

If you use any of these symbols, you need to read this guide:

mistral.workflows.executions.streammistral.workflows.events.get_stream_eventsmistral.workflows.events.get_workflow_eventsmistral.events.get_stream_eventsmistral.events.get_workflow_eventsmistral.beta.connectors.get_authentication_methods

Breaking Changes

Issue #1

The structure of the response for `mistral.workflows.executions.stream()` has changed. Specifically, the path `response.[].data.data.union(CustomTaskInProgressResponse).attributes.payload` is modified.

Issue #2

The structure of the response for `mistral.workflows.events.get_stream_events()` has changed in the `response.[].data.data` field.

Issue #3

The structure of the response for `mistral.workflows.events.get_workflow_events()` has changed in the `response.events[]` field.

Issue #4

The structure of the response for `mistral.events.get_stream_events()` has changed. Specifically, the path `response.[].data.data.union(CustomTaskInProgressResponse).attributes.payload` is modified.

Issue #5

The structure of the response for `mistral.events.get_workflow_events()` has changed in the `response.events[]` field.

Migration Steps

  1. 1
    Review and update code that consumes the response from `mistral.workflows.executions.stream()` to reflect the change in `response.[].data.data.union(CustomTaskInProgressResponse).attributes.payload`.
  2. 2
    Review and update code that consumes the response from `mistral.workflows.events.get_stream_events()` to reflect the change in `response.[].data.data`.
  3. 3
    Review and update code that consumes the response from `mistral.workflows.events.get_workflow_events()` to reflect the change in `response.events[]`.
  4. 4
    Review and update code that consumes the response from `mistral.events.get_stream_events()` to reflect the change in `response.[].data.data.union(CustomTaskInProgressResponse).attributes.payload`.
  5. 5
    Review and update code that consumes the response from `mistral.events.get_workflow_events()` to reflect the change in `response.events[]`.

Release Summary

This release introduces a new field in the authentication methods endpoint and contains several breaking changes related to response structures in workflow and event streaming/retrieval methods.

Need More Details?

View the full release notes and all changes for Mistral Client v2.4.5.

View Full Changelog