ACP v2 TypeScript SDK — UNSTABLE DRAFT - v2.0.0
    Preparing search index...

    Type Alias ResumeSessionRequest

    Request parameters for resuming an existing session.

    Resumes an existing session and optionally replays retained conversation history according to replayFrom.

    type ResumeSessionRequest = {
        sessionId: SessionId;
        cwd: AbsolutePath;
        additionalDirectories?: AbsolutePath[];
        mcpServers?: McpServer[];
        replayFrom?: ReplayFrom | null;
        systemPrompt?: SystemPrompt | null;
        _meta?: { [key: string]: unknown } | null;
    }
    Index
    sessionId cwd additionalDirectories? mcpServers? replayFrom? systemPrompt? _meta?
    sessionId: SessionId

    The ID of the session to resume.

    cwd: AbsolutePath

    The working directory for this session. Must be an absolute path.

    additionalDirectories?: AbsolutePath[]

    Additional workspace roots to activate for this session. Each path must be absolute.

    When omitted or empty, no additional roots are activated. When non-empty, this is the complete resulting additional-root list for the resumed session. It may differ from any previously used or reported list as long as the request cwd matches the session's cwd.

    mcpServers?: McpServer[]

    List of MCP servers to connect to for this session.

    replayFrom?: ReplayFrom | null

    Inclusive cursor describing where conversation replay should begin.

    Optional. Omitted or null both mean the Agent should resume without replaying previous conversation history. Replay cursors are inclusive: replay includes the position identified by the cursor. Supplying { "type": "start" } means the Agent should replay all retained conversation history before responding.

    Agents MUST reject unsupported cursor types or malformed cursor values with -32602 (Invalid params), rather than substituting another cursor or resuming without replay.

    systemPrompt?: SystemPrompt | null

    UNSTABLE

    This capability is not part of the spec yet, and may be removed or changed at any point.

    System-level instructions for the resumed session.

    Optional. Omitted and null are equivalent; the Agent may then keep a system prompt it stored with the session or use its default instructions. Clients MUST only send this when the Agent advertises session.systemPrompt, and SHOULD send the same value they used when the session was created.

    Optional_meta

    _meta?: { [key: string]: unknown } | null

    The _meta property is reserved by ACP to allow clients and agents to attach additional metadata to their interactions. Implementations MUST NOT make assumptions about values at these keys.

    See protocol docs: Extensibility

    Settings
    Member Visibility

    On This Page
    Properties