Parar o turno de um run
Para o turno em andamento, como o botão de parar da conversa. O turno vivo no sandbox é parado, inclusive o que espera aprovação ou pergunta, em alguns segundos, e a conversa ganha a mensagem "Execução interrompida pelo usuário.". Depois disso, `GET /v1/runs/{runId}` responde `failed`. Idempotente: com o turno já terminado, ou a conversa esperando o cofre, responde `stopped: false`. Só para o turno com execução registrada no sandbox. Turno em andamento sem ela recebe 409 `run_not_stoppable`: o run síncrono, o de `callback_url` e o de canal conduzido pelo servidor não são interrompidos de fora. Um run de `/stream` ou `async: true` também recebe o 409 nos primeiros segundos, antes de registrar a execução; repetir o pedido logo depois para ele. Exige o escopo runs:execute.
Authorization
chaveDeApi Chave de API da organização, criada nas configurações. Envie-a em Authorization: Bearer <sua chave>.
In: header
Path Parameters
Identificador do run (o mesmo da conversa).
Header Parameters
Slug (ou id) de uma organização cliente do parceiro dono da chave. Aceito só em GET /v1/agents, POST /v1/agents/{agentId}/run, POST /v1/agents/{agentId}/stream, POST /v1/agents/{agentId}/threads, POST /v1/runs/{runId}/continue, GET /v1/runs/{runId}, POST /v1/runs/{runId}/stream, POST /v1/runs/{runId}/stop, POST /v1/runs/{runId}/plan e POST /v1/runs/{runId}/prewarm, e só com o escopo partner:execute: a operação roda dentro da organização cliente, como a identidade de sistema dela, sobre as cópias gerenciadas dos agentes do parceiro. Qualquer outra rota responde 400 org_header_not_supported. Organização que não existe ou não é cliente deste parceiro: 404 client_not_found.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/runs/string/stop"{ "run_id": "string", "stopped": true}Decidir o plano de um run
Aprova ou reprova o plano que um turno com `plan_mode: true` propôs. O `request_id` é o do evento `awaiting_input` com `kind: "plan"`, ou o de `pending_plan` em GET /v1/runs/{runId}. Aprovar grava a decisão, desliga o modo de plano e retoma a conversa para executar o plano, em segundo plano; o desfecho sai em GET /v1/runs/{runId}. O turno que propôs o plano precisa ter terminado: enquanto ele termina, a decisão responde 409 `turn_still_running` sem gravar nada, e quem chama tenta de novo em alguns segundos. Reprovar grava a recusa com a `note` e devolve a conversa ociosa, sem retomar o agente: o replanejamento é um turno novo de quem chamou, por POST /v1/runs/{runId}/continue ou /stream com `plan_mode: true` e a nota como `input`. Decide quem é aprovador do pedido ou quem configura o agente, avaliado como a pessoa dona da chave. Exige o escopo runs:execute.
Listar os artefatos de um run
Os artefatos que o agente publicou nesta conversa, do mais recente para o mais antigo, no máximo 200, sem os removidos. Só aparecem os que a pessoa dona da chave pode ver. Num canvas de design, cada artefato traz as pranchetas da versão atual, na ordem do canvas, com o tamanho e a âncora da prancheta inteira; nos outros tipos, `boards` vem vazio. Exige o escopo runs:read.