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

    Type Alias NewSessionResponse

    Response from creating a new session.

    New sessions default to idle until a state update reports otherwise. Updates may arrive before or after this response. Clients MUST NOT overwrite an already-reported state when the response arrives.

    See protocol docs: Creating a Session

    type NewSessionResponse = {
        sessionId: SessionId;
        configOptions?: SessionConfigOption[];
        availableCommands?: AvailableCommand[];
        _meta?: { [key: string]: unknown } | null;
    }
    Index
    sessionId configOptions? availableCommands? _meta?
    sessionId: SessionId

    Unique identifier for the created session.

    Used in all subsequent requests for this conversation.

    configOptions?: SessionConfigOption[]

    Initial session configuration options.

    availableCommands?: AvailableCommand[]

    Initial commands the agent can execute in this session.

    Optional. Omitted or empty means no initial commands are advertised. Senders MUST use an array, not null; receivers treat null like omission. Later available_commands_update notifications replace this list.

    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