Interface GetBrandIdentitySuccess

interface GetBrandIdentitySuccess {
    brand_id: string;
    house: { domain: string; name: string };
    names: { [k: string]: string | undefined }[];
    description?: string;
    industries?: string[];
    keller_type?: "master" | "sub_brand" | "endorsed" | "independent";
    logos?: {
        url: string;
        orientation?: "square" | "horizontal" | "vertical" | "stacked";
        background?: "dark-bg" | "light-bg" | "transparent-bg";
        variant?: "primary" | "secondary" | "icon" | "wordmark" | "full-lockup";
        tags?: string[];
        usage?: string;
        width?: number;
        height?: number;
    }[];
    colors?: {
        primary?: string
        | string[];
        secondary?: string | string[];
        accent?: string | string[];
        background?: string | string[];
        text?: string | string[];
    };
    fonts?: {
        primary?: | string
        | {
            family: string;
            files?: {
                url: string;
                weight?: number;
                weight_range?: number[];
                style?: "normal"
                | "italic"
                | "oblique";
            }[];
            opentype_features?: string[];
            fallbacks?: string[];
        };
        secondary?: | string
        | {
            family: string;
            files?: {
                url: string;
                weight?: number;
                weight_range?: number[];
                style?: "normal"
                | "italic"
                | "oblique";
            }[];
            opentype_features?: string[];
            fallbacks?: string[];
        };
        [k: string]: | string
        | {
            family: string;
            files?: {
                url: string;
                weight?: number;
                weight_range?: number[];
                style?: "normal"
                | "italic"
                | "oblique";
            }[];
            opentype_features?: string[];
            fallbacks?: string[];
        }
        | undefined;
    };
    visual_guidelines?: {};
    tone?: {
        voice?: string;
        attributes?: string[];
        dos?: string[];
        donts?: string[];
    };
    tagline?: string
    | { [k: string]: string | undefined }[];
    voice_synthesis?: { provider?: string; voice_id?: string; settings?: {} };
    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;
    }[];
    rights?: {
        available_uses?: RightUse[];
        countries?: string[];
        excluded_countries?: string[];
        exclusivity_model?: string;
        content_restrictions?: string[];
    };
    available_fields?: (
        | "description"
        | "industries"
        | "keller_type"
        | "logos"
        | "colors"
        | "fonts"
        | "visual_guidelines"
        | "tone"
        | "tagline"
        | "voice_synthesis"
        | "assets"
        | "rights"
    )[];
    context?: ContextObject;
    ext?: ExtensionObject;
}

Index

Properties

brand_id house names description? industries? keller_type? logos? colors? fonts? visual_guidelines? tone? tagline? voice_synthesis? assets? rights? available_fields? context? ext?

Properties

brand_id

brand_id: string

Brand identifier

house

house: { domain: string; name: string }

The house (corporate entity) this brand belongs to. Always returned regardless of authorization level.

Type Declaration

domain: string
House domain (e.g., nikeinc.com)
name: string
House display name

names

names: { [k: string]: string | undefined }[]

Localized brand names with BCP 47 locale code keys (e.g., 'en_US', 'fr_CA'). Bare language codes ('en') are accepted as wildcards for backwards compatibility.

`Optional`description

description?: string

Brand description

`Optional`industries

industries?: string[]

Brand industries.

`Optional`keller_type

keller_type?: "master" | "sub_brand" | "endorsed" | "independent"

Brand architecture type: master (primary brand of house), sub_brand (carries parent name), endorsed (independent identity backed by parent), independent (operates separately)

`Optional`logos

logos?: {
    url: string;
    orientation?: "square" | "horizontal" | "vertical" | "stacked";
    background?: "dark-bg" | "light-bg" | "transparent-bg";
    variant?: "primary" | "secondary" | "icon" | "wordmark" | "full-lockup";
    tags?: string[];
    usage?: string;
    width?: number;
    height?: number;
}[]

Brand logos. Public callers get standard logos; authorized callers also receive high-res variants. Shape matches brand.json logo definition.

Type Declaration

url: string
URL to the logo asset
Optionalorientation?: "square" | "horizontal" | "vertical" | "stacked"
Logo aspect ratio orientation
Optionalbackground?: "dark-bg" | "light-bg" | "transparent-bg"
Background compatibility
Optionalvariant?: "primary" | "secondary" | "icon" | "wordmark" | "full-lockup"
Logo variant type
Optionaltags?: string[]
Additional semantic tags
Optionalusage?: string
When to use this logo variant
Optionalwidth?: number
Width in pixels
Optionalheight?: number
Height in pixels

`Optional`colors

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

Brand color palette. Each role accepts a single hex color or an array of hex colors. Shape matches brand.json colors definition.

