Une liste de workflows
Workflows
Exemples
Exemples réels de code
Obtenir les Workflows
GET /v1/workflows
200
Réponse réussie
next_cursor
Playground
Testez les endpoints en direct
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"
}
]
}Obtenir les inscriptions de workflow
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": "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"
}
]
}Exécuter un workflow
POST /v1/workflows/{workflow_identifier}/execute
workflow_identifier
custom_tracing_attributes
deployment_name
Nom du déploiement vers lequel acheminer cette exécution
execution_id
Permet de spécifier un ID d'exécution personnalisé. Si non fourni, un ID aléatoire sera généré.
extensions
Données spécifiques au plugin à propager dans WorkflowContext.extensions au moment de l'exécution.
input
L'entrée du workflow. Il doit s'agir d'un dictionnaire ou d'un BaseModel correspondant au schéma d'entrée du workflow.
task_queue
Déprécié. Utilisez deployment_name à la place.
timeout_seconds
Temps maximum d'attente pour l'achèvement lorsque wait_for_result est vrai.
wait_for_result
Default Value: false
Si vrai, attendre la fin du workflow et retourner 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/{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"
}Exécuter l'inscription de workflow
POST /v1/workflows/registrations/{workflow_registration_id}/execute
workflow_registration_id
custom_tracing_attributes
deployment_name
Nom du déploiement vers lequel acheminer cette exécution
execution_id
Permet de spécifier un ID d'exécution personnalisé. Si non fourni, un ID aléatoire sera généré.
extensions
Données spécifiques au plugin à propager dans WorkflowContext.extensions au moment de l'exécution.
input
L'entrée du workflow. Il doit s'agir d'un dictionnaire ou d'un BaseModel correspondant au schéma d'entrée du workflow.
task_queue
Déprécié. Utilisez deployment_name à la place.
timeout_seconds
Temps maximum d'attente pour l'achèvement lorsque wait_for_result est vrai.
wait_for_result
Default Value: false
Si vrai, attendre la fin du workflow et retourner 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": "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"
}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": "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"
}
}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 chat
description
Nouvelle valeur de description
display_name
Nouvelle valeur du nom d'affichage
tags
Nouveaux tags. Remplace la liste de tags existante.
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
}Obtenir l'inscription de workflow
GET /v1/workflows/registrations/{workflow_registration_id}
workflow_registration_id
with_workflow
Indique si la définition du workflow doit être incluse
include_shared
Indique si les versions partagées des workflows doivent être incluses
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": "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"
}
}Archivage en masse des Workflows
PUT /v1/workflows/archive
workflow_ids
Liste des IDs de workflow à archiver
200
Réponse réussie
errored
Workflows qui n'ont pas pu être archivés et les messages d'erreur correspondants
Playground
Testez les endpoints en direct
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
]
}Désarchiver des workflows en masse
PUT /v1/workflows/unarchive
workflow_ids
Liste des IDs de workflow à désarchiver
200
Réponse réussie
errored
Workflows qui n'ont pas pu être archivés et les messages d'erreur correspondants
Playground
Testez les endpoints en direct
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
]
}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
}