A list of workflows
Workflows Endpoints
Examples
Real world code examples
Get Workflows
GET /v1/workflows
200
Successful Response
next_cursor
Playground
Test the endpoints live
curl https://api.mistral.ai/v1/workflows \
-X GET \
-H 'Authorization: Bearer YOUR_APIKEY_HERE'curl https://api.mistral.ai/v1/workflows \
-X GET \
-H 'Authorization: Bearer YOUR_APIKEY_HERE'200
{
"next_cursor": null,
"workflows": [
{
"archived": "false",
"display_name": "My workflow",
"id": "019b2bd7-96e7-7219-8c0b-45a73da50088",
"name": "My resource"
}
]
}{
"next_cursor": null,
"workflows": [
{
"archived": "false",
"display_name": "My workflow",
"id": "019b2bd7-96e7-7219-8c0b-45a73da50088",
"name": "My resource"
}
]
}Get Workflow Registrations
GET /v1/workflows/registrations
200
Successful Response
next_cursor
Playground
Test the endpoints live
curl https://api.mistral.ai/v1/workflows/registrations \
-X GET \
-H 'Authorization: Bearer YOUR_APIKEY_HERE'curl https://api.mistral.ai/v1/workflows/registrations \
-X GET \
-H 'Authorization: Bearer YOUR_APIKEY_HERE'200
{
"next_cursor": null,
"workflow_registrations": [
{
"definition": {
"input_schema": [
null
]
},
"id": "019b2bd7-96e7-7219-8c0b-45a73da50088",
"workflow_id": "019b2bd7-96e7-7219-8c0b-45a73da50088"
}
],
"workflow_versions": [
{
"definition": {
"input_schema": [
null
]
},
"id": "019b2bd7-96e7-7219-8c0b-45a73da50088",
"workflow_id": "019b2bd7-96e7-7219-8c0b-45a73da50088"
}
]
}{
"next_cursor": null,
"workflow_registrations": [
{
"definition": {
"input_schema": [
null
]
},
"id": "019b2bd7-96e7-7219-8c0b-45a73da50088",
"workflow_id": "019b2bd7-96e7-7219-8c0b-45a73da50088"
}
],
"workflow_versions": [
{
"definition": {
"input_schema": [
null
]
},
"id": "019b2bd7-96e7-7219-8c0b-45a73da50088",
"workflow_id": "019b2bd7-96e7-7219-8c0b-45a73da50088"
}
]
}Execute Workflow
POST /v1/workflows/{workflow_identifier}/execute
workflow_identifier
custom_tracing_attributes
deployment_name
Name of the deployment to route this execution to
execution_id
Allows you to specify a custom execution ID. If not provided, a random ID will be generated.
extensions
Plugin-specific data to propagate into WorkflowContext.extensions at execution time.
input
The input to the workflow. This should be a dictionary or a BaseModel that matches the workflow's input schema.
task_queue
Deprecated. Use deployment_name instead.
timeout_seconds
Maximum time to wait for completion when wait_for_result is true.
wait_for_result
Default Value: false
If true, wait for the workflow to complete and return the result directly.
200
Response Type
Successful Response
WorkflowExecutionResponse
WorkflowExecutionSyncResponse
Playground
Test the endpoints live
curl https://api.mistral.ai/v1/workflows/{workflow_identifier}/execute \
-X POST \
-H 'Authorization: Bearer YOUR_APIKEY_HERE' \
-H 'Content-Type: application/json' \
-d '{}'curl https://api.mistral.ai/v1/workflows/{workflow_identifier}/execute \
-X POST \
-H 'Authorization: Bearer YOUR_APIKEY_HERE' \
-H 'Content-Type: application/json' \
-d '{}'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"
}{
"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"
}Execute Workflow Registration
POST /v1/workflows/registrations/{workflow_registration_id}/execute
workflow_registration_id
custom_tracing_attributes
deployment_name
Name of the deployment to route this execution to
execution_id
Allows you to specify a custom execution ID. If not provided, a random ID will be generated.
extensions
Plugin-specific data to propagate into WorkflowContext.extensions at execution time.
input
The input to the workflow. This should be a dictionary or a BaseModel that matches the workflow's input schema.
task_queue
Deprecated. Use deployment_name instead.
timeout_seconds
Maximum time to wait for completion when wait_for_result is true.
wait_for_result
Default Value: false
If true, wait for the workflow to complete and return the result directly.
200
Response Type
Successful Response
WorkflowExecutionResponse
WorkflowExecutionSyncResponse
Playground
Test the endpoints live
curl https://api.mistral.ai/v1/workflows/registrations/{workflow_registration_id}/execute \
-X POST \
-H 'Authorization: Bearer YOUR_APIKEY_HERE' \
-H 'Content-Type: application/json' \
-d '{}'curl https://api.mistral.ai/v1/workflows/registrations/{workflow_registration_id}/execute \
-X POST \
-H 'Authorization: Bearer YOUR_APIKEY_HERE' \
-H 'Content-Type: application/json' \
-d '{}'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"
}{
"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
GET /v1/workflows/{workflow_identifier}
workflow_identifier
200
Successful Response
Playground
Test the endpoints live
curl https://api.mistral.ai/v1/workflows/{workflow_identifier} \
-X GET \
-H 'Authorization: Bearer YOUR_APIKEY_HERE'curl https://api.mistral.ai/v1/workflows/{workflow_identifier} \
-X GET \
-H 'Authorization: Bearer YOUR_APIKEY_HERE'200
{
"workflow": {
"active": "true",
"customer_id": "019b2bd7-96e7-7219-8c0b-45a73da50088",
"display_name": "My workflow",
"id": "019b2bd7-96e7-7219-8c0b-45a73da50088",
"name": "My resource",
"type": "code",
"workspace_id": "019b2bd7-96e7-7219-8c0b-45a73da50088"
}
}{
"workflow": {
"active": "true",
"customer_id": "019b2bd7-96e7-7219-8c0b-45a73da50088",
"display_name": "My workflow",
"id": "019b2bd7-96e7-7219-8c0b-45a73da50088",
"name": "My resource",
"type": "code",
"workspace_id": "019b2bd7-96e7-7219-8c0b-45a73da50088"
}
}Update Workflow
PUT /v1/workflows/{workflow_identifier}
workflow_identifier
available_in_chat_assistant
Whether to make the workflow available in the chat assistant
description
New description value
display_name
New display name value
tags
New tags. Replaces the existing tag list.
200
Successful Response
Playground
Test the endpoints live
curl https://api.mistral.ai/v1/workflows/{workflow_identifier} \
-X PUT \
-H 'Authorization: Bearer YOUR_APIKEY_HERE' \
-H 'Content-Type: application/json' \
-d '{}'curl https://api.mistral.ai/v1/workflows/{workflow_identifier} \
-X PUT \
-H 'Authorization: Bearer YOUR_APIKEY_HERE' \
-H 'Content-Type: application/json' \
-d '{}'200
{
"workflow": null
}{
"workflow": null
}Get Workflow Registration
GET /v1/workflows/registrations/{workflow_registration_id}
workflow_registration_id
with_workflow
Whether to include the workflow definition
include_shared
Whether to include shared workflow versions
200
Successful Response
Playground
Test the endpoints live
curl https://api.mistral.ai/v1/workflows/registrations/{workflow_registration_id} \
-X GET \
-H 'Authorization: Bearer YOUR_APIKEY_HERE'curl https://api.mistral.ai/v1/workflows/registrations/{workflow_registration_id} \
-X GET \
-H 'Authorization: Bearer YOUR_APIKEY_HERE'200
{
"workflow_registration": {
"active": "true",
"definition": {
"input_schema": [
null
]
},
"id": "019b2bd7-96e7-7219-8c0b-45a73da50088",
"workflow_id": "019b2bd7-96e7-7219-8c0b-45a73da50088"
},
"workflow_version": {
"active": "true",
"definition": {
"input_schema": [
null
]
},
"id": "019b2bd7-96e7-7219-8c0b-45a73da50088",
"workflow_id": "019b2bd7-96e7-7219-8c0b-45a73da50088"
}
}{
"workflow_registration": {
"active": "true",
"definition": {
"input_schema": [
null
]
},
"id": "019b2bd7-96e7-7219-8c0b-45a73da50088",
"workflow_id": "019b2bd7-96e7-7219-8c0b-45a73da50088"
},
"workflow_version": {
"active": "true",
"definition": {
"input_schema": [
null
]
},
"id": "019b2bd7-96e7-7219-8c0b-45a73da50088",
"workflow_id": "019b2bd7-96e7-7219-8c0b-45a73da50088"
}
}Bulk Archive Workflows
PUT /v1/workflows/archive
workflow_ids
List of workflow IDs to archive
200
Successful Response
errored
Workflows that could not be archived and the corresponding error messages
Playground
Test the endpoints live
curl https://api.mistral.ai/v1/workflows/archive \
-X PUT \
-H 'Authorization: Bearer YOUR_APIKEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"workflow_ids": [
"019b2bd7-96e7-7219-8c0b-45a73da50088"
]
}'curl https://api.mistral.ai/v1/workflows/archive \
-X PUT \
-H 'Authorization: Bearer YOUR_APIKEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"workflow_ids": [
"019b2bd7-96e7-7219-8c0b-45a73da50088"
]
}'200
{
"archived": [
null
]
}{
"archived": [
null
]
}Bulk Unarchive Workflows
PUT /v1/workflows/unarchive
workflow_ids
List of workflow IDs to unarchive
200
Successful Response
errored
Workflows that could not be archived and the corresponding error messages
Playground
Test the endpoints live
curl https://api.mistral.ai/v1/workflows/unarchive \
-X PUT \
-H 'Authorization: Bearer YOUR_APIKEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"workflow_ids": [
"019b2bd7-96e7-7219-8c0b-45a73da50088"
]
}'curl https://api.mistral.ai/v1/workflows/unarchive \
-X PUT \
-H 'Authorization: Bearer YOUR_APIKEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"workflow_ids": [
"019b2bd7-96e7-7219-8c0b-45a73da50088"
]
}'200
{
"unarchived": [
null
]
}{
"unarchived": [
null
]
}Archive Workflow
PUT /v1/workflows/{workflow_identifier}/archive
workflow_identifier
200
Successful Response
Playground
Test the endpoints live
curl https://api.mistral.ai/v1/workflows/{workflow_identifier}/archive \
-X PUT \
-H 'Authorization: Bearer YOUR_APIKEY_HERE' \
-H 'Content-Type: application/json'curl https://api.mistral.ai/v1/workflows/{workflow_identifier}/archive \
-X PUT \
-H 'Authorization: Bearer YOUR_APIKEY_HERE' \
-H 'Content-Type: application/json'200
{
"workflow": null
}{
"workflow": null
}Unarchive Workflow
PUT /v1/workflows/{workflow_identifier}/unarchive
workflow_identifier
200
Successful Response
Playground
Test the endpoints live
curl https://api.mistral.ai/v1/workflows/{workflow_identifier}/unarchive \
-X PUT \
-H 'Authorization: Bearer YOUR_APIKEY_HERE' \
-H 'Content-Type: application/json'curl https://api.mistral.ai/v1/workflows/{workflow_identifier}/unarchive \
-X PUT \
-H 'Authorization: Bearer YOUR_APIKEY_HERE' \
-H 'Content-Type: application/json'200
{
"workflow": null
}{
"workflow": null
}