Liste des enregistrements de workflows
Endpoints Beta Workflows
API de gestion des workflows.
Exemples
Exemples réels de code
Obtenir les enregistrements de workflows
GET /v1/workflows/registrations
200
Réponse réussie
next_cursor
Playground
Testez les endpoints en direct
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": "ipsum eiusmod",
"task_queue": "consequat do",
"workflow_id": "reprehenderit ut dolore"
}
],
"workflow_versions": [
{
"definition": {
"input_schema": [
null
]
},
"id": "occaecat dolor sit",
"task_queue": "nostrud",
"workflow_id": "aute aliqua aute commodo"
}
]
}{
"next_cursor": null,
"workflow_registrations": [
{
"definition": {
"input_schema": [
null
]
},
"id": "ipsum eiusmod",
"task_queue": "consequat do",
"workflow_id": "reprehenderit ut dolore"
}
],
"workflow_versions": [
{
"definition": {
"input_schema": [
null
]
},
"id": "occaecat dolor sit",
"task_queue": "nostrud",
"workflow_id": "aute aliqua aute commodo"
}
]
}Exécuter un workflow
POST /v1/workflows/{workflow_identifier}/execute
workflow_identifier
custom_tracing_attributes
deployment_name
Nom du déploiement vers lequel router cette exécution
encoded_input
Entrée encodée du workflow, utilisée lorsque l'encodage de la charge utile est activé.
execution_id
Vous permet de spécifier un ID d'exécution personnalisé. Si non fourni, un ID aléatoire sera généré.
input
L'entrée du workflow. Doit correspondre au schéma d'entrée du workflow.
task_queue
Obsolète. Utilisez deployment_name à la place.
timeout_seconds
Durée maximale d'attente de la complétion lorsque wait_for_result est true.
wait_for_result
Valeur par défaut : false
Si true, attend la complétion du workflow et retourne directement le résultat.
200
Response Type
Réponse réussie
WorkflowExecutionResponse
WorkflowExecutionSyncResponse
Playground
Testez les endpoints en direct
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": "ipsum eiusmod",
"result": null,
"root_execution_id": "consequat do",
"start_time": "2025-10-07T20:56:01.974Z",
"status": "RUNNING",
"workflow_name": "reprehenderit ut dolore"
}{
"end_time": null,
"execution_id": "ipsum eiusmod",
"result": null,
"root_execution_id": "consequat do",
"start_time": "2025-10-07T20:56:01.974Z",
"status": "RUNNING",
"workflow_name": "reprehenderit ut dolore"
}Exécuter l'enregistrement de workflow
POST /v1/workflows/registrations/{workflow_registration_id}/execute
workflow_registration_id
custom_tracing_attributes
deployment_name
Nom du déploiement vers lequel router cette exécution
encoded_input
Entrée encodée du workflow, utilisée lorsque l'encodage de la charge utile est activé.
execution_id
Vous permet de spécifier un identifiant d'exécution personnalisé. Si non fourni, un identifiant aléatoire sera généré.
input
L'entrée du workflow. Il doit s'agir d'un dictionnaire correspondant au schéma d'entrée du workflow.
task_queue
Déprécié. Utilisez deployment_name à la place.
timeout_seconds
Durée maximale d'attente pour l'achèvement lorsque wait_for_result est true.
wait_for_result
Valeur par défaut : false
Si true, attend que le workflow se termine et renvoie le résultat directement.
200
Response Type
Réponse réussie
WorkflowExecutionResponse
WorkflowExecutionSyncResponse
Playground
Testez les endpoints en direct
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": "ipsum eiusmod",
"result": null,
"root_execution_id": "consequat do",
"start_time": "2025-10-07T20:56:01.974Z",
"status": "RUNNING",
"workflow_name": "reprehenderit ut dolore"
}{
"end_time": null,
"execution_id": "ipsum eiusmod",
"result": null,
"root_execution_id": "consequat do",
"start_time": "2025-10-07T20:56:01.974Z",
"status": "RUNNING",
"workflow_name": "reprehenderit ut dolore"
}Obtenir un workflow
GET /v1/workflows/{workflow_identifier}
workflow_identifier
200
Réponse réussie
Playground
Testez les endpoints en direct
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": false,
"customer_id": "ipsum eiusmod",
"display_name": "consequat do",
"id": "reprehenderit ut dolore",
"name": "occaecat dolor sit",
"type": "code",
"workspace_id": "nostrud"
}
}{
"workflow": {
"active": false,
"customer_id": "ipsum eiusmod",
"display_name": "consequat do",
"id": "reprehenderit ut dolore",
"name": "occaecat dolor sit",
"type": "code",
"workspace_id": "nostrud"
}
}Mettre à jour un workflow
PUT /v1/workflows/{workflow_identifier}
workflow_identifier
available_in_chat_assistant
Indique si le workflow doit être disponible dans l'assistant de conversation
description
Nouvelle valeur de description
display_name
Nouvelle valeur du nom d'affichage
200
Réponse réussie
Playground
Testez les endpoints en direct
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
}Récupérer un enregistrement de workflow
GET /v1/workflows/registrations/{workflow_registration_id}
workflow_registration_id
with_workflow
Indique s'il faut inclure la définition du workflow
include_shared
Indique s'il faut inclure les versions de workflow partagées
200
Réponse réussie
Playground
Testez les endpoints en direct
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": false,
"definition": {
"input_schema": [
null
]
},
"id": "ipsum eiusmod",
"task_queue": "consequat do",
"workflow_id": "reprehenderit ut dolore"
},
"workflow_version": {
"active": false,
"definition": {
"input_schema": [
null
]
},
"id": "occaecat dolor sit",
"task_queue": "nostrud",
"workflow_id": "aute aliqua aute commodo"
}
}{
"workflow_registration": {
"active": false,
"definition": {
"input_schema": [
null
]
},
"id": "ipsum eiusmod",
"task_queue": "consequat do",
"workflow_id": "reprehenderit ut dolore"
},
"workflow_version": {
"active": false,
"definition": {
"input_schema": [
null
]
},
"id": "occaecat dolor sit",
"task_queue": "nostrud",
"workflow_id": "aute aliqua aute commodo"
}
}Archiver un workflow
PUT /v1/workflows/{workflow_identifier}/archive
workflow_identifier
200
Réponse réussie
Playground
Testez les endpoints en direct
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
}Désarchiver un workflow
PUT /v1/workflows/{workflow_identifier}/unarchive
workflow_identifier
200
Réponse réussie
Playground
Testez les endpoints en direct
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
}