Interface BrandManifest

Inline brand manifest object

interface BrandManifest {
    url?: string;
    privacy_policy_url?: string;
    name: string;
    logos?: { url: string; tags?: string[]; width?: number; height?: number }[];
    colors?: {
        primary?: string;
        secondary?: string;
        accent?: string;
        background?: string;
        text?: string;
    };
    fonts?: { primary?: string; secondary?: string; font_urls?: string[] };
    tone?: string;
    voice?: {
        provider?: string;
        voice_id?: string;
        settings?: { [k: string]: unknown };
    };
    avatar?: {
        provider?: string;
        avatar_id?: string;
        settings?: { [k: string]: unknown };
    };
    tagline?: string;
    assets?: {
        asset_id: string;
        asset_type: AssetContentType;
        url: string;
        tags?: string[];
        name?: string;
        description?: string;
        width?: number;
        height?: number;
        duration_seconds?: number;
        file_size_bytes?: number;
        format?: string;
        metadata?: { [k: string]: unknown };
        [k: string]: unknown;
    }[];
    product_catalog?: {
        feed_url: string;
        feed_format?: | "custom"
        | "google_merchant_center"
        | "facebook_catalog"
        | "openai_product_feed";
        categories?: string[];
        last_updated?: string;
        update_frequency?: "realtime"
        | "hourly"
        | "daily"
        | "weekly";
        agentic_checkout?: {
            endpoint: string;
            spec: "openai_agentic_checkout_v1";
            supported_payment_providers?: string[];
        };
        [k: string]: unknown;
    };
    disclaimers?: { text: string; context?: string; required?: boolean }[];
    industry?: string;
    target_audience?: string;
    contact?: { email?: string; phone?: string };
    metadata?: {
        created_date?: string;
        updated_date?: string;
        version?: string;
    };
    [k: string]: unknown;
}

Indexable

[k: string]: unknown

Index

Properties

url? privacy_policy_url? name logos? colors? fonts? tone? voice? avatar? tagline? assets? product_catalog? disclaimers? industry? target_audience? contact? metadata?

Properties

`Optional`url

url?: string

Primary brand URL for context and asset discovery. Creative agents can infer brand information from this URL.

`Optional`privacy_policy_url

privacy_policy_url?: string

URL to the brand's privacy policy. Used for consumer consent flows when personal data may be shared with the advertiser. AI platforms can use this to present explicit privacy choices to users before data handoff.

name

name: string

Brand or business name

`Optional`logos

logos?: { url: string; tags?: string[]; width?: number; height?: number }[]

Brand logo assets with semantic tags for different use cases

Type Declaration

url: string
URL to the logo asset
Optionaltags?: string[]
Semantic tags describing the logo variant (e.g., 'dark', 'light', 'square', 'horizontal', 'icon')
Optionalwidth?: number
Logo width in pixels
Optionalheight?: number
Logo height in pixels

`Optional`colors

colors?: {
    primary?: string;
    secondary?: string;
    accent?: string;
    background?: string;
    text?: string;
}

Brand color palette

Type Declaration

Optionalprimary?: string
Primary brand color (hex format)
Optionalsecondary?: string
Secondary brand color (hex format)
Optionalaccent?: string
Accent color (hex format)
Optionalbackground?: string
Background color (hex format)
Optionaltext?: string
Text color (hex format)

`Optional`fonts

fonts?: { primary?: string; secondary?: string; font_urls?: string[] }

Brand typography guidelines

Type Declaration

Optionalprimary?: string
Primary font family name
Optionalsecondary?: string
Secondary font family name
Optionalfont_urls?: string[]
URLs to web font files if using custom fonts

`Optional`tone

tone?: string

Brand voice and messaging tone (e.g., 'professional', 'casual', 'humorous', 'trustworthy', 'innovative')

`Optional`voice

voice?: {
    provider?: string;
    voice_id?: string;
    settings?: { [k: string]: unknown };
}

Brand voice configuration for audio/conversational experiences

Type Declaration

Optionalprovider?: string
TTS provider (e.g., 'elevenlabs', 'openai', 'amazon_polly')
Optionalvoice_id?: string
Provider-specific voice identifier
Optionalsettings?: { [k: string]: unknown }
Provider-specific voice settings (speed, pitch, etc.)

`Optional`avatar

