Interromper uma ferramenta a bordo ou uma chamada LLM

POSTAR /api/v1/projects/{id}/executions/{execution_id}/interrupt

Cancela a ferramenta a bordo ou as chamadas LLM para uma execução sem cancelar a sessão, para que o agente continue. Enviar step_number para interromper uma única chamada nomeada; omita o corpo para interromper todas as chamadas atualmente em andamento. O resultado da resposta relata exatamente o que aconteceu: "aborted" (algo no voo foi parado), "armado" (nada na fuga; armada para a próxima chamada da execução, pending=true), "already_armed" (já existia um braço não expirado; o TTL não foi estendido), "noop_termal" (a execução já é terminal, possivelmente em outra réplica), "in_flight_elsewhere" (o registro de etapa durável mostra a chamada em andamento, mas não nessa réplica do OE; nada foi abortado aqui, e um backstop com escopo para as etapas marcadas interrompe a chamada no despacho se esse despacho for concluído nessa réplica — ele nunca poderá capturar uma chamada posterior ), ou "noop" (um step_number nomeado não corresponde a nada no voo). Idempotente: solicitações repetidas são seguras.

parâmetros de caminho

  • id string Obrigatório

    ID do Projeto

  • execution_id string Obrigatório

    ID de execução

parâmetros de query

  • workspace_id string

    ID do espaço de trabalho proprietário da execução, necessário para direcionar a interrupção para o OE desse espaço de trabalho

aplicação/json

corpo, corpo

Alvo opcional de chamada única

  • step_number inteiro

    StepNumber é a etapa de execução da chamada de ferramenta única/LLM a ser interrompida.

Respostas

  • Versão de API não permitida ou malformada, uma operação indisponível no contrato publicado selecionado ou uma representação inaceitável (incluindo parâmetros de tipo de mídia não suportados ou SSE excluído). Falhas existentes de autenticação, autorização e limite de taxa têm precedência.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes de validação opcionais definidos pelo esquema de erro padrão; Os erros de negociação da API não emitem este campo.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Campos com falhas de validação.

        Ocultar atributos de campos Mostrar atributos dos campos objeto

        Um campo e sua falha de validação.

        • Descrição string Obrigatório

          Falha na validação legível por humanos.

        • Campo string Obrigatório

          Nome ou caminho do campo de solicitação inválido .

    • detalhe string Obrigatório

      Detalhes de erro legíveis por humanos.

    • Erro inteiro Obrigatório

      HTTP status code.

    • Código de erro string Obrigatório

      Código de erro legível por máquina.

    • Parâmetros array[string]

      Solicitar nomes de parâmetros associados ao erro; omitido quando nenhum se aplica.

    • Razão string Obrigatório

      Frase de razão do status HTTP.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes de validação opcionais definidos pelo esquema de erro padrão; Os erros de negociação da API não emitem este campo.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Campos com falhas de validação.

        Ocultar atributos de campos Mostrar atributos dos campos objeto

        Um campo e sua falha de validação.

        • Descrição string Obrigatório

          Falha na validação legível por humanos.

        • Campo string Obrigatório

          Nome ou caminho do campo de solicitação inválido .

    • detalhe string Obrigatório

      Detalhes de erro legíveis por humanos.

    • Erro inteiro Obrigatório

      HTTP status code.

    • Código de erro string Obrigatório

      Código de erro legível por máquina.

    • Parâmetros array[string]

      Solicitar nomes de parâmetros associados ao erro; omitido quando nenhum se aplica.

    • Razão string Obrigatório

      Frase de razão do status HTTP.

  • 200

    OK

    Propriedades adicionais são permitidas.

    Propriedades adicionais são permitidas.

  • Solicitação inválida

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
  • Não autorizado

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
  • 404

    Não encontrado

    Propriedades adicionais são permitidas.

    Propriedades adicionais são permitidas.

  • Entidade solicitante muito grande

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
  • 502

    Gateway incorreto

    Propriedades adicionais são permitidas.

    Propriedades adicionais são permitidas.

POST /api/v1/projects/{id}/executions/{execution_id}/interrupt
curl \
 --request POST 'https://agentengine.mongodb.com/api/v1/projects/{id}/executions/{execution_id}/interrupt' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{
  "step_number": 42
}'
Exemplos de solicitação
{
  "step_number": 42
}
Exemplos de resposta (406)
{
  "detail": "This operation is not available in API version 2026-09-20-preview.",
  "error": 406,
  "errorCode": "OPERATION_NOT_IN_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
{
  "detail": "This operation supports text/event-stream, which the Accept header excludes. Remove unsupported media-type parameters or accept this type with a positive q value.",
  "error": 406,
  "errorCode": "UNACCEPTABLE_MEDIA_TYPE",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
{
  "detail": "The requested API version is not supported. Supported versions: 2026-09-20-preview.",
  "error": 406,
  "errorCode": "UNSUPPORTED_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
Exemplos de resposta (406)
{
  "detail": "This operation is not available in API version 2026-09-20-preview.",
  "error": 406,
  "errorCode": "OPERATION_NOT_IN_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
Exemplos de resposta (200)
{}
Exemplos de resposta (200)
{}
Exemplos de resposta (400)
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (400)
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (401)
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (401)
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (404)
{}
Exemplos de resposta (404)
{}
Exemplos de resposta (413)
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (413)
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (502)
{}
Exemplos de resposta (502)
{}