Cancelar Execução de Workflow

Solicitar o cancelamento de uma execução de workflow em andamento, na fila ou pausada. Cancelar uma execução que já está em um estado terminal tem sucesso sem efeito algum. Uma execução produzida por um grupo de workflow de table é um 409 quando a célula dela não pode mais aceitar o cancelamento.

POST/api/v2/workflows/{workflowId}/runs/{runId}/cancel

Authorization

X-API-Key<token>

Sua API key do Studio, pessoal ou com escopo de workspace. Gere uma em Settings e depois API Keys. As operações que rejeitam API keys de workspace dizem isso na própria descrição.

Em: header

Parâmetros de path

workflowId*string

Identificador único do workflow.

Tamanho1 <= length
runId*string

Identificador único da execução de workflow.

Corresponde a^[A-Za-z0-9._:-]+$
Tamanho1 <= length <= 128

Corpo da resposta

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://agent-studio.seeyu.ai/api/v2/workflows/string/runs/run_8f14e45f-ceea-467f-a/cancel" \  -H "X-API-Key: YOUR_API_KEY"
{
  "data": {
    "success": true,
    "runId": "run_8f14e45f-ceea-467f-a",
    "redisAvailable": true,
    "durablyRecorded": true,
    "locallyAborted": true,
    "pausedCancelled": false,
    "reason": "recorded"
  }
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "Invalid request"
  }
}
{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication required"
  }
}
{
  "error": {
    "code": "FORBIDDEN",
    "message": "Insufficient workspace permissions",
    "details": {
      "code": "INSUFFICIENT_WORKSPACE_ROLE"
    }
  }
}
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Not found"
  }
}
{
  "error": {
    "code": "CONFLICT",
    "message": "Webhook path already in use"
  }
}
{
  "error": {
    "code": "RATE_LIMITED",
    "message": "API rate limit exceeded",
    "details": {
      "retryAfter": "2026-01-01T00:00:30.000Z"
    }
  }
}
{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal server error"
  }
}
{
  "error": {
    "code": "SERVICE_UNAVAILABLE",
    "message": "Service temporarily unavailable"
  }
}
POSTRetomar Execução de WorkflowGETObter Log