Download OpenAPI Spec
Home
Tree BG 1
Tree
Tree
TreeLeaves
TreeLeaves
Cat IdleGrassGrassRockRock

Workflows Executions Endpoints

Get Workflow Execution

GET /v1/workflows/executions/{execution_id}

200

Successful Response

end_time
*date-time|null

The end time of the workflow execution, if available

execution_id
*string

The ID of the workflow execution

parent_execution_id
string|null

The parent execution ID of the workflow execution

result
*any|null

The result of the workflow execution, if available

root_execution_id
*string

The root execution ID of the workflow execution

run_id
string|null

The unique run identifier (database UUID)

start_time
*date-time

The start time of the workflow execution

status
*"RUNNING"|"COMPLETED"|"FAILED"|"CANCELED"|"TERMINATED"|"CONTINUED_AS_NEW"|"TIMED_OUT"|"RETRYING_AFTER_ERROR"

The status of the workflow execution

total_duration_ms
integer|null

The total duration of the trace in milliseconds

workflow_name
*string

The name of the workflow

Playground

Test the endpoints live

curl https://api.mistral.ai/v1/workflows/executions/{execution_id} \
 -X GET \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE'

200

{
  "end_time": null,
  "execution_id": "019b2bd7-96e7-7219-8c0b-45a73da50088",
  "result": null,
  "root_execution_id": "019b2bd7-96e7-7219-8c0b-45a73da50088",
  "start_time": "2025-12-17T10:25:07.818693Z",
  "status": "RUNNING",
  "workflow_name": "support-workflow"
}

Get Workflow Execution History

GET /v1/workflows/executions/{execution_id}/history

200

Response Type
any

Successful Response

Playground

Test the endpoints live

curl https://api.mistral.ai/v1/workflows/executions/{execution_id}/history \
 -X GET \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE'

200

null

Signal Workflow Execution

POST /v1/workflows/executions/{execution_id}/signals

202

Successful Response

message
string

Default Value: "Signal accepted"

Playground

Test the endpoints live

curl https://api.mistral.ai/v1/workflows/executions/{execution_id}/signals \
 -X POST \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json' \
 -d '{
  "name": "approve"
}'

202

{}

Query Workflow Execution

POST /v1/workflows/executions/{execution_id}/queries

200

Successful Response

query_name
*string
result
*any

The result of the Query workflow call

Playground

Test the endpoints live

curl https://api.mistral.ai/v1/workflows/executions/{execution_id}/queries \
 -X POST \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json' \
 -d '{
  "name": "get_progress"
}'

200

{
  "query_name": "status",
  "result": null
}

Terminate Workflow Execution

POST /v1/workflows/executions/{execution_id}/terminate

Playground

Test the endpoints live

curl https://api.mistral.ai/v1/workflows/executions/{execution_id}/terminate \
 -X POST \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json'

Batch Terminate Workflow Executions

POST /v1/workflows/executions/terminate

200

Successful Response

results
map<BatchExecutionResult>

Mapping of execution_id to result with status and optional error message

Playground

Test the endpoints live

curl https://api.mistral.ai/v1/workflows/executions/terminate \
 -X POST \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json' \
 -d '{
  "execution_ids": [
    "approved"
  ]
}'

200

{}

Cancel Workflow Execution

POST /v1/workflows/executions/{execution_id}/cancel

Playground

Test the endpoints live

curl https://api.mistral.ai/v1/workflows/executions/{execution_id}/cancel \
 -X POST \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json'

Batch Cancel Workflow Executions

POST /v1/workflows/executions/cancel

200

Successful Response

results
map<BatchExecutionResult>

Mapping of execution_id to result with status and optional error message

Playground

Test the endpoints live

curl https://api.mistral.ai/v1/workflows/executions/cancel \
 -X POST \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json' \
 -d '{
  "execution_ids": [
    "approved"
  ]
}'

200

{}

Reset Workflow

POST /v1/workflows/executions/{execution_id}/reset

Playground

Test the endpoints live

curl https://api.mistral.ai/v1/workflows/executions/{execution_id}/reset \
 -X POST \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json' \
 -d '{
  "event_id": 87
}'

Update Workflow Execution

POST /v1/workflows/executions/{execution_id}/updates

200

Successful Response

result
*any

The result of the Update workflow call

update_name
*string

Playground

Test the endpoints live

curl https://api.mistral.ai/v1/workflows/executions/{execution_id}/updates \
 -X POST \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json' \
 -d '{
  "name": "status_update"
}'

200

{
  "result": null,
  "update_name": "status_update"
}

Get Workflow Execution Trace Otel

GET /v1/workflows/executions/{execution_id}/trace/otel

200

Successful Response

data_source
*string

The data source of the trace

end_time
*date-time|null

The end time of the workflow execution, if available

execution_id
*string

The ID of the workflow execution

otel_trace_data
TempoGetTraceResponse|null

Trace response in OpenTelemetry format.

This is the unified trace format used across all trace providers (Tempo, ClickHouse, etc.). Regardless of the underlying backend, all trace data is normalized to this Tempo-compatible OpenTelemetry format to ensure consistency in the API response structure.

otel_trace_id
string|null

The ID of the trace

parent_execution_id
string|null

The parent execution ID of the workflow execution

result
*any|null

The result of the workflow execution, if available

root_execution_id
*string

The root execution ID of the workflow execution

run_id
string|null

The unique run identifier (database UUID)

start_time
*date-time

The start time of the workflow execution

status
*"RUNNING"|"COMPLETED"|"FAILED"|"CANCELED"|"TERMINATED"|"CONTINUED_AS_NEW"|"TIMED_OUT"|"RETRYING_AFTER_ERROR"

