KakaFlow KB

Archive Session Thread API

7 phút đọc

Archive Session Thread API

Trust: ★★★☆☆ (0.90) · 0 validations · developer_reference

Published: 2026-05-10 · Source: crawler_authoritative

Tình huống

Python SDK documentation for the Anthropic Claude API’s beta endpoint to archive a session thread, targeting developers integrating managed agents functionality.

Insight

The archive endpoint is accessed via client.beta.sessions.threads.archive() with two required string parameters: session_id and thread_id. The method accepts optional ThreadArchiveParams including a betas parameter for specifying beta version(s) to use. Available beta versions include: 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, and managed-agents-2026-04-01. The HTTP endpoint is POST /v1/sessions/{session_id}/threads/{thread_id}/archive. The response returns a BetaManagedAgentsSessionThread object containing thread metadata including id, agent definition with model configuration (supported 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), skills (anthropic or custom types), tools with permission policies (always_allow or always_ask), MCP server configurations, timing statistics (active_seconds, duration_seconds, startup_seconds), usage metrics (input_tokens, output_tokens, cache_read_input_tokens, cache_creation tokens), status (running, idle, rescheduling, terminated), timestamps (created_at, updated_at, archived_at), and parent_thread_id linkage.

Hành động

To archive a session thread using the Python SDK, create an Anthropic client (api_key can be omitted as it defaults to ANTHROPIC_API_KEY environment variable), then call client.beta.sessions.threads.archive() passing the thread_id and session_id as string parameters. The method returns a BetaManagedAgentsSessionThread object with the archived thread’s updated state including an archived_at timestamp. For the HTTP API directly, send a POST request to /v1/sessions/{session_id}/threads/{thread_id}/archive with the session_id and thread_id as path parameters, optionally including a betas header to specify beta versions.

Kết quả

Returns a BetaManagedAgentsSessionThread object representing the archived thread, with updated archived_at timestamp set to the archive time in RFC 3339 format. The thread status transitions appropriately, and the returned object includes complete thread metadata, agent configuration snapshots, usage statistics frozen at archive time, and parent/child thread relationships.

Điều kiện áp dụng

This is a beta API. The managed-agents-2026-04-01 beta version may be relevant for managed agents functionality. Thread archiving applies to session threads within managed agent sessions.

Nội dung gốc (Original)

Archive

beta.sessions.threads.archive(strthread_id, ThreadArchiveParams**kwargs) -> BetaManagedAgentsSessionThread

post /v1/sessions/{session_id}/threads/{thread_id}/archive

Archive Session Thread

Parameters

  • session_id: str

  • thread_id: str

  • betas: Optional[List[AnthropicBetaParam]]

    Optional header to specify the beta version(s) you want to use.

    • str

    • Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 21 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"

