Obter configuração de memória do projeto

OBTER /api/v1/projects/{id}/memory/config
Autenticação do portador

Retorna a configuração atual do servidor de memória em nível de projeto. O escopo do projeto é realizado pelo parâmetro route id path e a organização é derivada desse projeto.

parâmetros de caminho

  • id string Obrigatório

    ID do Projeto

Respostas

  • 406

    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
    • config objeto
      Ocultar atributos de configuração Mostrar atributos de configuração objeto
      • background_extração objeto
        Ocultar atributo background_extração Mostrar atributo background_extração objeto
        • snapshot objeto
          Ocultar atributos de snapshot Mostrar atributos de snapshot objeto
          • delete_promoted booleano
          • embed_stm_before_promotion booleano
          • max_messages inteiro
          • stale_minutos inteiro
          • topic_shift_enabled booleano
          • topic_shift_threshold número
          • ttl_days inteiro
      • capacidade objeto

        A capacidade define a contagem de réplicas do servidor de memória para esse projeto. Somente infraestrutura: nunca montado no próprio container do servidor de memória.

        Ocultar atributos de capacidade Mostrar atributos de capacidade objeto
        • max_replicas inteiro

          O valor mínimo é 1, o valor máximo é 10.

        • min_replicas inteiro

          O valor mínimo é 1, o valor máximo é 10.

      • custom_memory_types array[objeto]

        CustomMemoryTypes declara os tipos de memória definidos pelo usuário que o servidor de memória fornece. Somente criação: o gateway rejeita edições ou remoções de declarações aceitas anteriormente. O limite de contagem é imposto por ValidateCustomMemoryTypes, não uma marcação de estrutura, portanto, a constante permanece a única fonte da verdade. A vinculação:"max" a tag é somente doc — o manipulador decodifica com json.Decoder, não com ligação ao gin, então não tem efeito de tempo de execução; existe apenas para revelar o limite na especificação OpenAPI gerada.

        Não mais do que 5 elementos.

        Ocultar atributos custom_memory_types Mostrar atributos de custom_memory_types objeto
        • collection string Obrigatório
        • name string Obrigatório
        • tags array[objeto]

          Não mais do que 10 elementos.

          Hide tags attribute Show tags attribute objeto
          • name string
      • Extração objeto
        Ocultar atributos de extração Mostrar atributos de extração objeto
        • habilitado array[string]

          Habilitado lista quais tipos de extração devem ser executados. Cada elemento deve ser um dos seguintes: semântica, episódica, geoespacial, preferências, processual.

        • escalonado objeto
          Hide episodic attribute Show episodic attribute objeto
          • prompt string

            O comprimento máximo é 4096.

        • preferências objeto
          Ocultar atributo de preferências Mostrar atributo de preferências objeto
          • prompt string

            O comprimento máximo é 4096.

        • processual objeto
          Ocultar atributo de procedimento Mostrar atributo processual objeto
          • prompt string

            O comprimento máximo é 4096.

        • semântico objeto
          Ocultar atributo semântica Mostrar atributo semântica objeto
          • prompt string

            O comprimento máximo é 4096.

        • taxonômico objeto
          Hide taxonomic attribute Mostrar atributo geoespacial objeto
          • prompt string

            O comprimento máximo é 4096.

      • extract_llm objeto
        Ocultar atributos collection_llm Mostrar atributos extract_llm objeto
        • api_key_secret string

          APIKeySecret é o nome secreto com escopo de projeto que contém a credencial de extração. Um dos: LLM_API_KEY, OPENAI_API_KEY, anthropic_API_KEY, GeominI_API_KEY, CEREBRAS_API_KEY. Omita a detecção automática a partir dessas variáveis de ambiente.

          Os valores são LLM_API_KEY, OPENAI_API_KEY, ANTHROPIC_API_KEY, GEMINI_API_KEY ou CEREBRAS_API_KEY.

        • auth_header string

          AuthHeader é o cabeçalho HTTP que o gateway espera para a chave de API. "autorização" envia autenticação do portador (padrão LiteLLM). "api-key" envia o cabeçalho de estilo Azure/Grove. Omitir para o padrão do provedor.

          Os valores são authorization ou api-key.

        • base_url string

          BaseURL é um endpoint de gateway opcional. HTTPS é necessário, exceto para HTTP de loopback. A informação de usuário (credenciais incorporadas) é rejeitada. Quando definido, a extração chama esse URL em vez da API do provedor público.

          O comprimento máximo é 2048.

        • Modelo string

          O comprimento máximo é 256.

        • fornecedor string

          O provedor deve ser um dos seguintes: openai, athropic, gemini, cerebras.

          Os valores são openai, anthropic, gemini ou cerebras.

      • log_level string

        LogLevel define o nível de registro raiz do servidor de memória para o projeto. Um de: depuração, informações, aviso, erro, crítico. Omita o campo para deixar o padrão do servidor (info); uma string vazia explícita é rejeitada.

        Os valores são debug, info, warning, error ou critical.

      • metadata_partition_index objeto

        O MetadataPartitionIndex seleciona, por tipo de memória no escopo, quais partes do índice de pesquisa carregam os campos do filtro de partição: "vetor", "texto" ou "ambos". Um tipo omitido do mapa tem como padrão apenas a etapa vetorial. Gratuitamente mutável — afeta apenas as faixas que os índices recém-provisionados obtêm.

        Ocultar atributo metadata_partition_index Mostrar atributo metadata_partition_index objeto
        • * array[string] Propriedades adicionais
      • metadata_partition_key array[objeto]

        MetadataPartitionKey declara atributos de metadados filtráveis que cada tipo de memória no escopo (semântica, episódica, processual, curto_termo) indexa como um campo de filtro de partição. Somente criação: o gateway rejeita a remoção ou a digitação novamente de uma chave aceita anteriormente (as adições são permitidas). O limite de contagem é imposto por ValidateMetadataPartition, não uma marcação de estrutura, portanto, a constante permanece a única fonte da verdade. A vinculação:"max" a tag é somente doc — o manipulador decodifica com json.Decoder, não com ligação ao gin, então não tem efeito de tempo de execução; ele existe apenas para revelar o limite na especificação do OpenAPI.

        Não mais do que 10 elementos.

        Ocultar atributos metadata_partition_key Mostrar atributos metadata_partition_key objeto
        • name string Obrigatório
        • type string Obrigatório
      • curto_termo objeto
        Ocultar atributo curto_termo Mostrar atributo curto_termo objeto
        • embed_on_write booleano

          O EmbedOnWrite faz com que o servidor de memória incorpore o conteúdo de um turno de forma síncrona no momento da gravação quando o chamador não fornece nenhuma incorporação, de modo que o retorno seja pesquisável por relevância imediatamente, em vez de esperar pela incorporação em segundo plano. O padrão é falso (caminhos de gravação rápida). Diferente do SnapshotConfig.EmbedSTMBeforePromotion, que se incorpora em lote no trabalhador antes de uma verificação de promoção.

      • Tarefas objeto

        Tarefas ajusta o processamento de tarefas em segundo plano do servidor de memória.

        Ocultar atributo de tarefas Mostrar atributo de tarefas objeto
        • legacy_retry booleano

          O LegacyRetry reverte a compensação de falhas de tarefas para o orçamento de novas tentativas limitado legado ( três tentativas e, em seguida, dead letter ) em vez de tentar novamente falhas transitórias até a expiração da tarefa. Frenagem de emergência: habilitá-lo pode terminalizar em massa um backlog acumulado de novas tentativas. O padrão é falso.

      • viagem objeto
        Ocultar atributos de viagem Mostrar atributos de viagem objeto
        • Dimensão inteiro
        • Modelo string

          O comprimento máximo é 256.

    • geração inteiro
    • recebida_geração inteiro
    • updated_at string
    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • config objeto
      Ocultar atributos de configuração Mostrar atributos de configuração objeto
      • background_extração objeto
        Ocultar atributo background_extração Mostrar atributo background_extração objeto
        • snapshot objeto
          Ocultar atributos de snapshot Mostrar atributos de snapshot objeto
          • delete_promoted booleano
          • embed_stm_before_promotion booleano
          • max_messages inteiro
          • stale_minutos inteiro
          • topic_shift_enabled booleano
          • topic_shift_threshold número
          • ttl_days inteiro
      • capacidade objeto

        A capacidade define a contagem de réplicas do servidor de memória para esse projeto. Somente infraestrutura: nunca montado no próprio container do servidor de memória.

        Ocultar atributos de capacidade Mostrar atributos de capacidade objeto
        • max_replicas inteiro

          O valor mínimo é 1, o valor máximo é 10.

        • min_replicas inteiro

          O valor mínimo é 1, o valor máximo é 10.

      • custom_memory_types array[objeto]

        CustomMemoryTypes declara os tipos de memória definidos pelo usuário que o servidor de memória fornece. Somente criação: o gateway rejeita edições ou remoções de declarações aceitas anteriormente. O limite de contagem é imposto por ValidateCustomMemoryTypes, não uma marcação de estrutura, portanto, a constante permanece a única fonte da verdade. A vinculação:"max" a tag é somente doc — o manipulador decodifica com json.Decoder, não com ligação ao gin, então não tem efeito de tempo de execução; existe apenas para revelar o limite na especificação OpenAPI gerada.

        Não mais do que 5 elementos.

        Ocultar atributos custom_memory_types Mostrar atributos de custom_memory_types objeto
        • collection string Obrigatório
        • name string Obrigatório
        • tags array[objeto]

          Não mais do que 10 elementos.

          Hide tags attribute Show tags attribute objeto
          • name string
      • Extração objeto
        Ocultar atributos de extração Mostrar atributos de extração objeto
        • habilitado array[string]

          Habilitado lista quais tipos de extração devem ser executados. Cada elemento deve ser um dos seguintes: semântica, episódica, geoespacial, preferências, processual.

        • escalonado objeto
          Hide episodic attribute Show episodic attribute objeto
          • prompt string

            O comprimento máximo é 4096.

        • preferências objeto
          Ocultar atributo de preferências Mostrar atributo de preferências objeto
          • prompt string

            O comprimento máximo é 4096.

        • processual objeto
          Ocultar atributo de procedimento Mostrar atributo processual objeto
          • prompt string

            O comprimento máximo é 4096.

        • semântico objeto
          Ocultar atributo semântica Mostrar atributo semântica objeto
          • prompt string

            O comprimento máximo é 4096.

        • taxonômico objeto
          Hide taxonomic attribute Mostrar atributo geoespacial objeto
          • prompt string

            O comprimento máximo é 4096.

      • extract_llm objeto
        Ocultar atributos collection_llm Mostrar atributos extract_llm objeto
        • api_key_secret string

          APIKeySecret é o nome secreto com escopo de projeto que contém a credencial de extração. Um dos: LLM_API_KEY, OPENAI_API_KEY, anthropic_API_KEY, GeominI_API_KEY, CEREBRAS_API_KEY. Omita a detecção automática a partir dessas variáveis de ambiente.

          Os valores são LLM_API_KEY, OPENAI_API_KEY, ANTHROPIC_API_KEY, GEMINI_API_KEY ou CEREBRAS_API_KEY.

        • auth_header string

          AuthHeader é o cabeçalho HTTP que o gateway espera para a chave de API. "autorização" envia autenticação do portador (padrão LiteLLM). "api-key" envia o cabeçalho de estilo Azure/Grove. Omitir para o padrão do provedor.

          Os valores são authorization ou api-key.

        • base_url string

          BaseURL é um endpoint de gateway opcional. HTTPS é necessário, exceto para HTTP de loopback. A informação de usuário (credenciais incorporadas) é rejeitada. Quando definido, a extração chama esse URL em vez da API do provedor público.

          O comprimento máximo é 2048.

        • Modelo string

          O comprimento máximo é 256.

        • fornecedor string

          O provedor deve ser um dos seguintes: openai, athropic, gemini, cerebras.

          Os valores são openai, anthropic, gemini ou cerebras.

      • log_level string

        LogLevel define o nível de registro raiz do servidor de memória para o projeto. Um de: depuração, informações, aviso, erro, crítico. Omita o campo para deixar o padrão do servidor (info); uma string vazia explícita é rejeitada.

        Os valores são debug, info, warning, error ou critical.

      • metadata_partition_index objeto

        O MetadataPartitionIndex seleciona, por tipo de memória no escopo, quais partes do índice de pesquisa carregam os campos do filtro de partição: "vetor", "texto" ou "ambos". Um tipo omitido do mapa tem como padrão apenas a etapa vetorial. Gratuitamente mutável — afeta apenas as faixas que os índices recém-provisionados obtêm.

        Ocultar atributo metadata_partition_index Mostrar atributo metadata_partition_index objeto
        • * array[string] Propriedades adicionais
      • metadata_partition_key array[objeto]

        MetadataPartitionKey declara atributos de metadados filtráveis que cada tipo de memória no escopo (semântica, episódica, processual, curto_termo) indexa como um campo de filtro de partição. Somente criação: o gateway rejeita a remoção ou a digitação novamente de uma chave aceita anteriormente (as adições são permitidas). O limite de contagem é imposto por ValidateMetadataPartition, não uma marcação de estrutura, portanto, a constante permanece a única fonte da verdade. A vinculação:"max" a tag é somente doc — o manipulador decodifica com json.Decoder, não com ligação ao gin, então não tem efeito de tempo de execução; ele existe apenas para revelar o limite na especificação do OpenAPI.

        Não mais do que 10 elementos.

        Ocultar atributos metadata_partition_key Mostrar atributos metadata_partition_key objeto
        • name string Obrigatório
        • type string Obrigatório
      • curto_termo objeto
        Ocultar atributo curto_termo Mostrar atributo curto_termo objeto
        • embed_on_write booleano

          O EmbedOnWrite faz com que o servidor de memória incorpore o conteúdo de um turno de forma síncrona no momento da gravação quando o chamador não fornece nenhuma incorporação, de modo que o retorno seja pesquisável por relevância imediatamente, em vez de esperar pela incorporação em segundo plano. O padrão é falso (caminhos de gravação rápida). Diferente do SnapshotConfig.EmbedSTMBeforePromotion, que se incorpora em lote no trabalhador antes de uma verificação de promoção.

      • Tarefas objeto

        Tarefas ajusta o processamento de tarefas em segundo plano do servidor de memória.

        Ocultar atributo de tarefas Mostrar atributo de tarefas objeto
        • legacy_retry booleano

          O LegacyRetry reverte a compensação de falhas de tarefas para o orçamento de novas tentativas limitado legado ( três tentativas e, em seguida, dead letter ) em vez de tentar novamente falhas transitórias até a expiração da tarefa. Frenagem de emergência: habilitá-lo pode terminalizar em massa um backlog acumulado de novas tentativas. O padrão é falso.

      • viagem objeto
        Ocultar atributos de viagem Mostrar atributos de viagem objeto
        • Dimensão inteiro
        • Modelo string

          O comprimento máximo é 256.

    • geração inteiro
    • recebida_geração inteiro
    • updated_at string
  • 401

    Credenciais ausentes ou inválidas

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

    O chamador não tem permissão de leitura

    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

    Nenhuma configuração armazenada para o projeto

    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}/memory/config 
