Interface SignageAIJob

An image generation or edit job

interface SignageAIJob {
    candidates: number;
    cost_units?: number;
    created_at?: number;
    error_kind?: string;
    error_message?: string;
    finished_at?: number;
    id: string;
    images: (null | SignageAIImage)[];
    images_produced: number;
    kind: SignageAIJobKind;
    latency_ms?: number;
    model?: string;
    parent_job_id?: string;
    prompt?: string;
    provider?: SignageAIProviderType;
    state: SignageAIJobState;
    version: number;
}

Properties

candidates cost_units? created_at? error_kind? error_message? finished_at? id images images_produced kind latency_ms? model? parent_job_id? prompt? provider? state version

Properties

candidates

candidates: number

Number of candidates asked for

Optionalcost_units

cost_units?: number

Vendor spend attributed to the job

Optionalcreated_at

created_at?: number

Unix epoch in seconds at which the job was accepted

Optionalerror_kind

error_kind?: string

Class of failure, when the job failed

Optionalerror_message

error_message?: string

Description of the failure, when the job failed

Optionalfinished_at

finished_at?: number

Unix epoch in seconds at which the job stopped

id

id: string

ID of the job

images

images: (null | SignageAIImage)[]

Candidate slots in order, null until that candidate lands

images_produced

images_produced: number

Number of candidates that have landed so far

kind

kind: SignageAIJobKind

Whether the job generates or edits

Optionallatency_ms

latency_ms?: number

Time the job took, in milliseconds

Optionalmodel

model?: string

Model the job was sent to

Optionalparent_job_id

parent_job_id?: string

ID of the job this one refines, when it is a refine

Optionalprompt

prompt?: string

Brief the user asked for

Optionalprovider

provider?: SignageAIProviderType

Vendor the job was sent to

state

state: SignageAIJobState

Lifecycle state of the job

version

version: number

Bumped on every change to the job. Pass it back as since when long polling so the request only returns once something new has landed

Settings

Member Visibility

On This Page

Properties