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

    Type Alias CloseSessionRequestExperimental

    Request parameters for closing an active session.

    The agent must cancel any ongoing work related to the session (treat it as if session/cancel was called) and then free up any resources associated with the session.

    When closing cancels active foreground work, the Agent MUST send the final updates for that work and the idle state_update with stopReason: "cancelled" before responding successfully to session/close. Closing an idle session does not itself require another idle update.

    Closing may also cancel pending session/prompt requests, including queued prompts. If closing prevents a prompt's user message from being inserted, the Agent MUST answer that request with -32800 (Request Cancelled). If the message has already been inserted, the Agent MUST respond successfully with its messageId. Prompt responses need not precede the close response.

    type CloseSessionRequest = {
        sessionId: SessionId;
        _meta?: { [key: string]: unknown } | null;
    }
    Index
    sessionId _meta?
    sessionId: SessionId

    The ID of the session to close.

    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