English ← MyDocs

列出会话

get /v1/sessions

列出会话

查询参数

  • agent_id: optional string

    按此 agent ID 过滤创建的会话。

  • agent_version: optional number

    按代理版本过滤。仅在同时设置了 agent_id 时适用。

  • "created_at[gt]": optional string

    返回在此时间之后创建的会话(不包含)。

  • "created_at[gte]": optional string

    返回在此时间或之后创建的会话(包含)。

  • "created_at[lt]": optional string

    返回在此时间之前创建的会话(不包含)。

  • "created_at[lte]": optional string

    返回在此时间或之前创建的会话(包含)。

  • include_archived: optional boolean

    为 true 时,包含已归档的会话。默认:false(排除已归档)。

  • limit: optional number

    返回的最大结果数。

  • memory_store_id: optional string

    过滤资源中包含此内存存储 ID 的 memory_store 的会话。

  • order: optional "asc" or "desc"

    结果的排序方向,按 created_at 排序。默认为 desc(最新优先)。

    • "asc"

    • "desc"

  • page: optional string

    来自先前响应 next_page 的不透明分页游标。

  • statuses: optional array of "rescheduling" or "running" or "idle" or "terminated"

    按会话状态过滤。重复参数以匹配多个状态中的任何一个。

    • "rescheduling"

    • "running"

    • "idle"

    • "terminated"

请求头参数

  • "anthropic-beta": optional array of AnthropicBeta

    可选的请求头,用于指定要使用的 beta 版本。

    • string

    • "message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 22 more

      • "message-batches-2024-09-24"

      • "prompt-caching-2024-07-31"

      • "computer-use-2024-10-22"

      • "computer-use-2025-01-24"

      • "pdfs-2024-09-25"

      • "token-counting-2024-11-01"

      • "token-efficient-tools-2025-02-19"

      • "output-128k-2025-02-19"

      • "files-api-2025-04-14"

      • "mcp-client-2025-04-04"

      • "mcp-client-2025-11-20"

      • "dev-full-thinking-2025-05-14"

      • "interleaved-thinking-2025-05-14"

      • "code-execution-2025-05-22"

      • "extended-cache-ttl-2025-04-11"

      • "context-1m-2025-08-07"

      • "context-management-2025-06-27"

      • "model-context-window-exceeded-2025-08-26"

      • "skills-2025-10-02"

      • "fast-mode-2026-02-01"

      • "output-300k-2026-03-24"

      • "user-profiles-2026-03-24"

      • "advisor-tool-2026-03-01"

      • "managed-agents-2026-04-01"

      • "cache-diagnosis-2026-04-07"

