Fluxos de trabalho · Documentação da Ephemeral

Salve definições de execução com um nome e inicie-as com POST /v1/runs. Chaves de membro e de administrador podem usar todos os endpoints desta página. Veja os fluxos de trabalho para saber como os campos salvos e as substituições se combinam.

Salvar um fluxo de trabalho

PUT/v1/workflows/{name}

Cria o fluxo de trabalho ou o substitui, se o nome já existir. Os nomes começam com uma letra ou um dígito e contêm até 128 letras, dígitos, _, . ou -.

Corpo

promptstringobrigatório

A tarefa. Até 128 KiB.

modelstring

ID do modelo. Quando omitido, cada execução usa o modelo padrão do momento em que é criada.

filesarray

Entradas de arquivo, como em uma requisição de execução. Os nomes são resolvidos quando cada execução é criada.

connectionsobject

Conexões identificadas pelo nome que o agente vê. Prefira entradas {"ref": "<saved name>"}.

descriptionstring

O que o fluxo de trabalho faz e qual entrada ele espera. Até 500 caracteres.

input_schemaobject

Um JSON Schema com o qual o input de cada execução deve corresponder; uma execução que não corresponde é recusada com 400. Veja descrever a entrada e a saída.

output_schemaobject

Um JSON Schema com o qual a saída de cada execução deve corresponder; a saída então é JSON, e uma execução cuja saída não corresponde falha. Veja descrever a entrada e a saída.

timeout_secondsinteger

De 1 a 3600. As execuções usam 300 quando omitido.

shellboolean

As execuções usam true quando omitido.

webboolean | object

Acesso à web para as execuções do fluxo de trabalho: true ou um objeto com allow e search. Desativado quando omitido.

Um fluxo de trabalho não pode conter input, max_cost_micros nem callback; eles pertencem a cada execução. A resposta é {"name": "investigate-payment"}.

curl -X PUT $EPHEMERAL_URL/v1/workflows/investigate-payment \
  -H "Authorization: Bearer $EPHEMERAL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "Find out why this payment failed. Follow the playbook.",
    "model": "anthropic/claude-haiku-5.5",
    "files": [{ "file": "playbook.md" }],
    "connections": { "payments": { "ref": "payments-api", "allowed_methods": ["GET"] } },
    "timeout_seconds": 120,
    "shell": false
  }'

Iniciar um fluxo de trabalho

Envie o nome do fluxo de trabalho para POST /v1/runs com a entrada e o orçamento desta execução. Qualquer campo de definição que você incluir substitui o valor salvo nesta execução; files e connections substituem a coleção inteira.

Terminal

curl $EPHEMERAL_URL/v1/runs \
  -H "Authorization: Bearer $EPHEMERAL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"workflow":"investigate-payment","input":{"payment_id":"pay_123"},"max_cost_micros":500000}'

Se o fluxo de trabalho não existir, a requisição falha com 400 e a mensagem saved workflow not found.

Listar fluxos de trabalho

GET/v1/workflows

Retorna os fluxos de trabalho da organização em ordem alfabética, cada um como um objeto com seu name. Adicione ?detail=true para incluir a description, o input_schema e o output_schema de cada fluxo de trabalho que os tiver. Busque um fluxo de trabalho pelo nome para ver sua definição completa.

JSON

[{ "name": "investigate-payment" }, { "name": "weekly-report" }]

Com ?detail=true, um agente vê o que cada fluxo de trabalho espera e retorna:

JSON

[
  {
    "name": "weather",
    "description": "Current weather for a city. Input is a city name.",
    "input_schema": { "type": "object", "required": ["city"], "properties": { "city": { "type": "string" } } },
    "output_schema": { "type": "object", "required": ["city", "temperature_c", "summary"] }
  },
  { "name": "weekly-report" }
]

Obter um fluxo de trabalho

GET/v1/workflows/{name}

Retorna a definição salva. As credenciais das conexões em linha são removidas, e os valores de consulta nas URLs são mascarados.

Para editar um fluxo de trabalho, busque-o, altere-o e salve-o de volta com PUT. Os campos de credenciais que você deixar vazios mantêm os valores armazenados, desde que o tipo de autenticação da conexão não mude.

Excluir um fluxo de trabalho

DELETE/v1/workflows/{name}

Exclui o fluxo de trabalho e retorna 204 No Content. As execuções que já o usaram não são afetadas.

Os fluxos de trabalho não têm versões. Salvar ou excluir um passa a valer para a próxima execução que o citar.