`Optional`fonts

fonts?: {
    primary?:
        | string
        | {
            family: string;
            files?: {
                url: string;
                weight?: number;
                weight_range?: number[];
                style?: "normal"
                | "italic"
                | "oblique";
            }[];
            opentype_features?: string[];
            fallbacks?: string[];
        };
    secondary?: | string
    | {
        family: string;
        files?: {
            url: string;
            weight?: number;
            weight_range?: number[];
            style?: "normal"
            | "italic"
            | "oblique";
        }[];
        opentype_features?: string[];
        fallbacks?: string[];
    };
    [k: string]: | string
    | {
        family: string;
        files?: {
            url: string;
            weight?: number;
            weight_range?: number[];
            style?: "normal"
            | "italic"
            | "oblique";
        }[];
        opentype_features?: string[];
        fallbacks?: string[];
    }
    | undefined;
}

Brand typography. Each key is a role name (e.g., 'primary', 'secondary') referenced by type_scale entries. Values are either a CSS font-family string or a structured object with family name and font files. Shape matches brand.json fonts definition.

Type Declaration

[k: string]:
    | string
    | {
        family: string;
        files?: {
            url: string;
            weight?: number;
            weight_range?: number[];
            style?: "normal"
            | "italic"
            | "oblique";
        }[];
        opentype_features?: string[];
        fallbacks?: string[];
    }
    | undefined
Type Declaration
- string
- {
      family: string;
      files?: {
          url: string;
          weight?: number;
          weight_range?: number[];
          style?: "normal" | "italic" | "oblique";
      }[];
      opentype_features?: string[];
      fallbacks?: string[];
  }
  - family: string
    CSS font-family name
  - Optionalfiles?: {
        url: string;
        weight?: number;
        weight_range?: number[];
        style?: "normal" | "italic" | "oblique";
    }[]
  - Optionalopentype_features?: string[]
    OpenType feature tags to enable (e.g., ['ss01', 'tnum'])
  - Optionalfallbacks?: string[]
    Ordered fallback font-family names for script coverage
- undefined
Optionalprimary?:
    | string
    | {
        family: string;
        files?: {
            url: string;
            weight?: number;
            weight_range?: number[];
            style?: "normal"
            | "italic"
            | "oblique";
        }[];
        opentype_features?: string[];
        fallbacks?: string[];
    }
Primary font family
Optionalsecondary?:
    | string
    | {
        family: string;
        files?: {
            url: string;
            weight?: number;
            weight_range?: number[];
            style?: "normal"
            | "italic"
            | "oblique";
        }[];
        opentype_features?: string[];
        fallbacks?: string[];
    }
Secondary font family

`Optional`visual_guidelines

visual_guidelines?: {}

Structured visual rules for generative creative systems (photography, graphic_style, colorways, type_scale, motion). Matches brand.json visual_guidelines definition. Authorized callers only.

`Optional`tone

tone?: {
    voice?: string;
    attributes?: string[];
    dos?: string[];
    donts?: string[];
}

Brand voice and messaging guidelines

Type Declaration

Optionalvoice?: string
Brand personality described as comma-separated adjectives (e.g., 'enthusiastic, warm, competitive')
Optionalattributes?: string[]
Personality traits that characterize the brand voice, used as prompt guidance
Optionaldos?: string[]
Approved messaging approaches, content themes, and reference points
Optionaldonts?: string[]
Prohibited topics, competitor references, and phrasings to avoid

`Optional`tagline

tagline?: string | { [k: string]: string | undefined }[]

Brand tagline or slogan. Accepts a plain string or a localized array matching the names pattern.

Type Declaration

string
{ [k: string]: string | undefined }[]
- [k: string]: string | undefined
  Min Length
  1

`Optional`voice_synthesis

voice_synthesis?: { provider?: string; voice_id?: string; settings?: {} }

Voice synthesis configuration for AI-generated audio

