Listar espaços de trabalho

OBTER /api/v1/projects/{id}/workspaces

Retorna todos os espaços de trabalho no projeto identificados pelo parâmetro de caminho de ID de rota. Requer um role de projeto e um token de portador válidos.

parâmetros de caminho

  • id string Obrigatório

    ID do Projeto

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

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • Total inteiro
    • espaços de trabalho array[objeto]
      Ocultar atributos dos espaços de trabalho Mostrar atributos dos espaços de trabalho objeto
      • aer_http_endpoint string

        AERHTTPEndpoint é o nome legado do endpoint HTTP da sandbox do agente .

      • Agent_card objeto
        Ocultar atributos do Agent_card Mostrar atributos do Agent_card objeto
        • a2a_allowed_callers array[string]

          A2AAllowedCallers restringe quais IDs de espaço de trabalho podem invocar esse agente por meio da A2A. Uma lista vazia significa que qualquer chamador é permitido.

        • a2a_enabled booleano

          A2AEnabled controla se esse agente é detectável para chamadas A2A.

        • capacidades array[string]
        • input_modes array[string]

          InputModes lista os tipos de MIME que o agente aceita (por exemplo, "text/plain", " aplicação/json").

        • output_modes array[string]

          OutputModes lista os tipos de MIME que o agente pode produzir.

        • habilidades array[objeto]

          As habilidades anunciam tarefas discretas que o agente pode executar.

          Ocultar atributos de habilidades Mostrar atributos de habilidades objeto
          • Descrição string
          • sample_input string
          • sample_output string
          • name string
        • Resumo string
      • agent_grpc_endpoint string
      • agent_http_endpoint string

        AgentHTTPEndpoint é o endpoint HTTP da sandbox do agente . O mesmo valor que aer_http_endpoint.

      • auto_deploy booleano

        O AutoDeploy é a alternância de implantação automática por aplicativo de propriedade da ECP. De propriedade da ECP, obtido em cada GET detalhado (não persistente no banco de dados do gateway). Ausente quando a ECP não tem valor ou não está acessível; a interface do usuário trata ausente como desativado.

      • completed_rate número
      • created_date string
      • current_deployment_id string
      • current_ payload_ref string
      • Descrição string
      • características objeto
        Ocultar atributos de funcionalidades Mostrar atributos de funcionalidades objeto
        • guardrails booleano
        • Memória booleano
        • Parque infantil booleano

          O Playground relata se a interface do usuário do playground está provisionada para o espaço de trabalho (nil/true = provisionado, comportamento de hoje). Quando falso, os chamadores usam a API de chamada diretamente.

        • use_custom_parser booleano

          UseCustomParser, quando verdadeiro, faz com que o Gateway emita apenas os eventos personalizados do analisador de saída do agente no fluxo de invocações (descartando armações da plataforma). Persistência dos recursos .yaml do agente na inicialização do agentengine.

      • Framework string
      • github_installation_id inteiro

        GithubInstallationID é a instalação do aplicativo GitHub que possui o repositório. De propriedade da ECP, buscado em cada GET detalhado (não persistente no banco de dados do gateway), para que funcione para espaços de trabalho criados antes que esse campo existisse. A interface do usuário precisa listar as ramificações do repositório ao editar a ramificação rastreada.

      • gitops objeto
        Ocultar atributos de gitops Mostrar atributos do gitops objeto
        • branch string
        • connection_ref string
        • github_installation_id integer(int64)
        • manifest_path string
        • fornecedor string
        • repo_url string
      • id string
      • instâncias objeto

        Instâncias relatam as contagens de instâncias do espaço de trabalho (ativa, em espera e inicial), obtidas do tempo de leitura da célula OE do espaço de trabalho. Ausente quando o OE não está acessível ou o espaço de trabalho não é executado em pool (por exemplo, modo container). Deliberadamente livre de qualquer nome de implementação interna: este é um campo voltado para o cliente.

        Ocultar atributos de instâncias Mostrar atributos de instâncias objeto
        • Ativo inteiro
        • agrupada booleano
        • standby inteiro
        • de partida inteiro
      • invocações inteiro

        Métricas de execução em uma janela contínua de 24h. Todos os cinco campos são ponteiros de modo que o fio pode distinguir dois casos em que a interface do usuário precisa ser renderizada de forma diferente: (a) a busca de métricas OE falhou (falha suave — todos os cinco campos ausentes) ou (b) a janela contém zero invocações / nenhuma concluída execuções (Invocações está definido como 0 e os campos latência/taxa estão ausentes). A UI distingue "-" de "0 invocações" via invocações != nil.

      • Linguagem string
      • last_invoned_at string(data-hora)
      • metrics_computed_at string(data-hora)
      • metrics_window_start string(data-hora)
      • name string
      • org_id string
      • p95_latency_ms número
      • PROJECT_ID string
      • release_mode string

        ReleaseMode é a política de lançamento de webhook de propriedade da ECP ("push" | "tag-release" | "api-only"). Buscado em cada detalhe GET; ausente quando o ECP não tem valor ou não está acessível.

      • Status string

        O status é o sinal ativo/pausado de propriedade do ECP. O gateway o obtém do ECP em cada GET detalhado — ele não é persistente localmente. Ausente quando o ECP não está acessível; A UI trata ausente como não pausado.

        Os valores são active, paused, error, disconnected ou deleting.

      • subdiretório string
      • updated_date string
      • workspace_id string
      • workspace_name string
    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • Total inteiro
    • espaços de trabalho array[objeto]
      Ocultar atributos dos espaços de trabalho Mostrar atributos dos espaços de trabalho objeto
      • aer_http_endpoint string

        AERHTTPEndpoint é o nome legado do endpoint HTTP da sandbox do agente .

      • Agent_card objeto
        Ocultar atributos do Agent_card Mostrar atributos do Agent_card objeto
        • a2a_allowed_callers array[string]

          A2AAllowedCallers restringe quais IDs de espaço de trabalho podem invocar esse agente por meio da A2A. Uma lista vazia significa que qualquer chamador é permitido.

        • a2a_enabled booleano

          A2AEnabled controla se esse agente é detectável para chamadas A2A.

        • capacidades array[string]
        • input_modes array[string]

          InputModes lista os tipos de MIME que o agente aceita (por exemplo, "text/plain", " aplicação/json").

        • output_modes array[string]

          OutputModes lista os tipos de MIME que o agente pode produzir.

        • habilidades array[objeto]

          As habilidades anunciam tarefas discretas que o agente pode executar.

          Ocultar atributos de habilidades Mostrar atributos de habilidades objeto
          • Descrição string
          • sample_input string
          • sample_output string
          • name string
        • Resumo string
      • agent_grpc_endpoint string
      • agent_http_endpoint string

        AgentHTTPEndpoint é o endpoint HTTP da sandbox do agente . O mesmo valor que aer_http_endpoint.

      • auto_deploy booleano

        O AutoDeploy é a alternância de implantação automática por aplicativo de propriedade da ECP. De propriedade da ECP, obtido em cada GET detalhado (não persistente no banco de dados do gateway). Ausente quando a ECP não tem valor ou não está acessível; a interface do usuário trata ausente como desativado.

      • completed_rate número
      • created_date string
      • current_deployment_id string
      • current_ payload_ref string
      • Descrição string
      • características objeto
        Ocultar atributos de funcionalidades Mostrar atributos de funcionalidades objeto
        • guardrails booleano
        • Memória booleano
        • Parque infantil booleano

          O Playground relata se a interface do usuário do playground está provisionada para o espaço de trabalho (nil/true = provisionado, comportamento de hoje). Quando falso, os chamadores usam a API de chamada diretamente.

        • use_custom_parser booleano

          UseCustomParser, quando verdadeiro, faz com que o Gateway emita apenas os eventos personalizados do analisador de saída do agente no fluxo de invocações (descartando armações da plataforma). Persistência dos recursos .yaml do agente na inicialização do agentengine.

      • Framework string
      • github_installation_id inteiro

        GithubInstallationID é a instalação do aplicativo GitHub que possui o repositório. De propriedade da ECP, buscado em cada GET detalhado (não persistente no banco de dados do gateway), para que funcione para espaços de trabalho criados antes que esse campo existisse. A interface do usuário precisa listar as ramificações do repositório ao editar a ramificação rastreada.

      • gitops objeto
        Ocultar atributos de gitops Mostrar atributos do gitops objeto
        • branch string
        • connection_ref string
        • github_installation_id integer(int64)
        • manifest_path string
        • fornecedor string
        • repo_url string
      • id string
      • instâncias objeto

        Instâncias relatam as contagens de instâncias do espaço de trabalho (ativa, em espera e inicial), obtidas do tempo de leitura da célula OE do espaço de trabalho. Ausente quando o OE não está acessível ou o espaço de trabalho não é executado em pool (por exemplo, modo container). Deliberadamente livre de qualquer nome de implementação interna: este é um campo voltado para o cliente.

        Ocultar atributos de instâncias Mostrar atributos de instâncias objeto
        • Ativo inteiro
        • agrupada booleano
        • standby inteiro
        • de partida inteiro
      • invocações inteiro

        Métricas de execução em uma janela contínua de 24h. Todos os cinco campos são ponteiros de modo que o fio pode distinguir dois casos em que a interface do usuário precisa ser renderizada de forma diferente: (a) a busca de métricas OE falhou (falha suave — todos os cinco campos ausentes) ou (b) a janela contém zero invocações / nenhuma concluída execuções (Invocações está definido como 0 e os campos latência/taxa estão ausentes). A UI distingue "-" de "0 invocações" via invocações != nil.

      • Linguagem string
      • last_invoned_at string(data-hora)
      • metrics_computed_at string(data-hora)
      • metrics_window_start string(data-hora)
      • name string
      • org_id string
      • p95_latency_ms número
      • PROJECT_ID string
      • release_mode string

        ReleaseMode é a política de lançamento de webhook de propriedade da ECP ("push" | "tag-release" | "api-only"). Buscado em cada detalhe GET; ausente quando o ECP não tem valor ou não está acessível.

      • Status string

        O status é o sinal ativo/pausado de propriedade do ECP. O gateway o obtém do ECP em cada GET detalhado — ele não é persistente localmente. Ausente quando o ECP não está acessível; A UI trata ausente como não pausado.

        Os valores são active, paused, error, disconnected ou deleting.

      • subdiretório string
      • updated_date string
      • workspace_id string
      • workspace_name string
  • 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
  • Erro interno do servidor

    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