avatar?: {
    provider?: string;
    avatar_id?: string;
    settings?: { [k: string]: unknown };
}

Brand avatar configuration for visual conversational experiences

Type Declaration

Optionalprovider?: string
Avatar provider (e.g., 'd-id', 'heygen', 'synthesia')
Optionalavatar_id?: string
Provider-specific avatar identifier
Optionalsettings?: { [k: string]: unknown }
Provider-specific avatar settings

`Optional`tagline

tagline?: string

Brand tagline or slogan

`Optional`assets

assets?: {
    asset_id: string;
    asset_type: AssetContentType;
    url: string;
    tags?: string[];
    name?: string;
    description?: string;
    width?: number;
    height?: number;
    duration_seconds?: number;
    file_size_bytes?: number;
    format?: string;
    metadata?: { [k: string]: unknown };
    [k: string]: unknown;
}[]

Brand asset library with explicit assets and tags. Assets are referenced inline with URLs pointing to CDN-hosted files.

Type Declaration

[k: string]: unknown
asset_id: string
Unique identifier for this asset
asset_type: AssetContentType
url: string
URL to CDN-hosted asset file
Optionaltags?: string[]
Tags for asset discovery (e.g., 'holiday', 'lifestyle', 'product_shot')
Optionalname?: string
Human-readable asset name
Optionaldescription?: string
Asset description or usage notes
Optionalwidth?: number
Image/video width in pixels
Optionalheight?: number
Image/video height in pixels
Optionalduration_seconds?: number
Video/audio duration in seconds
Optionalfile_size_bytes?: number
File size in bytes
Optionalformat?: string
File format (e.g., 'jpg', 'mp4', 'mp3')
Optionalmetadata?: { [k: string]: unknown }
Additional asset-specific metadata

`Optional`product_catalog

product_catalog?: {
    feed_url: string;
    feed_format?:
        | "custom"
        | "google_merchant_center"
        | "facebook_catalog"
        | "openai_product_feed";
    categories?: string[];
    last_updated?: string;
    update_frequency?: "realtime"
    | "hourly"
    | "daily"
    | "weekly";
    agentic_checkout?: {
        endpoint: string;
        spec: "openai_agentic_checkout_v1";
        supported_payment_providers?: string[];
    };
    [k: string]: unknown;
}

Product catalog information for e-commerce advertisers. Enables SKU-level creative generation and product selection.

Type Declaration

