获取项目内存配置

获取 /api/v1/projects/{id}/memory/config
持有者身份验证

返回当前项目级内存服务器配置。项目范围由路由 ID 路径参数承载，而组织则派生自该项目。

路径参数

  • id 字符串 必需

    项目 ID

响应

  • 406

    不支持或格式不正确的API版本、所选已发布合约中不可用的操作或不可接受的表示形式（包括不支持的媒体类型参数或排除的 SSE）。现有的身份验证、授权和速率限制失败优先。

    隐藏响应属性 显示响应属性 对象
    • badRequestDetail 对象

      标准错误模式定义的可选验证详细信息； API协商错误不会发出此字段。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

        验证失败的字段。

        隐藏字段属性 显示字段属性 对象

        字段及其验证失败。

        • 描述 字符串 必需

          人类可读的验证失败。

        • 字段 字符串 必需

          无效请求字段的名称或路径。

    • 详细信息 字符串 必需

      人类可读的错误详细信息。

    • 错误 整型 必需

      HTTP status code.

    • 错误代码 字符串 必需

      机器可读的错误代码。

    • 参数 array[string]

      与错误相关的请求参数名称；不应用时省略。

    • 原因 字符串 必需

      HTTP状态原因短语。

    隐藏响应属性 显示响应属性 对象
    • badRequestDetail 对象

      标准错误模式定义的可选验证详细信息； API协商错误不会发出此字段。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

        验证失败的字段。

        隐藏字段属性 显示字段属性 对象

        字段及其验证失败。

        • 描述 字符串 必需

          人类可读的验证失败。

        • 字段 字符串 必需

          无效请求字段的名称或路径。

    • 详细信息 字符串 必需

      人类可读的错误详细信息。

    • 错误 整型 必需

      HTTP status code.

    • 错误代码 字符串 必需

      机器可读的错误代码。

    • 参数 array[string]

      与错误相关的请求参数名称；不应用时省略。

    • 原因 字符串 必需

      HTTP状态原因短语。
  • 200

    正常

    隐藏响应属性 显示响应属性 对象
    • config 对象
      隐藏配置属性 显示配置属性 对象
      • background_extraction 对象
        隐藏background_extraction 属性 显示background_extraction 属性 对象
        • snapshot 对象
          隐藏快照属性 显示快照属性 对象
          • delete_promoted 布尔
          • embed_stm_before_promotion 布尔
          • max_messages 整型
          • stale_minutes 整型
          • topic_shift_enabled 布尔
          • topic_shift_threshold 数字
          • ttl_days 整型
      • 能力 对象

        容量为此项目设置内存服务器的副本数。仅限基础设施：从不安装到内存服务器容器本身。

        隐藏容量属性 显示容量属性 对象
        • max_replicas 整型

          最小值为 1，最大值为 10。

        • min_replicas 整型

          最小值为 1，最大值为 10。

      • custom_memory_types 大量[对象]

        CustomMemoryTypes 声明内存服务器提供的用户定义的内存类型。仅限创建：网关拒绝对先前已接受的声明进行编辑或删除。计数限制由 ValidateCustomMemoryTypes 而不是 struct 标签强制执行，因此该常量仍然是单一事实来源。绑定：“max”标签仅为 doc — 处理程序使用 json.Decoder 进行解码，而不是 gin 绑定，因此它没有运行时效果；它的存在只是为了在生成的 OpenAPI 规范中显示限制。

        不超过 5 个元素。

        隐藏 custom_memory_types 属性 显示 custom_memory_types 属性 对象
        • 集合 字符串 必需
        • 名称 字符串 必需
        • 标记 大量[对象]

          不超过 10 个元素。

          Hide tags attribute Show tags attribute 对象
          • 名称 字符串
      • 提取 对象
        隐藏提取属性 显示提取属性 对象
        • enabled array[string]

          已启用列出要运行的提取类型。每个元素必须是以下元素之一：语义、情节、分类、偏好、程序。

        • 情节性的 对象
          Hide episodic attribute Show episodic attribute 对象
          • prompt 字符串

            最大长度为 4096。

        • 偏好 对象
          隐藏偏好属性 显示偏好属性 对象
          • prompt 字符串

            最大长度为 4096。

        • 过程化 对象
          隐藏程序属性 显示程序属性 对象
          • prompt 字符串

            最大长度为 4096。

        • semantic 对象
          隐藏语义属性 显示语义属性 对象
          • prompt 字符串

            最大长度为 4096。

        • 分类学 对象
          Hide taxonomic attribute 显示分类属性 对象
          • prompt 字符串

            最大长度为 4096。

      • 提取_llm 对象
        隐藏extraction_llm属性 显示extraction_llm 属性 对象
        • api_key_secret 字符串

          APIKeySecret 是保存提取档案的项目范围密钥名称。以下之一：LLM_API_KEY、OPENAI_API_KEY、ANTHROPIC_API_KEY、GEMINI_API_KEY、CEREBRAS_API_KEY。省略从这些环境变量中自动检测。

          取值为 LLM_API_KEY、OPENAI_API_KEY、ANTHROPIC_API_KEY、GEMINI_API_KEY 或 CEREBRAS_API_KEY。

        • auth_header 字符串

          Auth header 是网关期望用于API密钥的HTTP标头。 “authorization”发送 Bearer auth（LiteLLM默认）。 "api-key"发送Azure /Grove 样式标头。对于提供商默认默认。

          值为 authorization 或 api-key。

        • base_url 字符串

          BaseURL 是一个可选的网关端点。除环回HTTP之外，还需要使用 HTTPS。 Userinfo（嵌入式凭证）被拒绝。设立后，提取将调用此URL而不是公共提供商API。

          最大长度为 2048。

        • 模型 字符串

          最大长度为 256。

        • provider 字符串

          提供者必须是以下之一：openai、anthropic、gemini、cerebras。

          取值为 openai、anthropic、gemini 或 cerebras。

      • log_level 字符串

        LogLevel 设置项目的内存服务器根日志级别。以下之一：debug、info、警告、错误、严重。省略该字段以保留服务器默认(info)；显式空字符串会被拒绝。

        取值为 debug、info、warning、error 或 critical。

      • metadata_partition_index 对象

        MetadataPartitionIndex 根据范围内的内存类型选择哪些搜索索引承载分区过滤器字段：“向量”、“文本”或“两者”。地图中省略的类型默认为仅向量支线。自由可变 — 它只影响新配置的索引获得的分支。

        隐藏 metadata_partition_index 属性 显示 metadata_partition_index 属性 对象
        • * array[string] additionalProperties
      • metadata_partition_key 大量[对象]

        MetadataPartitionKey 声明可筛选的元数据属性，每个作用域内的内存类型（语义、情景、程序、短术语）都将这些属性索引为分区过滤字段。仅限创建：网关拒绝删除或重新键入以前接受的密钥（允许添加）。计数限制由 ValidateMetadataPartition 而不是结构体标签强制执行，因此该常量仍然是单一事实来源。绑定：“max”标签仅为 doc — 处理程序使用 json.Decoder 进行解码，而不是 gin 绑定，因此它没有运行时效果；它的存在只是为了揭示 OpenAPI 规范中的限制。

        不超过 10 个元素。

        隐藏 metadata_partition_key 属性 显示 metadata_partition_key 属性 对象
        • 名称 字符串 必需
        • 类型 字符串 必需
      • 短期 对象
        隐藏短期属性 显示短期属性 对象
        • embed_on_write 布尔

          当调用者未提供嵌入时，EmbedOnWrite 使内存服务器在写入时同步嵌入回合的内容，因此可立即按相关性搜索回合，而无需等待背景嵌入。默认为 false（快速写入路径）。与 SnapshotConfig.EmbedSTMBeforePromotion 不同，后者在升级检查之前批量嵌入工作线程中。

      • 任务 对象

        任务可调整内存服务器的背景任务处理。

        隐藏任务属性 显示任务属性 对象
        • legacy_retry 布尔

          LegacyRetry 将任务失败解决恢复到传统有界重试预算（三次重试，然后死信），而不是重试暂时性故障直到任务到期。紧急制动：启用它可以批量终止累积的重试积压。默认为 false。

      • voyage 对象
        隐藏航程属性 显示航次属性 对象
        • 维度 整型
        • 模型 字符串

          最大长度为 256。

    • 生成 整型
    • 收到的_生成 整型
    • updated_at 字符串
    隐藏响应属性 显示响应属性 对象
    • config 对象
      隐藏配置属性 显示配置属性 对象
      • background_extraction 对象
        隐藏background_extraction 属性 显示background_extraction 属性 对象
        • snapshot 对象
          隐藏快照属性 显示快照属性 对象
          • delete_promoted 布尔
          • embed_stm_before_promotion 布尔
          • max_messages 整型
          • stale_minutes 整型
          • topic_shift_enabled 布尔
          • topic_shift_threshold 数字
          • ttl_days 整型
      • 能力 对象

        容量为此项目设置内存服务器的副本数。仅限基础设施：从不安装到内存服务器容器本身。

        隐藏容量属性 显示容量属性 对象
        • max_replicas 整型

          最小值为 1，最大值为 10。

        • min_replicas 整型

          最小值为 1，最大值为 10。

      • custom_memory_types 大量[对象]

        CustomMemoryTypes 声明内存服务器提供的用户定义的内存类型。仅限创建：网关拒绝对先前已接受的声明进行编辑或删除。计数限制由 ValidateCustomMemoryTypes 而不是 struct 标签强制执行，因此该常量仍然是单一事实来源。绑定：“max”标签仅为 doc — 处理程序使用 json.Decoder 进行解码，而不是 gin 绑定，因此它没有运行时效果；它的存在只是为了在生成的 OpenAPI 规范中显示限制。

        不超过 5 个元素。

        隐藏 custom_memory_types 属性 显示 custom_memory_types 属性 对象
        • 集合 字符串 必需
        • 名称 字符串 必需
        • 标记 大量[对象]

          不超过 10 个元素。

          Hide tags attribute Show tags attribute 对象
          • 名称 字符串
      • 提取 对象
        隐藏提取属性 显示提取属性 对象
        • enabled array[string]

          已启用列出要运行的提取类型。每个元素必须是以下元素之一：语义、情节、分类、偏好、程序。

        • 情节性的 对象
          Hide episodic attribute Show episodic attribute 对象
          • prompt 字符串

            最大长度为 4096。

        • 偏好 对象
          隐藏偏好属性 显示偏好属性 对象
          • prompt 字符串

            最大长度为 4096。

        • 过程化 对象
          隐藏程序属性 显示程序属性 对象
          • prompt 字符串

            最大长度为 4096。

        • semantic 对象
          隐藏语义属性 显示语义属性 对象
          • prompt 字符串

            最大长度为 4096。

        • 分类学 对象
          Hide taxonomic attribute 显示分类属性 对象
          • prompt 字符串

            最大长度为 4096。

      • 提取_llm 对象
        隐藏extraction_llm属性 显示extraction_llm 属性 对象
        • api_key_secret 字符串

          APIKeySecret 是保存提取档案的项目范围密钥名称。以下之一：LLM_API_KEY、OPENAI_API_KEY、ANTHROPIC_API_KEY、GEMINI_API_KEY、CEREBRAS_API_KEY。省略从这些环境变量中自动检测。

          取值为 LLM_API_KEY、OPENAI_API_KEY、ANTHROPIC_API_KEY、GEMINI_API_KEY 或 CEREBRAS_API_KEY。

        • auth_header 字符串

          Auth header 是网关期望用于API密钥的HTTP标头。 “authorization”发送 Bearer auth（LiteLLM默认）。 "api-key"发送Azure /Grove 样式标头。对于提供商默认默认。

          值为 authorization 或 api-key。

        • base_url 字符串

          BaseURL 是一个可选的网关端点。除环回HTTP之外，还需要使用 HTTPS。 Userinfo（嵌入式凭证）被拒绝。设立后，提取将调用此URL而不是公共提供商API。

          最大长度为 2048。

        • 模型 字符串

          最大长度为 256。

        • provider 字符串

          提供者必须是以下之一：openai、anthropic、gemini、cerebras。

          取值为 openai、anthropic、gemini 或 cerebras。

      • log_level 字符串

        LogLevel 设置项目的内存服务器根日志级别。以下之一：debug、info、警告、错误、严重。省略该字段以保留服务器默认(info)；显式空字符串会被拒绝。

        取值为 debug、info、warning、error 或 critical。

      • metadata_partition_index 对象

        MetadataPartitionIndex 根据范围内的内存类型选择哪些搜索索引承载分区过滤器字段：“向量”、“文本”或“两者”。地图中省略的类型默认为仅向量支线。自由可变 — 它只影响新配置的索引获得的分支。

        隐藏 metadata_partition_index 属性 显示 metadata_partition_index 属性 对象
        • * array[string] additionalProperties
      • metadata_partition_key 大量[对象]

        MetadataPartitionKey 声明可筛选的元数据属性，每个作用域内的内存类型（语义、情景、程序、短术语）都将这些属性索引为分区过滤字段。仅限创建：网关拒绝删除或重新键入以前接受的密钥（允许添加）。计数限制由 ValidateMetadataPartition 而不是结构体标签强制执行，因此该常量仍然是单一事实来源。绑定：“max”标签仅为 doc — 处理程序使用 json.Decoder 进行解码，而不是 gin 绑定，因此它没有运行时效果；它的存在只是为了揭示 OpenAPI 规范中的限制。

        不超过 10 个元素。

        隐藏 metadata_partition_key 属性 显示 metadata_partition_key 属性 对象
        • 名称 字符串 必需
        • 类型 字符串 必需
      • 短期 对象
        隐藏短期属性 显示短期属性 对象
        • embed_on_write 布尔

          当调用者未提供嵌入时，EmbedOnWrite 使内存服务器在写入时同步嵌入回合的内容，因此可立即按相关性搜索回合，而无需等待背景嵌入。默认为 false（快速写入路径）。与 SnapshotConfig.EmbedSTMBeforePromotion 不同，后者在升级检查之前批量嵌入工作线程中。

      • 任务 对象

        任务可调整内存服务器的背景任务处理。

        隐藏任务属性 显示任务属性 对象
        • legacy_retry 布尔

          LegacyRetry 将任务失败解决恢复到传统有界重试预算（三次重试，然后死信），而不是重试暂时性故障直到任务到期。紧急制动：启用它可以批量终止累积的重试积压。默认为 false。

      • voyage 对象
        隐藏航程属性 显示航次属性 对象
        • 维度 整型
        • 模型 字符串

          最大长度为 256。

    • 生成 整型
    • 收到的_生成 整型
    • updated_at 字符串
  • 401

    凭证缺失或无效

    隐藏响应属性 显示响应属性 对象
    • 代码 字符串
    • 错误 字符串
    • Success 布尔
    隐藏响应属性 显示响应属性 对象
    • 代码 字符串
    • 错误 字符串
    • Success 布尔
  • 403

    调用者缺乏读取权限

    隐藏响应属性 显示响应属性 对象
    • 代码 字符串
    • 错误 字符串
    • Success 布尔
    隐藏响应属性 显示响应属性 对象
    • 代码 字符串
    • 错误 字符串
    • Success 布尔
  • 404

    没有为项目存储配置

    隐藏响应属性 显示响应属性 对象
    • 代码 字符串
    • 错误 字符串
    • Success 布尔
    隐藏响应属性 显示响应属性 对象
    • 代码 字符串
    • 错误 字符串
    • Success 布尔
GET /api/v1/projects/{id}/memory/config 
curl \
 --request GET 'https://agentengine.mongodb.com/api/v1/projects/{id}/memory/config' \
 --header "Authorization: $API_KEY"
响应示例 (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"
}
响应示例 (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"
}
响应示例 (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"
}
响应示例 (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"
}
响应示例 (401) 
{
  "code": "string",
  "error": "string",
  "success": true
}
响应示例 (401) 
{
  "code": "string",
  "error": "string",
  "success": true
}
响应示例 (403) 
{
  "code": "string",
  "error": "string",
  "success": true
}
响应示例 (403) 
{
  "code": "string",
  "error": "string",
  "success": true
}
响应示例 (404) 
{
  "code": "string",
  "error": "string",
  "success": true
}
响应示例 (404) 
{
  "code": "string",
  "error": "string",
  "success": true
}