GET /api/v1/projects/{id}/workspaces
curl \
 --request GET 'https://agentengine.mongodb.com/api/v1/projects/{id}/workspaces' \
 --header "Authorization: $API_KEY"
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)
{
  "total": 42,
  "workspaces": [
    {
      "aer_http_endpoint": "string",
      "agent_card": {
        "a2a_allowed_callers": [
          "string"
        ],
        "a2a_enabled": true,
        "capabilities": [
          "string"
        ],
        "input_modes": [
          "string"
        ],
        "output_modes": [
          "string"
        ],
        "skills": [
          {
            "description": "string",
            "example_input": "string",
            "example_output": "string",
            "name": "string"
          }
        ],
        "summary": "string"
      },
      "agent_grpc_endpoint": "string",
      "agent_http_endpoint": "string",
      "auto_deploy": true,
      "completion_rate": 42.0,
      "created_date": "string",
      "current_deployment_id": "string",
      "current_payload_ref": "string",
      "description": "string",
      "features": {
        "guardrails": true,
        "memory": true,
        "playground": true,
        "use_custom_parser": true
      },
      "framework": "string",
      "github_installation_id": 42,
      "gitops": {
        "branch": "string",
        "connection_ref": "string",
        "github_installation_id": 42,
        "manifest_path": "string",
        "provider": "string",
        "repo_url": "string"
      },
      "id": "string",
      "instances": {
        "active": 42,
        "pooled": true,
        "standby": 42,
        "starting": 42
      },
      "invocations": 42,
      "language": "string",
      "last_invoked_at": "2026-05-04T09:42:00Z",
      "metrics_computed_at": "2026-05-04T09:42:00Z",
      "metrics_window_start": "2026-05-04T09:42:00Z",
      "name": "string",
      "org_id": "string",
      "p95_latency_ms": 42.0,
      "project_id": "string",
      "release_mode": "string",
      "status": "active",
      "subdirectory": "string",
      "updated_date": "string",
      "workspace_id": "string",
      "workspace_name": "string"
    }
  ]
}
Exemplos de resposta (200)
{
  "total": 42,
  "workspaces": [
    {
      "aer_http_endpoint": "string",
      "agent_card": {
        "a2a_allowed_callers": [
          "string"
        ],
        "a2a_enabled": true,
        "capabilities": [
          "string"
        ],
        "input_modes": [
          "string"
        ],
        "output_modes": [
          "string"
        ],
        "skills": [
          {
            "description": "string",
            "example_input": "string",
            "example_output": "string",
            "name": "string"
          }
        ],
        "summary": "string"
      },
      "agent_grpc_endpoint": "string",
      "agent_http_endpoint": "string",
      "auto_deploy": true,
      "completion_rate": 42.0,
      "created_date": "string",
      "current_deployment_id": "string",
      "current_payload_ref": "string",
      "description": "string",
      "features": {
        "guardrails": true,
        "memory": true,
        "playground": true,
        "use_custom_parser": true
      },
      "framework": "string",
      "github_installation_id": 42,
      "gitops": {
        "branch": "string",
        "connection_ref": "string",
        "github_installation_id": 42,
        "manifest_path": "string",
        "provider": "string",
        "repo_url": "string"
      },
      "id": "string",
      "instances": {
        "active": 42,
        "pooled": true,
        "standby": 42,
        "starting": 42
      },
      "invocations": 42,
      "language": "string",
      "last_invoked_at": "2026-05-04T09:42:00Z",
      "metrics_computed_at": "2026-05-04T09:42:00Z",
      "metrics_window_start": "2026-05-04T09:42:00Z",
      "name": "string",
      "org_id": "string",
      "p95_latency_ms": 42.0,
      "project_id": "string",
      "release_mode": "string",
      "status": "active",
      "subdirectory": "string",
      "updated_date": "string",
      "workspace_id": "string",
      "workspace_name": "string"
    }
  ]
}
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 (500)
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (500)
{
  "code": "string",
  "error": "string",
  "success": true
}