[k: string]: unknown
feed_url: string
URL to product catalog feed
Optionalfeed_format?: "custom" | "google_merchant_center" | "facebook_catalog" | "openai_product_feed"
Format of the product feed. Use 'openai_product_feed' for feeds conforming to the OpenAI Commerce Product Feed specification.
Optionalcategories?: string[]
Product categories available in the catalog (for filtering)
Optionallast_updated?: string
When the product catalog was last updated
Optionalupdate_frequency?: "realtime" | "hourly" | "daily" | "weekly"
How frequently the product catalog is updated
Optionalagentic_checkout?: {
    endpoint: string;
    spec: "openai_agentic_checkout_v1";
    supported_payment_providers?: string[];
}
Agentic checkout endpoint configuration. Enables AI agents to complete purchases on behalf of users through a structured checkout API.
- endpoint: string
  Base URL for checkout session API (e.g., https://merchant.com/api/checkout_sessions)
- spec: "openai_agentic_checkout_v1"
  Checkout API specification implemented by the endpoint
- Optionalsupported_payment_providers?: string[]
  Payment providers supported by this checkout endpoint

`Optional`disclaimers

disclaimers?: { text: string; context?: string; required?: boolean }[]

Legal disclaimers or required text that must appear in creatives

Type Declaration

text: string
Disclaimer text
Optionalcontext?: string
When this disclaimer applies (e.g., 'financial_products', 'health_claims', 'all')
Optionalrequired?: boolean
Whether this disclaimer must appear

`Optional`industry

industry?: string

Industry or vertical (e.g., 'retail', 'automotive', 'finance', 'healthcare')

`Optional`target_audience

target_audience?: string

Primary target audience description

`Optional`contact

contact?: { email?: string; phone?: string }

Brand contact information

Type Declaration

Optionalemail?: string
Contact email
Optionalphone?: string
Contact phone number

`Optional`metadata

metadata?: { created_date?: string; updated_date?: string; version?: string }

Additional brand metadata

Type Declaration

Optionalcreated_date?: string
When this brand manifest was created
Optionalupdated_date?: string
When this brand manifest was last updated
Optionalversion?: string
Brand card version number

Interface BrandManifest

Indexable

Index

Properties

Properties

Optionalurl

Optionalprivacy_policy_url

name

Optionallogos

Type Declaration

url: string

Optionaltags?: string[]

Optionalwidth?: number

Optionalheight?: number

Optionalcolors

Type Declaration

Optionalprimary?: string

Optionalsecondary?: string

Optionalaccent?: string

Optionalbackground?: string

Optionaltext?: string

Optionalfonts

Type Declaration

Optionalprimary?: string

Optionalsecondary?: string

Optionalfont_urls?: string[]

Optionaltone

Optionalvoice

Type Declaration

Optionalprovider?: string

Optionalvoice_id?: string

Optionalsettings?: { [k: string]: unknown }

Optionalavatar

Type Declaration

Optionalprovider?: string

Optionalavatar_id?: string

Optionalsettings?: { [k: string]: unknown }

Optionaltagline

Optionalassets

Type Declaration

[k: string]: unknown

asset_id: string

asset_type: AssetContentType

url: string

Optionaltags?: string[]

Optionalname?: string

Optionaldescription?: string

Optionalwidth?: number

Optionalheight?: number

Optionalduration_seconds?: number

Optionalfile_size_bytes?: number

Optionalformat?: string

Optionalmetadata?: { [k: string]: unknown }

Optionalproduct_catalog

Type Declaration

[k: string]: unknown

feed_url: string

Optionalfeed_format?: "custom" | "google_merchant_center" | "facebook_catalog" | "openai_product_feed"

Optionalcategories?: string[]

Optionallast_updated?: string

Optionalupdate_frequency?: "realtime" | "hourly" | "daily" | "weekly"

Optionalagentic_checkout?: { endpoint: string; spec: "openai_agentic_checkout_v1"; supported_payment_providers?: string[];}

endpoint: string

spec: "openai_agentic_checkout_v1"

Optionalsupported_payment_providers?: string[]

Optionaldisclaimers

Type Declaration

text: string

Optionalcontext?: string

Optionalrequired?: boolean

Optionalindustry

Optionaltarget_audience

Optionalcontact

Type Declaration

Optionalemail?: string

Optionalphone?: string

Optionalmetadata

Type Declaration

Optionalcreated_date?: string

Optionalupdated_date?: string

`Optional`url

`Optional`privacy_policy_url

`Optional`logos

`Optional`tags?: string[]

`Optional`width?: number

`Optional`height?: number

`Optional`colors

`Optional`primary?: string

`Optional`secondary?: string

`Optional`accent?: string

`Optional`background?: string

`Optional`text?: string

`Optional`fonts

`Optional`primary?: string

`Optional`secondary?: string

`Optional`font_urls?: string[]

`Optional`tone

`Optional`voice

`Optional`provider?: string

`Optional`voice_id?: string

`Optional`settings?: { [k: string]: unknown }

`Optional`avatar

`Optional`provider?: string

`Optional`avatar_id?: string

`Optional`settings?: { [k: string]: unknown }

`Optional`tagline

`Optional`assets

`Optional`tags?: string[]

`Optional`name?: string

`Optional`description?: string

`Optional`width?: number

`Optional`height?: number

`Optional`duration_seconds?: number

`Optional`file_size_bytes?: number

`Optional`format?: string

`Optional`metadata?: { [k: string]: unknown }

`Optional`product_catalog

`Optional`feed_format?: "custom" | "google_merchant_center" | "facebook_catalog" | "openai_product_feed"

`Optional`categories?: string[]

`Optional`last_updated?: string

`Optional`update_frequency?: "realtime" | "hourly" | "daily" | "weekly"

`Optional`agentic_checkout?: {
endpoint: string;
spec: "openai_agentic_checkout_v1";
supported_payment_providers?: string[];
}

`Optional`supported_payment_providers?: string[]

`Optional`disclaimers

`Optional`context?: string

`Optional`required?: boolean

`Optional`industry

`Optional`target_audience

`Optional`contact

`Optional`email?: string

`Optional`phone?: string

`Optional`metadata

`Optional`created_date?: string

`Optional`updated_date?: string

`Optional`version?: string