La spec OpenAPI
Home
Tree BG 1
Tree
Tree
TreeLeaves
TreeLeaves
Cat IdleGrassGrassRockRock

Planifications des workflows

Obtenir les planifications

GET /v1/workflows/schedules

200

Réponse réussie

next_page_token
string|null

Jeton pour la page suivante des résultats

schedules
*array<ScheduleDefinitionOutput>

Une liste des planifications de workflow

Playground

Testez les endpoints en direct

curl https://api.mistral.ai/v1/workflows/schedules \
 -X GET \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE'

200

{
  "schedules": [
    {
      "input": "Example input.",
      "paused": false,
      "schedule_id": "019b2bd7-96e7-7219-8c0b-45a73da50088",
      "workflow_name": "support-workflow"
    }
  ]
}

Planifier un workflow

POST /v1/workflows/schedules

201

Réponse réussie

schedule_id
*string

L'ID de la planification

Playground

Testez les endpoints en direct

curl https://api.mistral.ai/v1/workflows/schedules \
 -X POST \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json' \
 -d '{
  "schedule": {
    "input": "Example input."
  }
}'

201

{
  "schedule_id": "019b2bd7-96e7-7219-8c0b-45a73da50088"
}

Obtenir une planification

GET /v1/workflows/schedules/{schedule_id}

200

Réponse réussie

calendars
array<ScheduleCalendar>

Spécification basée sur un calendrier des horaires.

cron_expressions
array<string>

Spécification basée sur une expression cron des horaires.

end_at
date-time|null

Heure après laquelle aucune autre action ne sera exécutée.

future_executions
array<ScheduleFutureExecution>

Exécutions planifiées à venir (10 prochaines exécutions, de la plus ancienne à la plus récente).

input
*any

Entrée à fournir au workflow lors de son démarrage.

intervals
array<ScheduleInterval>

Spécification basée sur un intervalle des horaires.

jitter
string|null

Gigue à appliquer à chaque action.

L'heure planifiée d'une action sera incrémentée d'une valeur aléatoire comprise entre 0 et cette valeur si elle est présente (mais pas au-delà de la prochaine planification).

note
string|null

Note lisible par l'humain associée à l'état actuel de pause ou de reprise.

paused
*boolean

Indique si la planification est actuellement en pause.

policy
SchedulePolicy
recent_executions
array<ScheduleRecentExecution>

Exécutions planifiées les plus récentes (10 plus récentes, de la plus ancienne à la plus récente).

remaining_executions
integer|null

Exécutions restantes du workflow avant que cette planification ne cesse de se déclencher automatiquement. null signifie illimité ; 0 signifie que la limite a été atteinte et que la planification est épuisée.

schedule_id
*string

Identifiant unique pour la planification.

skip
array<ScheduleCalendar>

Spécification basée sur un calendrier des horaires.

start_at
date-time|null

Heure après laquelle la première action peut être exécutée.

time_zone_name
string|null

Nom de fuseau horaire IANA, par exemple US/Central.

workflow_name
*string

Nom du workflow déclenché par cette planification.

Playground

Testez les endpoints en direct

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

200

{
  "input": "Example input.",
  "paused": false,
  "schedule_id": "019b2bd7-96e7-7219-8c0b-45a73da50088",
  "workflow_name": "support-workflow"
}

Annuler la planification d'un workflow

DELETE /v1/workflows/schedules/{schedule_id}

Playground

Testez les endpoints en direct

curl https://api.mistral.ai/v1/workflows/schedules/{schedule_id} \
 -X DELETE \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json'

Mettre à jour une planification

PATCH /v1/workflows/schedules/{schedule_id}

200

Réponse réussie

schedule_id
*string

L'ID de la planification

Playground

Testez les endpoints en direct

curl https://api.mistral.ai/v1/workflows/schedules/{schedule_id} \
 -X PATCH \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json' \
 -d '{
  "schedule": {}
}'

200

{
  "schedule_id": "019b2bd7-96e7-7219-8c0b-45a73da50088"
}

Mettre en pause une planification

POST /v1/workflows/schedules/{schedule_id}/pause

Playground

Testez les endpoints en direct

curl https://api.mistral.ai/v1/workflows/schedules/{schedule_id}/pause \
 -X POST \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json' \
 -d 'null'

Reprendre une planification

POST /v1/workflows/schedules/{schedule_id}/resume

Playground

Testez les endpoints en direct

curl https://api.mistral.ai/v1/workflows/schedules/{schedule_id}/resume \
 -X POST \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json' \
 -d 'null'

Déclencher une planification

POST /v1/workflows/schedules/{schedule_id}/trigger

Playground

Testez les endpoints en direct

curl https://api.mistral.ai/v1/workflows/schedules/{schedule_id}/trigger \
 -X POST \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json' \
 -d 'null'