@adcp/sdk API Reference - v10.0.1
    Preparing search index...

    Interface SIInitiateSessionRequest

    Host initiates a session with a brand agent

    interface SIInitiateSessionRequest {
        adcp_version?: string;
        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;
        sponsored_context_receipt?: SISponsoredContextReceipt;
        idempotency_key: string;
        ext?: ExtensionObject;
    }
    Index

    Properties

    adcp_version? adcp_major_version? intent context? identity media_buy_id? placement? offering_id? supported_capabilities? offering_token? sponsored_context_receipt? idempotency_key ext?

    Properties

    adcp_version?: string

    Release-precision AdCP version (VERSION.RELEASE, e.g. "3.0", "3.1", "3.1-beta"). On a request: the buyer's release pin — the seller validates against its supported_versions and returns VERSION_UNSUPPORTED on cross-major mismatch, or downshifts to the highest supported release within the same major. On a response: the release the seller actually served — clients SHOULD validate the response against that release's schema, not against their pin. Patches are not negotiated; surface them as build_version on capabilities for operational visibility. When omitted, falls back to adcp_major_version (deprecated) or server default. Buyers SHOULD emit both adcp_version and adcp_major_version through 3.x to remain compatible with sellers that only read the legacy field. NORMALIZATION: SDKs that read full-semver values from bundle metadata (e.g. ComplianceIndex.published_version = "3.1.0-beta.1") MUST normalize to release-precision ("3.1-beta.1") before emitting on the wire — meta-field values are NOT valid wire values.

    adcp_major_version?: number

    DEPRECATED in favor of adcp_version (release-precision string). Servers MUST continue to honor this field through 3.x. Removed in 4.0. Original semantics: 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.

    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'.

    sponsored_context_receipt?: SISponsoredContextReceipt
    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

    Settings

    Member Visibility

    On This Page

    Properties