Interface SignageAIEditRequest

Body of a request to edit an existing image, or refine an earlier job

interface SignageAIEditRequest {
    add_text_with_layer?: boolean;
    aspect_ratio?: string;
    candidates?: number;
    group_id?: string;
    idempotency_key?: string;
    include_logo?: boolean;
    model?: string;
    parent_job_id?: string;
    prompt: string;
    provider_id?: string;
    quality?: string;
    references?: string[];
    source_item_id?: string;
    source_upload_id: string;
    words?: string;
}

Hierarchy (View Summary)

Properties

add_text_with_layer? aspect_ratio? candidates? group_id? idempotency_key? include_logo? model? parent_job_id? prompt provider_id? quality? references? source_item_id? source_upload_id 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

Optionalparent_job_id

parent_job_id?: string

ID of the job being refined, so its brief carries into the new prompt

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

Optionalsource_item_id

source_item_id?: string

Media item proving the caller may read a source they do not own

source_upload_id

source_upload_id: string

ID of the upload to edit. Required

Optionalwords

words?: string

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

Settings

Member Visibility

On This Page

Properties