Inicie um fluxo de trabalho salvo conforme uma programação. Qualquer chave pode listar e ler agendamentos e iniciar um imediatamente; criar, alterar e excluir exige um proprietário ou administrador. Veja os agendamentos para saber como funcionam os inícios.
Criar um agendamento
POST
/v1/schedulesVerifica se o fluxo de trabalho resulta em uma execução que seria admitida agora e então salva o agendamento. Responde
201 com o agendamento.Corpo
workflowstringobrigatórioNome do fluxo de trabalho salvo a iniciar.
cronstringobrigatórioExpressão cron de cinco campos ou um atalho como
@daily ou @every 90m. No máximo uma vez por minuto.timezonestringFuso horário IANA em que a programação é interpretada, como
Europe/Madrid. Padrão: UTC.namestringUm rótulo para as pessoas. Até 128 caracteres.
inputany JSONEntrada de cada execução. Até 1 MiB.
max_cost_microsintegerOrçamento de cada execução. O orçamento padrão quando omitido.
skip_if_runningbooleanIgnora um início enquanto a execução anterior ainda está em andamento. Padrão:
true.enabledbooleanPadrão:
true.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
}'Campos do agendamento definidos pelo Ephemeral
next_run_atstring | nullO próximo início, em UTC.
null enquanto o agendamento está desativado.last_run_atstringQuando o agendamento venceu pela última vez.
last_run_idstringA última execução que ele iniciou.
last_errorstringPor que o último início foi ignorado ou falhou, ou por que o agendamento foi pausado. Vazio depois de um início bem-sucedido.
failuresintegerInícios com falha seguidos. Ao chegar a 5, o agendamento se desativa.
Pré-visualizar uma programação
POST
/v1/schedules/previewVerifica
cron e timezone e retorna os próximos cinco horários de início, sem salvar nada. Uma programação inválida retorna 400 com o motivo.{ "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"] }Listar agendamentos
GET
/v1/schedulesRetorna
{"items": [...]}, dos mais antigos aos mais recentes. Adicione ?workflow= para listar os agendamentos de um fluxo de trabalho.Obter um agendamento
GET
/v1/schedules/{id}Atualizar um agendamento
PATCH
/v1/schedules/{id}Envie qualquer um dos campos de criação; os demais permanecem como estão. Um novo
cron ou timezone faz o próximo início ser contado a partir de agora. Definir enabled como true em um agendamento pausado zera suas falhas.Iniciar agora
POST
/v1/schedules/{id}/runInicia o fluxo de trabalho agora, com a entrada e o orçamento do agendamento, fora da programação. Responde
202 com a execução, que traz o ID do agendamento.Excluir um agendamento
DELETE
/v1/schedules/{id}Responde
204. As execuções que ele iniciou mantêm o seu registro.Execuções de um agendamento
GET /v1/runs?schedule={id} lista as execuções que um agendamento iniciou, das mais recentes às mais antigas, com a mesma paginação de listar execuções.
Uma organização pode ter até 50 agendamentos.