Invocar espaço de trabalho (streaming)

POSTAR /api/v1/projects/{id}/workspaces/{workspace_id}/invokeStream

Invoca um agente de espaço de trabalho e transmite sua resposta como eventos enviados pelo servidor. Para continuar uma sessão, envie o valor X-Session-ID retornado pela resposta anterior. Se você omitir o cabeçalho, o gateway iniciará uma nova sessão e retornará seu ID no cabeçalho de resposta. O campo session_id do corpo não continua uma sessão. O corpo pode incluir campos extras de nível superior. O gateway encaminha todos os campo , exceto estes campos reservados: message, session_id, user_id e resume_map. resume_map continua uma curva suspensa. Para uma sessão sem histórico, resume_map se torna a entrada inicial do agente . Exige um token de Portador válido.

Cabeçalhos

  • X-Session-ID string

    ID da sessão retornada por uma resposta anterior. Envie para continuar a sessão. As IDs válidas correspondem a [A-Za-z0-9_-]{1,128}$. Se omitido, o gateway inicia uma nova sessão. O corpo da sessão_id não continua uma sessão

  • X-Agent-Engine-Test-Session booleano

    Classificar uma sessão recém-criada como uma sessão de teste; a classificação existente não é alterada

parâmetros de caminho

  • id string Obrigatório

    ID do Projeto

  • workspace_id string Obrigatório

    ID do espaço de trabalho

aplicação/json

corpo, corpo Obrigatório

Solicitação de invocar

  • mensagem string

    Opcional quando outros campos do agente são fornecidos: entrada de chat para agentes de chat. Nome do campo reservado.

  • resume_map objeto

    ResumeMap contém respostas por interrupção resolvidas por OE. A OE a encaminha para o agente como entrada comum somente quando inicia a primeira execução de uma sessão, onde não existe nenhuma vez suspensa local para responder.

    Propriedades adicionais são permitidas.

  • session_id string

    campo de compatibilidade opcional. O gateway o ignora para a continuação da sessão. Para continuar uma sessão, envie X-Session-ID . Nome do campo reservado.

  • user_id string

    Identidade opcional usada para personalização e isolamento de memória. As chamadas de chave de API e humanos usam esse valor ou padrão para o usuário autenticado. As chamadas de conta de serviço sempre usam a identidade da conta de serviço. As contas de serviço ainda não podem agir como outro usuário. Nome do campo reservado.

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 text/event-stream

    fluxo SSE. Uma falha pré-cabeçalho (antes do primeiro quadro) é renderizada como um dos corpos de erro JSON abaixo; uma falha no meio do fluxo, em vez disso, é renderizada como um bloco SSE de terminal contendo o mesmo código/erro, além de fonte/componente/sandbox/boot_id em um objeto de metadados para um envelope de falha de inicialização

    Ocultar atributo de cabeçalhos Mostrar atributo de cabeçalhos
    • X-Session-ID string

      ID da sessão correspondente a [A-Za-z0-9_-]{1,128}$. Envie este valor na próxima solicitação para continuar a sessão

  • 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
  • 409

    Conflito

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • blocking_execution_id string
    • blocking_status string
    • código string
    • Erro string
    • last_atividade_at string
    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • blocking_execution_id string
    • blocking_status string
    • código string
    • Erro string
    • last_atividade_at string
  • 422

    PROJECT_SECRET_INVALID: o espaço de trabalho não pode ser iniciado porque um segredo de projeto é inválido ou inacessível (corrija o segredo e redistribua); No meio do fluxo, ele aparece como um bloco SSE terminal contendo o código=PROJECT_SECRET_INVALID

    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
  • 429

    Muitas solicitações

    Ocultar atributo de cabeçalhos Mostrar atributo de cabeçalhos
    • Tentar novamente depois string

      Segundos para esperar antes de tentar novamente

    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
  • 500

    ErrorResponse ou StartupFailureResponse para uma falha de inicializaçãoAGENT_STARTUP_FAILED/STARTUP_FAILED

    Qualquer um dos seguintes:
    Qualquer um dos seguintes:
  • 503

    StartupFailureResponse para uma falha de inicialização POOL_EXHAUSTED/EXECUTOR_BOOT_FAILED/PLATFORM_DEPENDENCY_FAILED/POOL_UNREACHABLE; ErrorResponse de outra forma. POOL_EXHAUSTED carrega um cabeçalho Retry-After

    Ocultar atributo de cabeçalhos Mostrar atributo de cabeçalhos
    • Tentar novamente depois string

      Segundos para aguardar antes de tentar novamente (somente POOL_EXHAUSTED)

    Qualquer um dos seguintes:
    Qualquer um dos seguintes:
  • Tempo limite do gateway

    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
POST /api/v1/projects/{id}/workspaces/{workspace_id}/invokeStream
curl \
 --request POST 'https://agentengine.mongodb.com/api/v1/projects/{id}/workspaces/{workspace_id}/invokeStream' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --header "X-Session-ID: string" \
 --header "X-Agent-Engine-Test-Session: true" \
 --data '{
  "message": "string",
  "resume_map": {},
  "session_id": "string",
  "user_id": "string"
}'
Exemplos de solicitação
# Headers
X-Session-ID: string
X-Agent-Engine-Test-Session: true

# Payload
{
  "message": "string",
  "resume_map": {},
  "session_id": "string",
  "user_id": "string"
}
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)
: connected

data: {"message":"Example event payload"}

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 (409)
{
  "blocking_execution_id": "string",
  "blocking_status": "string",
  "code": "string",
  "error": "string",
  "last_activity_at": "string"
}
Exemplos de resposta (409)
{
  "blocking_execution_id": "string",
  "blocking_status": "string",
  "code": "string",
  "error": "string",
  "last_activity_at": "string"
}
Exemplos de resposta (422)
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (422)
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (429)
# Headers
Retry-After: string

# Payload
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (429)
# Headers
Retry-After: string

# Payload
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (500)
{
  "code": "string",
  "error": "string",
  "success": true
}
{
  "boot_id": "string",
  "code": "string",
  "component": "string",
  "error": "string",
  "execution_id": "string",
  "sandbox": "string",
  "source": "string",
  "success": true
}
Exemplos de resposta (500)
{
  "code": "string",
  "error": "string",
  "success": true
}
{
  "boot_id": "string",
  "code": "string",
  "component": "string",
  "error": "string",
  "execution_id": "string",
  "sandbox": "string",
  "source": "string",
  "success": true
}
Exemplos de resposta (503)
# Headers
Retry-After: string

# Payload
{
  "boot_id": "string",
  "code": "string",
  "component": "string",
  "error": "string",
  "execution_id": "string",
  "sandbox": "string",
  "source": "string",
  "success": true
}
# Headers
Retry-After: string

# Payload
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (503)
# Headers
Retry-After: string

# Payload
{
  "boot_id": "string",
  "code": "string",
  "component": "string",
  "error": "string",
  "execution_id": "string",
  "sandbox": "string",
  "source": "string",
  "success": true
}
# Headers
Retry-After: string

# Payload
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (504)
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (504)
{
  "code": "string",
  "error": "string",
  "success": true
}