Returns

  • class BetaManagedAgentsSessionThread: …

    An execution thread within a session. Each session has one primary thread plus zero or more child threads spawned by the coordinator.

    • id: str

      Unique identifier for this thread.

    • agent: BetaManagedAgentsSessionThreadAgent

      Resolved agent definition for a single session_thread. Snapshot of the agent at thread creation time. The multiagent roster is not repeated here; read it from Session.agent.

      • id: str

      • description: Optional[str]

      • mcp_servers: List[BetaManagedAgentsMCPServerURLDefinition]

        • name: str

        • type: Literal["url"]

          • "url"

        • url: str

      • model: BetaManagedAgentsModelConfig

        Model identifier and configuration.

        • id: BetaManagedAgentsModel

          The model that will power your agent.

          See models for additional details and options.

          • Literal["claude-opus-4-7", "claude-opus-4-6", "claude-sonnet-4-6", 6 more]

            The model that will power your agent.

            See models for additional details and options.

            • claude-opus-4-7 - Frontier intelligence for long-running agents and coding

            • claude-opus-4-6 - Most intelligent model for building agents and coding

            • claude-sonnet-4-6 - Best combination of speed and intelligence

            • claude-haiku-4-5 - Fastest model with near-frontier intelligence

            • claude-haiku-4-5-20251001 - Fastest model with near-frontier intelligence

            • claude-opus-4-5 - Premium model combining maximum intelligence with practical performance

            • claude-opus-4-5-20251101 - Premium model combining maximum intelligence with practical performance

            • claude-sonnet-4-5 - High-performance model for agents and coding

            • claude-sonnet-4-5-20250929 - High-performance model for agents and coding

            • "claude-opus-4-7"

              Frontier intelligence for long-running agents and coding

            • "claude-opus-4-6"

              Most intelligent model for building agents and coding

            • "claude-sonnet-4-6"

              Best combination of speed and intelligence

            • "claude-haiku-4-5"

              Fastest model with near-frontier intelligence

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

              Fastest model with near-frontier intelligence

            • "claude-opus-4-5"

              Premium model combining maximum intelligence with practical performance

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

              Premium model combining maximum intelligence with practical performance

            • "claude-sonnet-4-5"

              High-performance model for agents and coding

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

              High-performance model for agents and coding

          • str

        • speed: Optional[Literal["standard", "fast"]]

          Inference speed mode. fast provides significantly faster output token generation at premium pricing. Not all models support fast; invalid combinations are rejected at create time.

          • "standard"

          • "fast"

      • name: str

      • skills: List[Skill]

        • class BetaManagedAgentsAnthropicSkill: …

          A resolved Anthropic-managed skill.

          • skill_id: str

          • type: Literal["anthropic"]

            • "anthropic"

          • version: str

        • class BetaManagedAgentsCustomSkill: …

          A resolved user-created custom skill.

          • skill_id: str

          • type: Literal["custom"]

            • "custom"

          • version: str

      • system: Optional[str]

      • tools: List[Tool]

        • class BetaManagedAgentsAgentToolset20260401: …

          • configs: List[BetaManagedAgentsAgentToolConfig]

            • enabled: bool

            • name: Literal["bash", "edit", "read", 5 more]

              Built-in agent tool identifier.

              • "bash"

              • "edit"

              • "read"

              • "write"

              • "glob"

              • "grep"

              • "web_fetch"

              • "web_search"

            • permission_policy: PermissionPolicy

              Permission policy for tool execution.

              • class BetaManagedAgentsAlwaysAllowPolicy: …

                Tool calls are automatically approved without user confirmation.

                • type: Literal["always_allow"]

                  • "always_allow"

              • class BetaManagedAgentsAlwaysAskPolicy: …

                Tool calls require user confirmation before execution.

                • type: Literal["always_ask"]

                  • "always_ask"

          • default_config: BetaManagedAgentsAgentToolsetDefaultConfig

            Resolved default configuration for agent tools.

            • enabled: bool

            • permission_policy: PermissionPolicy

              Permission policy for tool execution.

              • class BetaManagedAgentsAlwaysAllowPolicy: …

                Tool calls are automatically approved without user confirmation.

                • type: Literal["always_allow"]

                  • "always_allow"

              • class BetaManagedAgentsAlwaysAskPolicy: …

                Tool calls require user confirmation before execution.

                • type: Literal["always_ask"]

                  • "always_ask"

          • type: Literal["agent_toolset_20260401"]

            • "agent_toolset_20260401"

        • class BetaManagedAgentsMCPToolset: …

          • configs: List[BetaManagedAgentsMCPToolConfig]

            • enabled: bool

            • name: str

            • permission_policy: PermissionPolicy

              Permission policy for tool execution.

              • class BetaManagedAgentsAlwaysAllowPolicy: …

                Tool calls are automatically approved without user confirmation.

                • type: Literal["always_allow"]

                  • "always_allow"

              • class BetaManagedAgentsAlwaysAskPolicy: …

                Tool calls require user confirmation before execution.

                • type: Literal["always_ask"]

                  • "always_ask"

          • default_config: BetaManagedAgentsMCPToolsetDefaultConfig

            Resolved default configuration for all tools from an MCP server.

            • enabled: bool

            • permission_policy: PermissionPolicy

              Permission policy for tool execution.

              • class BetaManagedAgentsAlwaysAllowPolicy: …

                Tool calls are automatically approved without user confirmation.

                • type: Literal["always_allow"]

                  • "always_allow"

              • class BetaManagedAgentsAlwaysAskPolicy: …

                Tool calls require user confirmation before execution.

                • type: Literal["always_ask"]

                  • "always_ask"

          • mcp_server_name: str

          • type: Literal["mcp_toolset"]

            • "mcp_toolset"

        • class BetaManagedAgentsCustomTool: …

          A custom tool as returned in API responses.

          • description: str

          • input_schema: BetaManagedAgentsCustomToolInputSchema

            JSON Schema for custom tool input parameters.

            • properties: Optional[Dict[str, object]]

              JSON Schema properties defining the tool’s input parameters.

            • required: Optional[List[str]]

              List of required property names.

            • type: Optional[Literal["object"]]

              Must be ‘object’ for tool input schemas.

              • "object"

          • name: str

          • type: Literal["custom"]

            • "custom"

      • type: Literal["agent"]

        • "agent"

      • version: int

    • archived_at: Optional[datetime]

      A timestamp in RFC 3339 format

    • created_at: datetime

      A timestamp in RFC 3339 format

    • parent_thread_id: Optional[str]

      Parent thread that spawned this thread. Null for the primary thread.

    • session_id: str

      The session this thread belongs to.

    • stats: Optional[BetaManagedAgentsSessionThreadStats]

      Timing statistics for a session thread.

      • active_seconds: Optional[float]

        Cumulative time in seconds the thread spent actively running. Excludes idle time.

      • duration_seconds: Optional[float]

        Elapsed time since thread creation in seconds. For archived threads, frozen at the final update.

      • startup_seconds: Optional[float]

        Time in seconds for the thread to begin running. Zero for child threads, which start immediately.

    • status: BetaManagedAgentsSessionThreadStatus

      SessionThreadStatus enum

      • "running"

      • "idle"

      • "rescheduling"

      • "terminated"

    • type: Literal["session_thread"]

      • "session_thread"

    • updated_at: datetime

      A timestamp in RFC 3339 format

    • usage: Optional[BetaManagedAgentsSessionThreadUsage]

      Cumulative token usage for a session thread across all turns.

      • cache_creation: Optional[BetaManagedAgentsCacheCreationUsage]

        Prompt-cache creation token usage broken down by cache lifetime.

        • ephemeral_1h_input_tokens: Optional[int]

          Tokens used to create 1-hour ephemeral cache entries.

        • ephemeral_5m_input_tokens: Optional[int]

          Tokens used to create 5-minute ephemeral cache entries.

      • cache_read_input_tokens: Optional[int]

        Total tokens read from prompt cache.

      • input_tokens: Optional[int]

        Total input tokens consumed across all turns.

      • output_tokens: Optional[int]

        Total output tokens generated across all turns.

Example

import os
from anthropic import Anthropic
 
client = Anthropic(
    api_key=os.environ.get("ANTHROPIC_API_KEY"),  # This is the default and can be omitted
)
beta_managed_agents_session_thread = client.beta.sessions.threads.archive(
    thread_id="sthr_011CZkZVWa6oIjw0rgXZpnBt",
    session_id="sesn_011CZkZAtmR3yMPDzynEDxu7",
)
print(beta_managed_agents_session_thread.id)

Liên kết

Xem thêm:

Sơ đồ

Liên kết ngược