Obtener la configuración de memoria del proyecto

OBTENER /api/v1/projects/{id}/memory/config

Devuelve la configuración actual del servidor de memoria a nivel de proyecto. El ámbito del proyecto viene definido por el parámetro de ruta id, y la organización se deriva de dicho proyecto.

Parámetros de path

  • ID string Requerido

    ID del proyecto

Respuestas

  • Versión de API no compatible o con formato incorrecto, operación no disponible en el contrato publicado seleccionado o representación inaceptable (incluidos parámetros de tipo de medio no compatibles o SSE excluidos). Los fallos de autenticación, autorización y límite de velocidad existentes tienen prioridad.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalles de validación opcionales definidos por el esquema de error estándar; los errores de negociación de la API no emiten este campo.

      Ocultad el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • Campos arreglo[objeto]

        Campos con errores de validación.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto

        Un campo y su fallo de validación.

        • Descripción string Requerido

          Fallo en la validación legible para humanos.

        • Campo string Requerido

          Nombre o ruta del campo de solicitud no válido.

    • detalle string Requerido

      Detalles de errores legibles para humanos.

    • Error entero Requerido

      HTTP status code.

    • errorCode string Requerido

      Código de error legible por máquina.

    • Parámetros array[string]

      Nombres de los parámetros de la solicitud asociados con el error; se omiten cuando no corresponde ninguno.

    • motivo string Requerido

      Frase que indica el motivo del estado HTTP.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalles de validación opcionales definidos por el esquema de error estándar; los errores de negociación de la API no emiten este campo.

      Ocultad el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • Campos arreglo[objeto]

        Campos con errores de validación.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto

        Un campo y su fallo de validación.

        • Descripción string Requerido

          Fallo en la validación legible para humanos.

        • Campo string Requerido

          Nombre o ruta del campo de solicitud no válido.

    • detalle string Requerido

      Detalles de errores legibles para humanos.

    • Error entero Requerido

      HTTP status code.

    • errorCode string Requerido

      Código de error legible por máquina.

    • Parámetros array[string]

      Nombres de los parámetros de la solicitud asociados con el error; se omiten cuando no corresponde ninguno.

    • motivo string Requerido

      Frase que indica el motivo del estado HTTP.

  • 200

    OK

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • config Objeto
      Ocultar atributos de configuración Show config attributes Objeto
      • extracción de fondo Objeto
        Ocultar atributo background_extraction Mostrar atributo background_extraction Objeto
        • snapshot Objeto
          Ocultar atributos de instantánea Mostrar atributos de instantánea Objeto
          • eliminar_promocionado booleano
          • incrustar_stm_antes_de_la_promoción booleano
          • mensajes_máximos entero
          • minutos_obsoletos entero
          • cambio de tema habilitado booleano
          • umbral_de_cambio_de_tema Número
          • ttl_días entero
      • capacidad Objeto

        La capacidad establece el número de réplicas del servidor de memoria para este proyecto. Solo infraestructura: nunca se monta en el propio contenedor del servidor de memoria.

        Ocultar atributos de capacidad Mostrar atributos de capacidad Objeto
        • máx. réplicas entero

          El valor mínimo es 1, el valor máximo es 10.

        • réplicas mínimas entero

          El valor mínimo es 1, el valor máximo es 10.

      • tipos_de_memoria_personalizados arreglo[objeto]

        CustomMemoryTypes declara los tipos de memoria definidos por el usuario que proporciona el servidor de memoria. Solo creación: la puerta de enlace rechaza las ediciones o eliminaciones de declaraciones previamente aceptadas. El límite de conteo lo aplica ValidateCustomMemoryTypes, no una etiqueta de estructura, por lo que la constante sigue siendo la única fuente de verdad. La etiqueta binding:"max" es solo para documentación: el controlador decodifica con json.Decoder, no con el enlace gin, por lo que no tiene efecto en tiempo de ejecución; existe únicamente para mostrar el límite en la especificación OpenAPI generada.

        No más de 5 elementos.

        Ocultar atributos custom_memory_types Mostrar atributos custom_memory_types Objeto
        • Colección string Requerido
        • Nombre string Requerido
        • etiqueta arreglo[objeto]

          No más de 10 elementos.

          Hide tags attribute Show tags attribute Objeto
          • Nombre string
      • extracción Objeto
        Ocultar atributos de extracción Mostrar atributos de extracción Objeto
        • habilitado array[string]

          Las listas habilitadas especifican qué tipos de extracción ejecutar. Cada elemento debe ser uno de los siguientes: semántico, episódico, taxonómico, preferencias, procedimental.

        • episódico Objeto
          Hide episodic attribute Show episodic attribute Objeto
          • prompt string

            La longitud máxima es 4096.

        • preferencias Objeto
          atributo de ocultar preferencias Mostrar atributo de preferencias Objeto
          • prompt string

            La longitud máxima es 4096.

        • procesal Objeto
          Ocultar atributo procedimental Mostrar atributo de procedimiento Objeto
          • prompt string

            La longitud máxima es 4096.

        • semántico Objeto
          Ocultar atributo semántico Mostrar atributo semántico Objeto
          • prompt string

            La longitud máxima es 4096.

        • taxonómico Objeto
          Hide taxonomic attribute Mostrar atributo taxonómico Objeto
          • prompt string

            La longitud máxima es 4096.

      • extracción_llm Objeto
        Ocultar atributos de extraction_llm Mostrar atributos de extraction_llm Objeto
        • api_key_secret string

          APIKeySecret es el nombre del secreto con ámbito de proyecto que contiene la credencial de extracción. Puede ser uno de los siguientes: LLM_API_KEY, OPENAI_API_KEY, ANTHROPIC_API_KEY, GEMINI_API_KEY o CEREBRAS_API_KEY. Omita la detección automática de estas variables de entorno.

          Los valores son LLM_API_KEY, OPENAI_API_KEY, ANTHROPIC_API_KEY, GEMINI_API_KEY o CEREBRAS_API_KEY.

        • encabezado_autenticación string

          AuthHeader es el encabezado HTTP que la puerta de enlace espera para la clave API. "authorization" envía autenticación Bearer (valor predeterminado de LiteLLM). "api-key" envía el encabezado estilo Azure/Grove. Omitir para el valor predeterminado del proveedor.

          Los valores son authorization o api-key.

        • base_url string

          BaseURL es un punto final de puerta de enlace opcional. Se requiere HTTPS, excepto para HTTP de bucle invertido. Se rechaza la información de usuario (credenciales integradas). Cuando se configura, la extracción llama a esta URL en lugar de a la API pública del proveedor.

          La longitud máxima es 2048.

        • Modelo string

          La longitud máxima es 256.

        • Proveedor string

          El proveedor debe ser uno de los siguientes: openai, anthropic, gemini, cerebras.

          Los valores son openai, anthropic, gemini o cerebras.

      • nivel_de_log string

        LogLevel establece el nivel de registro raíz del servidor de memoria para el proyecto. Puede ser uno de los siguientes: debug, info, warning, error o critical. Si se omite este campo, se utilizará el valor predeterminado del servidor (info); se rechazará una cadena vacía explícita.

        Los valores son debug, info, warning, error o critical.

      • índice_de_partición_de_metadatos Objeto

        MetadataPartitionIndex selecciona, para cada tipo de memoria dentro del ámbito, qué ramas del índice de búsqueda contienen los campos de filtro de partición: "vector", "texto" o "ambos". Si un tipo no se incluye en el mapa, se utiliza por defecto solo la rama "vector". Es libremente modificable: solo afecta a las ramas que obtienen los índices recién aprovisionados.

        Ocultar el atributo metadata_partition_index Mostrar atributo metadata_partition_index Objeto
        • * array[string] Propiedades adicionales
      • clave_de_partición_de_metadatos arreglo[objeto]

        MetadataPartitionKey declara atributos de metadatos filtrables que cada tipo de memoria dentro del ámbito (semántico, episódico, procedimental, a corto plazo) indexa como un campo de filtro de partición. Solo creación: la puerta de enlace rechaza eliminar o volver a escribir una clave previamente aceptada (se permiten adiciones). El límite de conteo lo aplica ValidateMetadataPartition, no una etiqueta de estructura, por lo que la constante sigue siendo la única fuente de verdad. La etiqueta binding:"max" es solo para documentación: el controlador decodifica con json.Decoder, no con el enlace gin, por lo que no tiene efecto en tiempo de ejecución; existe únicamente para mostrar el límite en la especificación OpenAPI.

        No más de 10 elementos.

        Ocultar atributos metadata_partition_key Mostrar atributos metadata_partition_key Objeto
        • Nombre string Requerido
        • tipo string Requerido
      • Corto plazo Objeto
        Ocultar atributo a corto plazo Mostrar atributo a corto plazo Objeto
        • incrustar_en_escritura booleano

          EmbedOnWrite hace que el servidor de memoria incruste el contenido de un turno de forma síncrona en el momento de la escritura cuando el llamador no proporciona ninguna incrustación, de modo que el turno se pueda buscar por relevancia inmediatamente en lugar de esperar a que se incruste en segundo plano. El valor predeterminado es falso (ruta de escritura rápida). Es distinto de SnapshotConfig.EmbedSTMBeforePromotion, que incrusta en lotes en el trabajador antes de una comprobación de promoción.

      • Tareas Objeto

        Tasks ajusta el procesamiento de tareas en segundo plano del servidor de memoria.

        Ocultar atributo de tareas Mostrar atributo de tareas Objeto
        • legacy_retry booleano

          LegacyRetry revierte la resolución de fallos de tareas al presupuesto de reintentos limitado anterior (tres reintentos, luego mensaje no entregado) en lugar de reintentar fallos transitorios hasta que expire la tarea. Freno de emergencia: al activarlo, puede finalizar masivamente una acumulación de reintentos. Por defecto, está desactivado.

      • viaje Objeto
        Ocultar atributos del viaje Mostrar atributos del viaje Objeto
        • dimensión entero
        • Modelo string

          La longitud máxima es 256.

    • Generación entero
    • generación_recibida entero
    • updated_at string
    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • config Objeto
      Ocultar atributos de configuración Show config attributes Objeto
      • extracción de fondo Objeto
        Ocultar atributo background_extraction Mostrar atributo background_extraction Objeto
        • snapshot Objeto
          Ocultar atributos de instantánea Mostrar atributos de instantánea Objeto
          • eliminar_promocionado booleano
          • incrustar_stm_antes_de_la_promoción booleano
          • mensajes_máximos entero
          • minutos_obsoletos entero
          • cambio de tema habilitado booleano
          • umbral_de_cambio_de_tema Número
          • ttl_días entero
      • capacidad Objeto

        La capacidad establece el número de réplicas del servidor de memoria para este proyecto. Solo infraestructura: nunca se monta en el propio contenedor del servidor de memoria.

        Ocultar atributos de capacidad Mostrar atributos de capacidad Objeto
        • máx. réplicas entero

          El valor mínimo es 1, el valor máximo es 10.

        • réplicas mínimas entero

          El valor mínimo es 1, el valor máximo es 10.

      • tipos_de_memoria_personalizados arreglo[objeto]

        CustomMemoryTypes declara los tipos de memoria definidos por el usuario que proporciona el servidor de memoria. Solo creación: la puerta de enlace rechaza las ediciones o eliminaciones de declaraciones previamente aceptadas. El límite de conteo lo aplica ValidateCustomMemoryTypes, no una etiqueta de estructura, por lo que la constante sigue siendo la única fuente de verdad. La etiqueta binding:"max" es solo para documentación: el controlador decodifica con json.Decoder, no con el enlace gin, por lo que no tiene efecto en tiempo de ejecución; existe únicamente para mostrar el límite en la especificación OpenAPI generada.

        No más de 5 elementos.

        Ocultar atributos custom_memory_types Mostrar atributos custom_memory_types Objeto
        • Colección string Requerido
        • Nombre string Requerido
        • etiqueta arreglo[objeto]

          No más de 10 elementos.

          Hide tags attribute Show tags attribute Objeto
          • Nombre string
      • extracción Objeto
        Ocultar atributos de extracción Mostrar atributos de extracción Objeto
        • habilitado array[string]

          Las listas habilitadas especifican qué tipos de extracción ejecutar. Cada elemento debe ser uno de los siguientes: semántico, episódico, taxonómico, preferencias, procedimental.

        • episódico Objeto
          Hide episodic attribute Show episodic attribute Objeto
          • prompt string

            La longitud máxima es 4096.

        • preferencias Objeto
          atributo de ocultar preferencias Mostrar atributo de preferencias Objeto
          • prompt string

            La longitud máxima es 4096.

        • procesal Objeto
          Ocultar atributo procedimental Mostrar atributo de procedimiento Objeto
          • prompt string

            La longitud máxima es 4096.

        • semántico Objeto
          Ocultar atributo semántico Mostrar atributo semántico Objeto
          • prompt string

            La longitud máxima es 4096.

        • taxonómico Objeto
          Hide taxonomic attribute Mostrar atributo taxonómico Objeto
          • prompt string

            La longitud máxima es 4096.

      • extracción_llm Objeto
        Ocultar atributos de extraction_llm Mostrar atributos de extraction_llm Objeto
        • api_key_secret string

          APIKeySecret es el nombre del secreto con ámbito de proyecto que contiene la credencial de extracción. Puede ser uno de los siguientes: LLM_API_KEY, OPENAI_API_KEY, ANTHROPIC_API_KEY, GEMINI_API_KEY o CEREBRAS_API_KEY. Omita la detección automática de estas variables de entorno.

          Los valores son LLM_API_KEY, OPENAI_API_KEY, ANTHROPIC_API_KEY, GEMINI_API_KEY o CEREBRAS_API_KEY.

        • encabezado_autenticación string

          AuthHeader es el encabezado HTTP que la puerta de enlace espera para la clave API. "authorization" envía autenticación Bearer (valor predeterminado de LiteLLM). "api-key" envía el encabezado estilo Azure/Grove. Omitir para el valor predeterminado del proveedor.

          Los valores son authorization o api-key.

        • base_url string

          BaseURL es un punto final de puerta de enlace opcional. Se requiere HTTPS, excepto para HTTP de bucle invertido. Se rechaza la información de usuario (credenciales integradas). Cuando se configura, la extracción llama a esta URL en lugar de a la API pública del proveedor.

          La longitud máxima es 2048.

        • Modelo string

          La longitud máxima es 256.

        • Proveedor string

          El proveedor debe ser uno de los siguientes: openai, anthropic, gemini, cerebras.

          Los valores son openai, anthropic, gemini o cerebras.

      • nivel_de_log string

        LogLevel establece el nivel de registro raíz del servidor de memoria para el proyecto. Puede ser uno de los siguientes: debug, info, warning, error o critical. Si se omite este campo, se utilizará el valor predeterminado del servidor (info); se rechazará una cadena vacía explícita.

        Los valores son debug, info, warning, error o critical.

      • índice_de_partición_de_metadatos Objeto

        MetadataPartitionIndex selecciona, para cada tipo de memoria dentro del ámbito, qué ramas del índice de búsqueda contienen los campos de filtro de partición: "vector", "texto" o "ambos". Si un tipo no se incluye en el mapa, se utiliza por defecto solo la rama "vector". Es libremente modificable: solo afecta a las ramas que obtienen los índices recién aprovisionados.

        Ocultar el atributo metadata_partition_index Mostrar atributo metadata_partition_index Objeto
        • * array[string] Propiedades adicionales
      • clave_de_partición_de_metadatos arreglo[objeto]

        MetadataPartitionKey declara atributos de metadatos filtrables que cada tipo de memoria dentro del ámbito (semántico, episódico, procedimental, a corto plazo) indexa como un campo de filtro de partición. Solo creación: la puerta de enlace rechaza eliminar o volver a escribir una clave previamente aceptada (se permiten adiciones). El límite de conteo lo aplica ValidateMetadataPartition, no una etiqueta de estructura, por lo que la constante sigue siendo la única fuente de verdad. La etiqueta binding:"max" es solo para documentación: el controlador decodifica con json.Decoder, no con el enlace gin, por lo que no tiene efecto en tiempo de ejecución; existe únicamente para mostrar el límite en la especificación OpenAPI.

        No más de 10 elementos.

        Ocultar atributos metadata_partition_key Mostrar atributos metadata_partition_key Objeto
        • Nombre string Requerido
        • tipo string Requerido
      • Corto plazo Objeto
        Ocultar atributo a corto plazo Mostrar atributo a corto plazo Objeto
        • incrustar_en_escritura booleano

          EmbedOnWrite hace que el servidor de memoria incruste el contenido de un turno de forma síncrona en el momento de la escritura cuando el llamador no proporciona ninguna incrustación, de modo que el turno se pueda buscar por relevancia inmediatamente en lugar de esperar a que se incruste en segundo plano. El valor predeterminado es falso (ruta de escritura rápida). Es distinto de SnapshotConfig.EmbedSTMBeforePromotion, que incrusta en lotes en el trabajador antes de una comprobación de promoción.

      • Tareas Objeto

        Tasks ajusta el procesamiento de tareas en segundo plano del servidor de memoria.

        Ocultar atributo de tareas Mostrar atributo de tareas Objeto
        • legacy_retry booleano

          LegacyRetry revierte la resolución de fallos de tareas al presupuesto de reintentos limitado anterior (tres reintentos, luego mensaje no entregado) en lugar de reintentar fallos transitorios hasta que expire la tarea. Freno de emergencia: al activarlo, puede finalizar masivamente una acumulación de reintentos. Por defecto, está desactivado.

      • viaje Objeto
        Ocultar atributos del viaje Mostrar atributos del viaje Objeto
        • dimensión entero
        • Modelo string

          La longitud máxima es 256.

    • Generación entero
    • generación_recibida entero
    • updated_at string
  • 401

    Credenciales faltantes o no válidas

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Código string
    • Error string
    • éxito booleano
    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Código string
    • Error string
    • éxito booleano
  • 403

    La persona que llama no tiene permiso de lectura.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Código string
    • Error string
    • éxito booleano
    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Código string
    • Error string
    • éxito booleano
  • 404

    No se ha almacenado ninguna configuración para el proyecto.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Código string
    • Error string
    • éxito booleano
    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Código string
    • Error string
    • éxito 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"
Ejemplos de respuesta (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"
}
Ejemplos de respuesta (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"
}
Ejemplos de respuesta (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"
}
Ejemplos de respuesta (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"
}
Ejemplos de respuesta (401)
{
  "code": "string",
  "error": "string",
  "success": true
}
Ejemplos de respuesta (401)
{
  "code": "string",
  "error": "string",
  "success": true
}
Ejemplos de respuesta (403)
{
  "code": "string",
  "error": "string",
  "success": true
}
Ejemplos de respuesta (403)
{
  "code": "string",
  "error": "string",
  "success": true
}
Ejemplos de respuesta (404)
{
  "code": "string",
  "error": "string",
  "success": true
}
Ejemplos de respuesta (404)
{
  "code": "string",
  "error": "string",
  "success": true
}