Référence de l'API

Planifications

Créer, prévisualiser, mettre en pause et lancer des planifications.

Lancez un workflow enregistré selon un calendrier. Toutes les clés peuvent lister et lire les planifications et en lancer une immédiatement ; les créer, les modifier et les supprimer exige un propriétaire ou un administrateur. Voir planifications pour le fonctionnement des lancements.

Créer une planification

POST/v1/schedules
Vérifie que le workflow se résout en une exécution qui serait admise maintenant, puis enregistre la planification. Répond 201 avec la planification.
Corps
workflowstringobligatoire
Nom du workflow enregistré à lancer.
cronstringobligatoire
Expression cron à cinq champs, ou raccourci tel que @daily ou @every 90m. Au plus une fois par minute.
timezonestring
Fuseau horaire IANA dans lequel le calendrier est interprété, par exemple Europe/Madrid. UTC par défaut.
namestring
Un libellé pour les humains. 128 caractères au maximum.
inputany JSON
Entrée de chaque exécution. 1 Mio au maximum.
max_cost_microsinteger
Budget de chaque exécution. Le budget par défaut en son absence.
skip_if_runningboolean
Ignore un lancement tant que l'exécution précédente est encore en cours. true par défaut.
enabledboolean
true par défaut.
curl -X POST $EPHEMERAL_URL/v1/schedules \
  -H "Authorization: Bearer $EPHEMERAL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "workflow": "welcome-new-customers",
    "name": "Weekday welcome emails",
    "cron": "0 9 * * 1-5",
    "timezone": "Asia/Tokyo",
    "input": { "signed_up": "yesterday" },
    "max_cost_micros": 200000
  }'
Champs de la planification définis par Ephemeral
next_run_atstring | null
Le prochain lancement, en UTC. null tant que la planification est désactivée.
last_run_atstring
La dernière fois que la planification est arrivée à échéance.
last_run_idstring
La dernière exécution lancée.
last_errorstring
Pourquoi le dernier lancement a été ignoré ou a échoué, ou pourquoi la planification s'est mise en pause. Vide après un lancement réussi.
failuresinteger
Échecs de lancement consécutifs. À 5, la planification se désactive d'elle-même.

Prévisualiser un calendrier

POST/v1/schedules/preview
Vérifie cron et timezone et renvoie les cinq prochains horaires de lancement, sans rien enregistrer. Un calendrier invalide renvoie 400 avec le motif.
JSON
{ "next": ["2026-10-05T00:00:00Z", "2026-10-06T00:00:00Z", "2026-10-07T00:00:00Z", "2026-10-08T00:00:00Z", "2026-10-09T00:00:00Z"] }

Lister les planifications

GET/v1/schedules
Renvoie {"items": [...]}, les plus anciennes d'abord. Ajoutez ?workflow= pour lister les planifications d'un workflow.

Lire une planification

GET/v1/schedules/{id}

Modifier une planification

PATCH/v1/schedules/{id}
Envoyez n'importe lequel des champs de création ; les autres restent inchangés. Un nouveau cron ou timezone recalcule le prochain lancement à partir de maintenant. Définir enabled sur true pour une planification en pause remet ses échecs à zéro.

Lancer maintenant

POST/v1/schedules/{id}/run
Lance le workflow maintenant avec l'entrée et le budget de la planification, en dehors du calendrier. Répond 202 avec l'exécution, qui porte l'ID de la planification.

Supprimer une planification

DELETE/v1/schedules/{id}
Répond 204. Les exécutions qu'elle a lancées conservent leur historique.

Exécutions d'une planification

GET /v1/runs?schedule={id} liste les exécutions lancées par une planification, les plus récentes d'abord, avec la même pagination que pour lister les exécutions.

Une organisation peut avoir jusqu'à 50 planifications.
© 2026 EphemeralRéalisé par erni.works
esc

Aucun résultat pour « ».