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

    Type Alias NewSessionResponse

    Response from creating a new session.

    See protocol docs: Creating a Session

    type NewSessionResponse = {
        _meta?: { [key: string]: unknown } | null;
        configOptions?: SessionConfigOption[] | null;
        models?: SessionModelState | null;
        modes?: SessionModeState | null;
        sessionId: SessionId;
    }
    Index

    Properties

    _meta? configOptions? models? modes? sessionId

    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

    configOptions?: SessionConfigOption[] | null

    UNSTABLE

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

    Initial session configuration options if supported by the Agent.

    models?: SessionModelState | null

    UNSTABLE

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

    Initial model state if supported by the Agent

    modes?: SessionModeState | null

    Initial mode state if supported by the Agent

    See protocol docs: Session Modes

    sessionId: SessionId

    Unique identifier for the created session.

    Used in all subsequent requests for this conversation.

    Settings

    Member Visibility

    On This Page

    Properties