@adcp/client API Reference - v4.19.0
    Preparing search index...

    Interface SIInitiateSessionRequest

    Host initiates a session with a brand agent

    interface SIInitiateSessionRequest {
        context: string;
        identity: SIIdentity;
        media_buy_id?: string;
        placement?: string;
        offering_id?: string;
        supported_capabilities?: SICapabilities;
        offering_token?: string;
        idempotency_key?: string;
        ext?: ExtensionObject;
    }
    Index

    Properties

    context identity media_buy_id? placement? offering_id? supported_capabilities? offering_token? idempotency_key? ext?

    Properties

    context: string

    Conversation handoff from the host describing what the user needs

    identity: SIIdentity
    media_buy_id?: string

    AdCP media buy ID if session was triggered by advertising

    placement?: string

    Where this session was triggered (e.g., 'chatgpt_search', 'claude_chat')

    offering_id?: string

    Brand-specific offering identifier to apply

    supported_capabilities?: SICapabilities
    offering_token?: string

    Token from si_get_offering response for session continuity. Brand uses this to recall what products were shown to the user, enabling natural references like 'the second one' or 'that blue shoe'.

    idempotency_key?: string

    Client-generated unique key for this request. Prevents duplicate session creation on retries. MUST be unique per (seller, request) pair to prevent cross-seller correlation. Use a fresh UUID v4 for each request.

    ext?: ExtensionObject

    Settings

    Member Visibility

    On This Page

    Properties