Agent Client Protocol - v0.18.2
    Preparing search index...

    Type Alias ListSessionsRequest

    Request parameters for listing existing sessions.

    Only available if the Agent supports the sessionCapabilities.list capability.

    type ListSessionsRequest = {
        _meta?: { [key: string]: unknown } | null;
        additionalDirectories?: string[];
        cursor?: string | null;
        cwd?: string | null;
    }
    Index

    Properties

    _meta? additionalDirectories? cursor? cwd?

    Properties

    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

    additionalDirectories?: string[]

    UNSTABLE

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

    Filter sessions by the exact ordered additional workspace roots. Each path must be absolute.

    This filter applies only when the field is present and non-empty. When omitted or empty, no additional-root filter is applied.

    cursor?: string | null

    Opaque cursor token from a previous response's nextCursor field for cursor-based pagination

    cwd?: string | null

    Filter sessions by working directory. Must be an absolute path.

    Settings

    Member Visibility

    On This Page

    Properties