Pular para o conteúdo principal
POST
Stop a Run
  • Antes do dispatch: o Run é interrompido sem cobrança. Um prazo de sincronização expirado produz FAILED com TIMED_OUT.
  • Após o dispatch: o Run continua; seu Price determina a cobrança final.
  • Já concluído: a solicitação retorna 409.

Parâmetros de caminho

runId
string<uuid>
obrigatório
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$

Resposta

Success

id
string
obrigatório
run_url
string
obrigatório

Abra este Run no console. Requer associação ao Workspace.

provider
string
obrigatório
Pattern: ^[a-z0-9][a-z0-9-]*$
endpoint
string
obrigatório
Pattern: ^\/.+$
endpoint_version
integer
obrigatório
status
enum<string>
obrigatório

QUEUED ou RUNNING: ainda em andamento. COMPLETED: uma resposta do provedor de dados está disponível, incluindo respostas não 2xx. FAILED: consulte failure. STOPPED: interrompido antes do dispatch. Leia charge_usd separadamente do status.

Opções disponíveis:
QUEUED,
RUNNING,
COMPLETED,
FAILED,
STOPPED
failure
object | null
obrigatório

Motivo da falha do Run. Não nulo somente quando o status é FAILED.

input
object
obrigatório
output
any
obrigatório
provider_response
object | null
obrigatório

Não nulo somente quando o status é COMPLETED.

  • Para respostas 2xx, output contém JSON nativo do provedor de dados (qualquer estrutura) ou null para um corpo vazio.
  • Para respostas não 2xx, error contém o corpo de erro do provedor de dados e output é null.

Campos confidenciais são removidos de ambos os corpos.

charge_usd
string | null
obrigatório

Cobrança final como uma string decimal exata em USD. Null enquanto estiver QUEUED ou RUNNING. Um Run FAILED pode ter uma cobrança diferente de zero conforme o Price do endpoint.

Pattern: ^(0|[1-9]\d*)\.(\d{2}|\d{2}\d{0,3}[1-9])$
charge_basis
object | null
obrigatório

Cláusula de Price usada para calcular a cobrança. Null antes da liquidação ou quando nenhuma tentativa ao provedor de dados foi feita.

stoppable
boolean
obrigatório

Indica se uma solicitação de interrupção pode ser aceita no momento. Isso não garante que o Run possa ser interrompido antes do dispatch.

stop_requested_at
string<date-time> | null
obrigatório

Quando uma interrupção foi solicitada. O Run ainda pode continuar se o dispatch já tiver começado.

created_at
string<date-time>
obrigatório

Carimbo de data e hora UTC ISO-8601

started_at
string<date-time> | null
obrigatório

Carimbo de data e hora UTC ISO-8601

completed_at
string<date-time> | null
obrigatório

Carimbo de data e hora UTC ISO-8601

task_id
string | null
obrigatório
metadata
object
obrigatório

Seus campos de acompanhamento armazenados. Use-os para filtrar Runs. Eles nunca são enviados ao provedor de dados nem afetam o roteamento, o Price ou a idempotência.

  • Até 20 chaves: letras minúsculas, dígitos e sublinhados; comece com uma letra; no máximo 40 caracteres.
  • Valores: strings de 1–500 caracteres.
  • user_id: o ID opaco do seu usuário final, nunca o endereço de e-mail ou o nome dele.