Iniciar uma execução de workflow

Inicie um fluxo de trabalho com suas entradas e receba de volta um id de execução.

POST {base_url}/workflow-runs

Requer runs:write.

Requisição

POST {base_url}/workflow-runs
Authorization: Bearer mor_live_…
Content-Type: application/json

{
  "org_id": "0192f3c1-7a44-7d10-9b22-1e5c8f0a3b61",
  "project_id": "0192f3c2-4b18-7e93-8c07-9d2a6f4e1c58",
  "workflow_id": "0192f3c3-9d21-7c44-b8e1-5a7f2c9d4e10",
  "workflow_version_id": "0192f3c4-1a02-7bb3-9f40-2c6e8d1a5b77",
  "idempotency_key": "story-48213-v2",
  "inputs": {
    "story_document": "https://cdn.example.com/stories/48213.pdf",
    "character_sheets": [
      "https://cdn.example.com/chars/48213-a.png",
      "https://cdn.example.com/chars/48213-b.png"
    ],
    "episode_count": 8,
    "tone": "thriller"
  }
}
Campo do corpoNecessárioSignificado
org_idsimsua organização; deve corresponder à chave
project_idsima tela em que a execução e seus ativos são colocados — o id na URL do Studio, …/editor/<project_id>/canvas
workflow_idsimo workflow a ser executado
inputssimum objeto indexado pela chave
idempotency_keyrecomendadotorna uma nova tentativa segura — veja Convenções
workflow_version_idnãofixa a versão da qual você lê as entradas
webhook_idnãoenvia os eventos desta execução para um endpoint registrado — veja Webhooks

Como enviar cada entrada

aceitaEnviarCom allow_multiple
valora própria string, número ou booleanoum array deles
urlum único link HTTPS público, como uma stringum array de links
opçãouma options[].id, exatamente como fornecidoum array de ids

Resposta

202 Aceito

{
  "run": {
    "id": "0192f3d0-6c31-7a52-b4e8-3f9d1a7c5e20",
    "status": "na fila",
    "workflow_id": "0192f3c3-9d21-7c44-b8e1-5a7f2c9d4e10",
    "workflow_version_id": "0192f3c4-1a02-7bb3-9f40-2c6e8d1a5b77",
    "project_id": "0192f3c2-4b18-7e93-8c07-9d2a6f4e1c58",
    "chat_id": "0192f3c6-2e75-7b14-9a63-7c4e2d8f1b09",
    "ingested": [
      { "input": "story_document", "bytes": 184320, "mime_type": "application/pdf" },
      { "input": "character_sheets", "bytes": 962144, "mime_type": "image/png" },
      { "input": "character_sheets", "bytes": 883021, "mime_type": "image/png" }
    ],
    "poll_after_seconds": 60,
    "expires_at": "2026-09-23T04:10:00Z"
  }
}
Campo de respostaSignificado
ido id da execução. Faça polling dele e mantenha-o junto ao seu próprio registro
statusna fila na aceitação
chat_ida sessão do Studio em que a execução acontece. Abra-a para acompanhar a execução ou responder a uma pergunta que ela fizer
ingesteduma entrada por arquivo obtido, na ordem enviada. Útil para confirmar que você enviou o que pretendia
poll_after_secondsquanto tempo esperar antes da primeira consulta
expires_atquando uma execução inacabada é abandonada como expirada

Cada link é obtido e verificado antes de o 202. Uma execução que retorna aceita já tem seus arquivos em mãos, então um link inválido gera um 400 imediato, em vez de uma falha dez minutos depois.

Nesta página