Skip to content

README.md

Latest commit

 

History

History
139 lines (90 loc) · 8.93 KB

README.md

File metadata and controls

139 lines (90 loc) · 8.93 KB

Workflows.Runs

Overview

Available Operations

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(page_size=50)

    while res is not None:
        # Handle items

        res = res.next()

Parameters

Parameter Type Required Description
workflow_identifier OptionalNullable[str] ➖ Filter by workflow name or id
search OptionalNullable[str] ➖ Search by workflow name, display name or id
status OptionalNullable[models.ListRunsV1WorkflowsRunsGetStatus] ➖ Filter by workflow status
page_size Optional[int] ➖ Number of items per page
next_page_token OptionalNullable[str] ➖ Token for the next page of results
retries Optional[utils.RetryConfig] ➖ 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 ✔️ N/A
retries Optional[utils.RetryConfig] ➖ 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 ✔️ N/A
decode_payloads Optional[bool] ➖ N/A
retries Optional[utils.RetryConfig] ➖ 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 */*
⚡