`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;
}[]

Available brand assets (images, audio, video). Authorized callers only. Shape matches brand.json asset definition.

Type Declaration

asset_id: string
Unique identifier
asset_type: AssetContentType
url: string
URL to CDN-hosted asset file
Optionaltags?: string[]
Tags for discovery
Optionalname?: string
Human-readable 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')

`Optional`rights

rights?: {
    available_uses?: RightUse[];
    countries?: string[];
    excluded_countries?: string[];
    exclusivity_model?: string;
    content_restrictions?: string[];
}

Rights availability summary. For detailed pricing, use get_rights.

Type Declaration

Optionalavailable_uses?: RightUse[]
Optionalcountries?: string[]
Countries where rights are available (ISO 3166-1 alpha-2). If omitted, rights are available worldwide.
Optionalexcluded_countries?: string[]
Countries excluded from availability (ISO 3166-1 alpha-2)
Optionalexclusivity_model?: string
Optionalcontent_restrictions?: string[]

`Optional`available_fields

Fields available but not returned in this response due to authorization level. Tells the caller what they would gain by linking their account via sync_accounts. Values match the request fields enum.

`Optional`context

context?: ContextObject

`Optional`ext

ext?: ExtensionObject

Interface GetBrandIdentitySuccess

Index

Properties

Properties

brand_id

house

Type Declaration

domain: string

name: string

names

Optionaldescription

Optionalindustries

Optionalkeller_type

Optionallogos

Type Declaration

url: string

Optionalorientation?: "square" | "horizontal" | "vertical" | "stacked"

Optionalbackground?: "dark-bg" | "light-bg" | "transparent-bg"

Optionalvariant?: "primary" | "secondary" | "icon" | "wordmark" | "full-lockup"

Optionaltags?: string[]

Optionalusage?: string

Optionalwidth?: number

Optionalheight?: number

Optionalcolors

Optionalfonts

Type Declaration

[k: string]: | string | { family: string; files?: { url: string; weight?: number; weight_range?: number[]; style?: "normal" | "italic" | "oblique"; }[]; opentype_features?: string[]; fallbacks?: string[]; } | undefined

Type Declaration

family: string

Optionalfiles?: { url: string; weight?: number; weight_range?: number[]; style?: "normal" | "italic" | "oblique";}[]

Optionalopentype_features?: string[]

Optionalfallbacks?: string[]

Optionalprimary?: | string | { family: string; files?: { url: string; weight?: number; weight_range?: number[]; style?: "normal" | "italic" | "oblique"; }[]; opentype_features?: string[]; fallbacks?: string[]; }

Optionalsecondary?: | string | { family: string; files?: { url: string; weight?: number; weight_range?: number[]; style?: "normal" | "italic" | "oblique"; }[]; opentype_features?: string[]; fallbacks?: string[]; }

Optionalvisual_guidelines

Optionaltone

Type Declaration

Optionalvoice?: string

Optionalattributes?: string[]

Optionaldos?: string[]

Optionaldonts?: string[]

Optionaltagline

Type Declaration

[k: string]: string | undefined

Min Length

Optionalvoice_synthesis

Optionalassets

Type Declaration

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

Optionalrights

Type Declaration

Optionalavailable_uses?: RightUse[]

Optionalcountries?: string[]

Optionalexcluded_countries?: string[]

Optionalexclusivity_model?: string

Optionalcontent_restrictions?: string[]

Optionalavailable_fields

Optionalcontext

Optionalext

Settings

On This Page

`Optional`description

`Optional`industries

`Optional`keller_type

`Optional`logos

`Optional`orientation?: "square" | "horizontal" | "vertical" | "stacked"

`Optional`background?: "dark-bg" | "light-bg" | "transparent-bg"

`Optional`variant?: "primary" | "secondary" | "icon" | "wordmark" | "full-lockup"

`Optional`tags?: string[]

`Optional`usage?: string

`Optional`width?: number

`Optional`height?: number

`Optional`colors

`Optional`fonts

[k: string]:
| string
| {
family: string;
files?: {
url: string;
weight?: number;
weight_range?: number[];
style?: "normal"
| "italic"
| "oblique";
}[];
opentype_features?: string[];
fallbacks?: string[];
}
| undefined

`Optional`files?: {
url: string;
weight?: number;
weight_range?: number[];
style?: "normal" | "italic" | "oblique";
}[]

`Optional`opentype_features?: string[]

`Optional`fallbacks?: string[]

`Optional`primary?:
| string
| {
family: string;
files?: {
url: string;
weight?: number;
weight_range?: number[];
style?: "normal"
| "italic"
| "oblique";
}[];
opentype_features?: string[];
fallbacks?: string[];
}

`Optional`secondary?:
| string
| {
family: string;
files?: {
url: string;
weight?: number;
weight_range?: number[];
style?: "normal"
| "italic"
| "oblique";
}[];
opentype_features?: string[];
fallbacks?: string[];
}

`Optional`visual_guidelines

`Optional`tone

`Optional`voice?: string

`Optional`attributes?: string[]

`Optional`dos?: string[]

`Optional`donts?: string[]

`Optional`tagline

`Optional`voice_synthesis

`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`rights

`Optional`available_uses?: RightUse[]

`Optional`countries?: string[]

`Optional`excluded_countries?: string[]

`Optional`exclusivity_model?: string

`Optional`content_restrictions?: string[]

`Optional`available_fields

`Optional`context

`Optional`ext