Interface SignageAIGenerateRequest

Body of a request to generate an image from a brief

interface SignageAIGenerateRequest {
    add_text_with_layer?: boolean;
    aspect_ratio?: string;
    candidates?: number;
    group_id?: string;
    idempotency_key?: string;
    include_logo?: boolean;
    model?: string;
    prompt: string;
    provider_id?: string;
    quality?: string;
    references?: string[];
    use_branding?: boolean;
    words?: string;
}

Hierarchy (View Summary)

Properties

add_text_with_layer? aspect_ratio? candidates? group_id? idempotency_key? include_logo? model? prompt provider_id? quality? references? use_branding? words?

Properties

Optionaladd_text_with_layer

add_text_with_layer?: boolean

Keep wording out of the image so it can be laid over. Defaults to true

Optionalaspect_ratio

aspect_ratio?: string

Shape of the image. Defaults to 16:9

Optionalcandidates

candidates?: number

Number of candidates to produce. Clamped to the platform maximum

Optionalgroup_id

group_id?: string

Signage group the caller is acting in. Required unless the caller is support

Optionalidempotency_key

idempotency_key?: string

Repeating a key returns the job it first created rather than spending again

Optionalinclude_logo

include_logo?: boolean

Composite the domain logo over the result. Defaults to true

Optionalmodel

model?: string

Model to use. Defaults to the provider's default model

prompt

prompt: string

What the image should show. Required

Optionalprovider_id

provider_id?: string

Provider to use. Defaults to the domain's default provider

Optionalquality

quality?: string

Quality level to ask the vendor for. Defaults to standard

Optionalreferences

references?: string[]

IDs of uploads to hand the vendor as visual references

Optionaluse_branding

use_branding?: boolean

Apply the organisation's colours, face and tone. Defaults to true

Optionalwords

words?: string

Wording the image is being made for, used to leave room for it

Settings

Member Visibility

On This Page

Properties