Workflows.Runs

June 19, 2026 · View on GitHub

Overview

Available Operations

list_runs - List Runs
get_run - Get Run
get_run_history - Get Run History

list_runs

List Runs

Example Usage

from mistralai.client import Mistral
import os


with Mistral(
    api_key=os.getenv("MISTRAL_API_KEY", ""),
) as mistral:

    res = mistral.workflows.runs.list_runs(order="desc", include_internal=True, page_size=50)

    while res is not None:
        # Handle items

        res = res.next()

Parameters

Parameter	Type	Required	Description
`workflow_identifier`	OptionalNullable[str]	:heavy_minus_sign:	Filter by workflow name or id
`root_execution_id`	OptionalNullable[str]	:heavy_minus_sign:	Filter by root execution id; returns the whole execution tree (the root and all its descendant sub-workflows).
`search`	OptionalNullable[str]	:heavy_minus_sign:	Search by workflow name, display name, or ID
`status`	OptionalNullable[models.ListRunsV1WorkflowsRunsGetStatus]	:heavy_minus_sign:	Filter by workflow status
`deployment_name`	OptionalNullable[str]	:heavy_minus_sign:	Filter by deployment name
`sort_by`	OptionalNullable[models.SortBy]	:heavy_minus_sign:	Field to sort by
`order`	Optional[models.ListRunsV1WorkflowsRunsGetOrder]	:heavy_minus_sign:	Sort direction
`start_time_after`	date	:heavy_minus_sign:	Include runs with start_time >= value
`start_time_before`	date	:heavy_minus_sign:	Include runs with start_time <= value
`end_time_after`	date	:heavy_minus_sign:	Include runs with end_time >= value. Running executions (no end_time) are excluded; use the status filter to include them.
`end_time_before`	date	:heavy_minus_sign:	Include runs with end_time <= value. Running executions (no end_time) are excluded; use the status filter to include them.
`user_id`	OptionalNullable[str]	:heavy_minus_sign:	Filter by user id. Use 'current' to filter by the authenticated user
`include_internal`	Optional[bool]	:heavy_minus_sign:	Include runs of internal/technical workflows (e.g. parallel-execution)
`page_size`	Optional[int]	:heavy_minus_sign:	Number of items per page
`next_page_token`	OptionalNullable[str]	:heavy_minus_sign:	Token for the next page of results
`retries`	Optional[utils.RetryConfig]	:heavy_minus_sign:	Configuration to override the default retry behavior of the client.

Response

models.ListRunsV1WorkflowsRunsGetResponse

Errors

Error Type	Status Code	Content Type
errors.HTTPValidationError	422	application/json
errors.SDKError	4XX, 5XX	/

get_run

Get Run

Example Usage

from mistralai.client import Mistral
import os


with Mistral(
    api_key=os.getenv("MISTRAL_API_KEY", ""),
) as mistral:

    res = mistral.workflows.runs.get_run(run_id="553b071e-3d04-46aa-aa9a-0fca61dc60fa")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
`run_id`	str	:heavy_check_mark:	N/A
`retries`	Optional[utils.RetryConfig]	:heavy_minus_sign:	Configuration to override the default retry behavior of the client.

Response

models.WorkflowExecutionResponse

Errors

Error Type	Status Code	Content Type
errors.HTTPValidationError	422	application/json
errors.SDKError	4XX, 5XX	/

get_run_history

Get Run History

Example Usage

from mistralai.client import Mistral
import os


with Mistral(
    api_key=os.getenv("MISTRAL_API_KEY", ""),
) as mistral:

    res = mistral.workflows.runs.get_run_history(run_id="f7296489-0212-4239-9e35-12fabfe8cd11", decode_payloads=True)

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
`run_id`	str	:heavy_check_mark:	N/A
`decode_payloads`	Optional[bool]	:heavy_minus_sign:	N/A
`retries`	Optional[utils.RetryConfig]	:heavy_minus_sign:	Configuration to override the default retry behavior of the client.

Response

Any

Errors

Error Type	Status Code	Content Type
errors.HTTPValidationError	422	application/json
errors.SDKError	4XX, 5XX	/