@adcp/client API Reference - v3.11.2
    Preparing search index...

    Interface SICapabilities

    What capabilities the host supports

    interface SICapabilities {
        modalities?: {
            conversational?: boolean;
            voice?:
                | boolean
                | { provider?: string; voice_id?: string; [k: string]: unknown };
            video?:
                | boolean
                | {
                    formats?: string[];
                    max_duration_seconds?: number;
                    [k: string]: unknown;
                };
            avatar?: | boolean
            | { provider?: string; avatar_id?: string; [k: string]: unknown };
            [k: string]: unknown;
        };
        components?: {
            standard?: (
                | "image"
                | "text"
                | "link"
                | "product_card"
                | "carousel"
                | "action_button"
            )[];
            extensions?: { [k: string]: unknown };
            [k: string]: unknown;
        };
        commerce?: { acp_checkout?: boolean; [k: string]: unknown };
        a2ui?: { supported?: boolean; catalogs?: string[]; [k: string]: unknown };
        mcp_apps?: boolean;
        [k: string]: unknown;
    }

    Indexable

    • [k: string]: unknown
    Index

    Properties

    modalities? components? commerce? a2ui? mcp_apps?

    Properties

    modalities?: {
        conversational?: boolean;
        voice?:
            | boolean
            | { provider?: string; voice_id?: string; [k: string]: unknown };
        video?:
            | boolean
            | {
                formats?: string[];
                max_duration_seconds?: number;
                [k: string]: unknown;
            };
        avatar?: | boolean
        | { provider?: string; avatar_id?: string; [k: string]: unknown };
        [k: string]: unknown;
    }

    Interaction modalities supported

    Type Declaration

    • [k: string]: unknown
    • Optionalconversational?: boolean

      Pure text exchange - the baseline modality

    • Optionalvoice?: boolean | { provider?: string; voice_id?: string; [k: string]: unknown }

      Audio-based interaction using brand voice

    • Optionalvideo?:
          | boolean
          | {
              formats?: string[];
              max_duration_seconds?: number;
              [k: string]: unknown;
          }

      Brand video content playback

    • Optionalavatar?: boolean | { provider?: string; avatar_id?: string; [k: string]: unknown }

      Animated video presence with brand avatar

    components?: {
        standard?: (
            | "image"
            | "text"
            | "link"
            | "product_card"
            | "carousel"
            | "action_button"
        )[];
        extensions?: { [k: string]: unknown };
        [k: string]: unknown;
    }

    Visual components supported

    Type Declaration

    • [k: string]: unknown
    • Optionalstandard?: ("image" | "text" | "link" | "product_card" | "carousel" | "action_button")[]

      Standard components that all SI hosts must render

    • Optionalextensions?: { [k: string]: unknown }

      Platform-specific extensions (chatgpt_apps_sdk, maps, forms, etc.)

    commerce?: { acp_checkout?: boolean; [k: string]: unknown }

    Commerce capabilities

    Type Declaration

    • [k: string]: unknown
    • Optionalacp_checkout?: boolean

      Supports ACP (Agentic Commerce Protocol) checkout handoff

    a2ui?: { supported?: boolean; catalogs?: string[]; [k: string]: unknown }

    A2UI (Agent-to-UI) capabilities

    Type Declaration

    • [k: string]: unknown
    • Optionalsupported?: boolean

      Supports A2UI surface rendering

    • Optionalcatalogs?: string[]

      Supported A2UI component catalogs (e.g., 'si-standard', 'standard')

    mcp_apps?: boolean

    Supports MCP Apps for rendering A2UI surfaces in iframes

    Settings

    Member Visibility

    On This Page

    Properties