@adcp/sdk API Reference - v7.9.0
    Preparing search index...

    Interface SIInitiateSessionRequest

    Host initiates a session with a brand agent

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

    Properties

    adcp_major_version?: number

    The AdCP major version the buyer's payloads conform to. Sellers validate against their supported major_versions and return VERSION_UNSUPPORTED if unsupported. When omitted, the seller assumes its highest supported version.

    1

    99

    intent: string

    Natural language description of user intent — the conversation handoff from the host describing what the user needs from the brand agent

    context?: ContextObject
    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.

    16

    255

    ^[A-Za-z0-9_.:-]{16,255}$

    ext?: ExtensionObject