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

    Type Alias SISendMessageRequest

    SISendMessageRequest: { [k: string]: unknown } & {
        adcp_major_version?: number;
        idempotency_key: string;
        session_id: string;
        message?: string;
        action_response?: { action?: string; payload?: {} };
        context?: ContextObject;
        ext?: ExtensionObject;
    }

    Send a message to the brand agent within an active session

    Type Declaration

    • [k: string]: unknown
    • Optionaladcp_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

    • idempotency_key: string

      Client-generated unique key for at-most-once execution. Each conversational turn is a distinct mutation of session transcript — without this key, a timeout-and-retry produces a duplicate turn and a duplicate model response. MUST be unique per (seller, request) pair. Use a fresh UUID v4 for each user turn.

      16

      255

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

    • session_id: string

      Active session identifier

    • Optionalmessage?: string

      User's message to the brand agent

    • Optionalaction_response?: { action?: string; payload?: {} }

      Response to a previous action_button (e.g., user clicked checkout)

      • Optionalaction?: string

        The action that was triggered

      • Optionalpayload?: {}

        Action-specific response data

    • Optionalcontext?: ContextObject
    • Optionalext?: ExtensionObject