返回值

  • data: optional array of BetaManagedAgentsSession

    会话列表。

    • id: string

    • agent: BetaManagedAgentsSessionAgent

      已解析的 sessionagent 定义。session 创建时 agent 的快照。

      • id: string

      • description: string

      • mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition

        • name: string

        • type: "url"

          • "url"
        • url: string

      • model: BetaManagedAgentsModelConfig

        模型标识符和配置。

        • id: BetaManagedAgentsModel

          驱动您的代理的模型。

          有关更多详细信息和选项,请参阅 models

          • "claude-opus-4-7" or "claude-opus-4-6" or "claude-sonnet-4-6" or 6 more

            驱动您的代理的模型。

            有关更多详细信息和选项,请参阅 models

            • "claude-opus-4-7"

              适用于长时间运行的代理和编码的前沿智能

            • "claude-opus-4-6"

              用于构建代理和编码的最智能模型

            • "claude-sonnet-4-6"

              速度和智能的最佳组合

            • "claude-haiku-4-5"

              具有接近前沿智能的最快模型

            • "claude-haiku-4-5-20251001"

              具有接近前沿智能的最快模型

            • "claude-opus-4-5"

              结合最大智能与实用性能的高级模型

            • "claude-opus-4-5-20251101"

              结合最大智能与实用性能的高级模型

            • "claude-sonnet-4-5"

              适用于代理和编码的高性能模型

            • "claude-sonnet-4-5-20250929"

              适用于代理和编码的高性能模型

          • string

        • speed: optional "standard" or "fast"

          推理速度模式。fast 以更高的价格提供显著更快的输出 token 生成。并非所有模型都支持 fast;无效组合在创建时会被拒绝。

          • "standard"

          • "fast"

      • multiagent: BetaManagedAgentsSessionMultiagentCoordinator

        已解析的协调器拓扑,包含每个成员的完整代理定义。

        • agents: array of BetaManagedAgentsSessionThreadAgent

          协调器可能作为会话线程生成的完整 agent 定义。

          • id: string

          • description: string

          • mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition

            • name: string

            • type: "url"

            • url: string

          • model: BetaManagedAgentsModelConfig

            模型标识符和配置。

          • name: string

          • skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill

            • BetaManagedAgentsAnthropicSkill object { skill_id, type, version }

              已解析的 Anthropic 管理的技能。

              • skill_id: string

              • type: "anthropic"

                • "anthropic"
              • version: string

            • BetaManagedAgentsCustomSkill object { skill_id, type, version }

              已解析的用户创建的自定义技能。

              • skill_id: string

              • type: "custom"

                • "custom"
              • version: string

          • system: string

          • tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool

            • BetaManagedAgentsAgentToolset20260401 object { configs, default_config, type }

              • configs: array of BetaManagedAgentsAgentToolConfig

                • enabled: boolean

                • name: "bash" or "edit" or "read" or 5 more

                  内置代理工具标识符。

                  • "bash"

                  • "edit"

                  • "read"

                  • "write"

                  • "glob"

                  • "grep"

                  • "web_fetch"

                  • "web_search"

                • permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy

                  工具执行的权限策略。

                  • BetaManagedAgentsAlwaysAllowPolicy object { type }

                    工具调用无需用户确认即自动批准。

                    • type: "always_allow"

                      • "always_allow"
                  • BetaManagedAgentsAlwaysAskPolicy object { type }

                    工具调用在执行前需要用户确认。

                    • type: "always_ask"

                      • "always_ask"
              • default_config: BetaManagedAgentsAgentToolsetDefaultConfig

                已解析的代理工具默认配置。

                • enabled: boolean

                • permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy

                  工具执行的权限策略。

                  • BetaManagedAgentsAlwaysAllowPolicy object { type }

                    工具调用无需用户确认即自动批准。

                  • BetaManagedAgentsAlwaysAskPolicy object { type }

                    工具调用在执行前需要用户确认。

              • type: "agent_toolset_20260401"

                • "agent_toolset_20260401"
            • BetaManagedAgentsMCPToolset object { configs, default_config, mcp_server_name, type }

              • configs: array of BetaManagedAgentsMCPToolConfig

                • enabled: boolean

                • name: string

                • permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy

                  工具执行的权限策略。

                  • BetaManagedAgentsAlwaysAllowPolicy object { type }

                    工具调用无需用户确认即自动批准。

                  • BetaManagedAgentsAlwaysAskPolicy object { type }

                    工具调用在执行前需要用户确认。

              • default_config: BetaManagedAgentsMCPToolsetDefaultConfig

                已解析的 MCP 服务器所有工具的默认配置。

                • enabled: boolean

                • permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy

                  工具执行的权限策略。

                  • BetaManagedAgentsAlwaysAllowPolicy object { type }

                    工具调用无需用户确认即自动批准。

                  • BetaManagedAgentsAlwaysAskPolicy object { type }

                    工具调用在执行前需要用户确认。

              • mcp_server_name: string

              • type: "mcp_toolset"

                • "mcp_toolset"
            • BetaManagedAgentsCustomTool object { description, input_schema, name, type }

              API 响应中返回的自定义工具。

              • description: string

              • input_schema: BetaManagedAgentsCustomToolInputSchema

                自定义工具输入参数的 JSON Schema。

                • properties: optional map[unknown]

                  定义工具输入参数的 JSON Schema 属性。

                • required: optional array of string

                  必需属性名称列表。

                • type: optional "object"

                  工具输入模式必须为 'object'。

                  • "object"
              • name: string

              • type: "custom"

                • "custom"
          • type: "agent"

            • "agent"
          • version: number

        • type: "coordinator"

          • "coordinator"
      • name: string

      • skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill

        • BetaManagedAgentsAnthropicSkill object { skill_id, type, version }

          已解析的 Anthropic 管理的技能。

        • BetaManagedAgentsCustomSkill object { skill_id, type, version }

          已解析的用户创建的自定义技能。

      • system: string

      • tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool

        • BetaManagedAgentsAgentToolset20260401 object { configs, default_config, type }

        • BetaManagedAgentsMCPToolset object { configs, default_config, mcp_server_name, type }

        • BetaManagedAgentsCustomTool object { description, input_schema, name, type }

          API 响应中返回的自定义工具。

      • type: "agent"

        • "agent"
      • version: number

    • archived_at: string

      RFC 3339 格式的时间戳

    • created_at: string

      RFC 3339 格式的时间戳

    • environment_id: string

    • metadata: map[string]

    • outcome_evaluations: array of BetaManagedAgentsOutcomeEvaluationResource

      每个结果的评估状态。发送到会话的每个 define_outcome 事件一个条目。

      • completed_at: string

        RFC 3339 格式的时间戳

      • description: string

        代理应产出的内容。

      • explanation: string

        来自最近评估的评分器判定文本。对于 satisfied,解释标准为何满足;对于 needs_revision(中间状态),缺少什么;对于 failed,为何不可恢复。

      • iteration: number

        结果当前所在的从 0 开始的修订循环。

      • outcome_id: string

        此结果的服务器生成的 outc_ ID。

      • result: string

        当前评估状态。代理开始工作前为 pending;生成或修订时为 running;评分器评分时为 evaluatingsatisfied/max_iterations_reached/failed/interrupted 是终止状态。

      • type: "outcome_evaluation"

        • "outcome_evaluation"
    • resources: array of BetaManagedAgentsSessionResource

      • BetaManagedAgentsGitHubRepositoryResource object { id, created_at, mount_path, 4 more }

        • id: string

        • created_at: string

          RFC 3339 格式的时间戳

        • mount_path: string

        • type: "github_repository"

          • "github_repository"
        • updated_at: string

          RFC 3339 格式的时间戳

        • url: string

        • checkout: optional BetaManagedAgentsBranchCheckout or BetaManagedAgentsCommitCheckout

          • BetaManagedAgentsBranchCheckout object { name, type }

            • name: string

              要检出的分支名称。

            • type: "branch"

              • "branch"
          • BetaManagedAgentsCommitCheckout object { sha, type }

            • sha: string

              要检出的完整提交 SHA。

            • type: "commit"

              • "commit"
      • BetaManagedAgentsFileResource object { id, created_at, file_id, 3 more }

        • id: string

        • created_at: string

          RFC 3339 格式的时间戳

        • file_id: string

        • mount_path: string

        • type: "file"

          • "file"
        • updated_at: string

          RFC 3339 格式的时间戳

      • BetaManagedAgentsMemoryStoreResource object { memory_store_id, type, access, 4 more }

        附加到代理会话的内存存储。

        • memory_store_id: string

          内存存储 ID(memstore_...)。必须属于调用者的组织和工作区。

        • type: "memory_store"

          • "memory_store"
        • access: optional "read_write" or "read_only"

          附加内存存储的访问模式。

          • "read_write"

          • "read_only"

        • description: optional string

          内存存储的描述,在附加时快照。渲染到代理的系统提示中。存储没有描述时为空字符串。

        • instructions: optional string

          每个附加项对代理如何使用此存储的指导。渲染到系统提示的记忆部分。最多 4096 个字符。

        • mount_path: optional string

          存储在会话容器中挂载的文件系统路径,例如 /mnt/memory/user-preferences。从存储的名称派生。仅输出。

        • name: optional string

          内存存储的显示名称,在附加时快照。之后对存储名称的编辑不会传播到此资源。

    • stats: BetaManagedAgentsSessionStats

      会话的计时统计。

      • active_seconds: optional number

        会话处于运行状态的累计时间(秒)。不包括空闲时间。

      • duration_seconds: optional number

        自会话创建以来经过的时间(秒)。对于已终止的会话,冻结在最终更新。

    • status: "rescheduling" or "running" or "idle" or "terminated"

      SessionStatus enum

      • "rescheduling"

      • "running"

      • "idle"

      • "terminated"

    • title: string

    • type: "session"

      • "session"
    • updated_at: string

      RFC 3339 格式的时间戳

    • usage: BetaManagedAgentsSessionUsage

      会话跨所有轮次的累计 token 使用量。

      • cache_creation: optional BetaManagedAgentsCacheCreationUsage

        按缓存生命周期分解的提示缓存创建 token 使用量。

        • ephemeral_1h_input_tokens: optional number

          用于创建 1 小时临时缓存条目的 token。

        • ephemeral_5m_input_tokens: optional number

          用于创建 5 分钟临时缓存条目的 token。

      • cache_read_input_tokens: optional number

        从提示缓存读取的总 token。

      • input_tokens: optional number

        跨所有轮次消耗的总输入 token。

      • output_tokens: optional number

        跨所有轮次生成的总输出 token。

    • vault_ids: array of string

      创建时附加到会话的 Vault ID。未提供 Vault 时为空。

  • next_page: optional string

    下一页的不透明游标。没有更多结果时为 null。