The status of the workflow execution

total_duration_ms
integer|null

The total duration of the trace in milliseconds

workflow_name
*string

The name of the workflow

Playground

Test the endpoints live

curl https://api.mistral.ai/v1/workflows/executions/{execution_id}/trace/otel \
 -X GET \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE'

200

{
  "data_source": "workflow-trace",
  "end_time": null,
  "execution_id": "019b2bd7-96e7-7219-8c0b-45a73da50088",
  "result": null,
  "root_execution_id": "019b2bd7-96e7-7219-8c0b-45a73da50088",
  "start_time": "2025-12-17T10:25:07.818693Z",
  "status": "RUNNING",
  "workflow_name": "support-workflow"
}

Get Workflow Execution Trace Summary

GET /v1/workflows/executions/{execution_id}/trace/summary

200

Successful Response

end_time
*date-time|null

The end time of the workflow execution, if available

execution_id
*string

The ID of the workflow execution

parent_execution_id
string|null

The parent execution ID of the workflow execution

result
*any|null

The result of the workflow execution, if available

root_execution_id
*string

The root execution ID of the workflow execution

run_id
string|null

The unique run identifier (database UUID)

span_tree
WorkflowExecutionTraceSummarySpan|null

The root span of the trace

start_time
*date-time

The start time of the workflow execution

status
*"RUNNING"|"COMPLETED"|"FAILED"|"CANCELED"|"TERMINATED"|"CONTINUED_AS_NEW"|"TIMED_OUT"|"RETRYING_AFTER_ERROR"

The status of the workflow execution

total_duration_ms
integer|null

The total duration of the trace in milliseconds

workflow_name
*string

The name of the workflow

Playground

Test the endpoints live

curl https://api.mistral.ai/v1/workflows/executions/{execution_id}/trace/summary \
 -X GET \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE'

200

{
  "end_time": null,
  "execution_id": "019b2bd7-96e7-7219-8c0b-45a73da50088",
  "result": null,
  "root_execution_id": "019b2bd7-96e7-7219-8c0b-45a73da50088",
  "start_time": "2025-12-17T10:25:07.818693Z",
  "status": "RUNNING",
  "workflow_name": "support-workflow"
}

Get Workflow Execution Trace Events

GET /v1/workflows/executions/{execution_id}/trace/events

200

Successful Response

end_time
*date-time|null

The end time of the workflow execution, if available

events
array<WorkflowExecutionTraceEvent|WorkflowExecutionProgressTraceEvent>

The events of the workflow execution

execution_id
*string

The ID of the workflow execution

parent_execution_id
string|null

The parent execution ID of the workflow execution

result
*any|null

The result of the workflow execution, if available

root_execution_id
*string

The root execution ID of the workflow execution

run_id
string|null

The unique run identifier (database UUID)

start_time
*date-time

The start time of the workflow execution

status
*"RUNNING"|"COMPLETED"|"FAILED"|"CANCELED"|"TERMINATED"|"CONTINUED_AS_NEW"|"TIMED_OUT"|"RETRYING_AFTER_ERROR"

The status of the workflow execution

total_duration_ms
integer|null

The total duration of the trace in milliseconds

workflow_name
*string

The name of the workflow

Playground

Test the endpoints live

curl https://api.mistral.ai/v1/workflows/executions/{execution_id}/trace/events \
 -X GET \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE'

200

{
  "end_time": null,
  "execution_id": "019b2bd7-96e7-7219-8c0b-45a73da50088",
  "result": null,
  "root_execution_id": "019b2bd7-96e7-7219-8c0b-45a73da50088",
  "start_time": "2025-12-17T10:25:07.818693Z",
  "status": "RUNNING",
  "workflow_name": "support-workflow"
}

Stream

GET /v1/workflows/executions/{execution_id}/stream

200

Response Type
event-stream<ResponseBody>

Stream of Server-Sent Events (SSE)

ResponseBody

{object}

Playground

Test the endpoints live

curl https://api.mistral.ai/v1/workflows/executions/{execution_id}/stream \
 -X GET \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE'

200

null

Get Workflow Execution Logs

GET /v1/workflows/executions/{execution_id}/logs

Retrieve logs for a workflow execution from Dora.

First page sets the window via after/before (default: execution start through now, both widened by a margin so the bounds still prune partitions); later pages pass cursor, which carries both the window and the sort order (so after/before/order are then ignored — the order is fixed at the first page so a client can't flip direction mid-pagination).

200

Successful Response

next_cursor
string|null
results
*array<ExecutionLogRecord>

Playground

Test the endpoints live

curl https://api.mistral.ai/v1/workflows/executions/{execution_id}/logs \
 -X GET \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE'

200

{
  "results": [
    {
      "body": "ipsum eiusmod",
      "log_attributes": [
        "consequat do"
      ],
      "severity_text": "reprehenderit ut dolore",
      "span_id": "occaecat dolor sit",
      "timestamp": "2025-12-17T10:25:07.818693Z",
      "trace_id": "019b2bd7-96e7-7219-8c0b-45a73da50088"
    }
  ]
}

Stream Workflow Execution Logs

GET /v1/workflows/executions/{execution_id}/logs/stream

Stream logs for a workflow execution via SSE.

If last_event_id is set it resumes from that cursor and takes precedence over after; otherwise after sets a fresh stream's start point (omit both to tail from the execution start).

200

Response Type
event-stream<ResponseBody>

Stream of Server-Sent Events (SSE): log events carry an ExecutionLogRecord; error events carry a StreamError payload.

ResponseBody

{object}

Playground

Test the endpoints live

curl https://api.mistral.ai/v1/workflows/executions/{execution_id}/logs/stream \
 -X GET \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE'

200

null