curl \
 --request GET 'https://agentengine.mongodb.com/api/v1/projects/{id}/memory/config' \
 --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) 
{
  "config": {
    "background_extraction": {
      "snapshot": {
        "delete_promoted": true,
        "embed_stm_before_promotion": true,
        "max_messages": 42,
        "stale_minutes": 42,
        "topic_shift_enabled": true,
        "topic_shift_threshold": 42.0,
        "ttl_days": 42
      }
    },
    "capacity": {
      "max_replicas": 42,
      "min_replicas": 42
    },
    "custom_memory_types": [
      {
        "collection": "string",
        "name": "string",
        "tags": [
          {
            "name": "string"
          }
        ]
      }
    ],
    "extraction": {
      "enabled": [
        "string"
      ],
      "episodic": {
        "prompt": "string"
      },
      "preferences": {
        "prompt": "string"
      },
      "procedural": {
        "prompt": "string"
      },
      "semantic": {
        "prompt": "string"
      },
      "taxonomic": {
        "prompt": "string"
      }
    },
    "extraction_llm": {
      "api_key_secret": "LLM_API_KEY",
      "auth_header": "authorization",
      "base_url": "string",
      "model": "string",
      "provider": "openai"
    },
    "log_level": "debug",
    "metadata_partition_index": {
      "additionalProperty1": [
        "string"
      ],
      "additionalProperty2": [
        "string"
      ]
    },
    "metadata_partition_key": [
      {
        "name": "string",
        "type": "string"
      }
    ],
    "short_term": {
      "embed_on_write": true
    },
    "tasks": {
      "legacy_retry": true
    },
    "voyage": {
      "dimension": 42,
      "model": "string"
    }
  },
  "generation": 42,
  "received_generation": 42,
  "updated_at": "string"
}
Exemplos de resposta (200) 
{
  "config": {
    "background_extraction": {
      "snapshot": {
        "delete_promoted": true,
        "embed_stm_before_promotion": true,
        "max_messages": 42,
        "stale_minutes": 42,
        "topic_shift_enabled": true,
        "topic_shift_threshold": 42.0,
        "ttl_days": 42
      }
    },
    "capacity": {
      "max_replicas": 42,
      "min_replicas": 42
    },
    "custom_memory_types": [
      {
        "collection": "string",
        "name": "string",
        "tags": [
          {
            "name": "string"
          }
        ]
      }
    ],
    "extraction": {
      "enabled": [
        "string"
      ],
      "episodic": {
        "prompt": "string"
      },
      "preferences": {
        "prompt": "string"
      },
      "procedural": {
        "prompt": "string"
      },
      "semantic": {
        "prompt": "string"
      },
      "taxonomic": {
        "prompt": "string"
      }
    },
    "extraction_llm": {
      "api_key_secret": "LLM_API_KEY",
      "auth_header": "authorization",
      "base_url": "string",
      "model": "string",
      "provider": "openai"
    },
    "log_level": "debug",
    "metadata_partition_index": {
      "additionalProperty1": [
        "string"
      ],
      "additionalProperty2": [
        "string"
      ]
    },
    "metadata_partition_key": [
      {
        "name": "string",
        "type": "string"
      }
    ],
    "short_term": {
      "embed_on_write": true
    },
    "tasks": {
      "legacy_retry": true
    },
    "voyage": {
      "dimension": 42,
      "model": "string"
    }
  },
  "generation": 42,
  "received_generation": 42,
  "updated_at": "string"
}
Exemplos de resposta (401) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (401) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (403) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (403) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (404) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (404) 
{
  "code": "string",
  "error": "string",
  "success": true
}