示例

curl https://api.anthropic.com/v1/sessions \
    -H 'anthropic-version: 2023-06-01' \
    -H 'anthropic-beta: managed-agents-2026-04-01' \
    -H "X-Api-Key: $ANTHROPIC_API_KEY"

响应

{
  "data": [
    {
      "id": "sesn_011CZkZAtmR3yMPDzynEDxu7",
      "agent": {
        "id": "agent_011CZkYpogX7uDKUyvBTophP",
        "description": "A general-purpose starter agent.",
        "mcp_servers": [
          {
            "name": "example-mcp",
            "type": "url",
            "url": "https://example-server.modelcontextprotocol.io/sse"
          }
        ],
        "model": {
          "id": "claude-sonnet-4-6",
          "speed": "standard"
        },
        "multiagent": {
          "agents": [
            {
              "id": "agent_011CZkYqphY8vELVzwCUpqiQ",
              "description": "A focused research subagent.",
              "mcp_servers": [
                {
                  "name": "example-mcp",
                  "type": "url",
                  "url": "https://example-server.modelcontextprotocol.io/sse"
                }
              ],
              "model": {
                "id": "claude-sonnet-4-6",
                "speed": "standard"
              },
              "name": "Researcher",
              "skills": [
                {
                  "skill_id": "xlsx",
                  "type": "anthropic",
                  "version": "1"
                }
              ],
              "system": "You are a research subagent that gathers and summarises sources for the coordinating agent.",
              "tools": [
                {
                  "configs": [
                    {
                      "enabled": true,
                      "name": "bash",
                      "permission_policy": {
                        "type": "always_allow"
                      }
                    }
                  ],
                  "default_config": {
                    "enabled": true,
                    "permission_policy": {
                      "type": "always_ask"
                    }
                  },
                  "type": "agent_toolset_20260401"
                }
              ],
              "type": "agent",
              "version": 1
            }
          ],
          "type": "coordinator"
        },
        "name": "My First Agent",
        "skills": [
          {
            "skill_id": "xlsx",
            "type": "anthropic",
            "version": "1"
          },
          {
            "skill_id": "skill_011CZkZFNu9hAbo3jZPRgTlx",
            "type": "custom",
            "version": "2"
          }
        ],
        "system": "You are a general-purpose agent that can research, write code, run commands, and use connected tools to complete the user's task end to end.",
        "tools": [
          {
            "configs": [
              {
                "enabled": true,
                "name": "bash",
                "permission_policy": {
                  "type": "always_allow"
                }
              }
            ],
            "default_config": {
              "enabled": true,
              "permission_policy": {
                "type": "always_ask"
              }
            },
            "type": "agent_toolset_20260401"
          }
        ],
        "type": "agent",
        "version": 1
      },
      "archived_at": null,
      "created_at": "2026-03-15T10:00:00Z",
      "environment_id": "env_011CZkZ9X2dpNyB7HsEFoRfW",
      "metadata": {},
      "outcome_evaluations": [
        {
          "completed_at": "2026-03-15T10:02:31Z",
          "description": "Produce a 2-page summary as summary.md",
          "explanation": "All five sections present with inline citations.",
          "iteration": 0,
          "outcome_id": "outc_011CZkZRSw2kEfs6ncTVljxP",
          "result": "satisfied",
          "type": "outcome_evaluation"
        }
      ],
      "resources": [
        {
          "id": "sesrsc_011CZkZBJq5dWxk9fVLNcPht",
          "created_at": "2026-03-15T10:00:00Z",
          "file_id": "file_011CNha8iCJcU1wXNR6q4V8w",
          "mount_path": "/uploads/receipt.pdf",
          "type": "file",
          "updated_at": "2026-03-15T10:00:00Z"
        },
        {
          "id": "sesrsc_011CZkZCKr6eXyl0gWMOdQiu",
          "created_at": "2026-03-15T10:00:00Z",
          "mount_path": "/workspace/example-repo",
          "type": "github_repository",
          "updated_at": "2026-03-15T10:00:00Z",
          "url": "https://github.com/example-org/example-repo",
          "checkout": {
            "name": "main",
            "type": "branch"
          }
        }
      ],
      "stats": {
        "active_seconds": 0,
        "duration_seconds": 0
      },
      "status": "idle",
      "title": "Order #1234 inquiry",
      "type": "session",
      "updated_at": "2026-03-15T10:00:00Z",
      "usage": {
        "cache_creation": {
          "ephemeral_1h_input_tokens": 0,
          "ephemeral_5m_input_tokens": 0
        },
        "cache_read_input_tokens": 0,
        "input_tokens": 0,
        "output_tokens": 0
      },
      "vault_ids": [
        "vlt_011CZkZDLs7fYzm1hXNPeRjv"
      ]
    }
  ],
  "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo="
}