POST
TypeScript client

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

idempotency-key
string
required

a string at most 200 character(s) long

Required string length: 1 - 200

Path Parameters

teamId
string
required

Team (workspace) id (UUID). Discover ids via the list teams endpoint or the agent context.

Body

application/json
prompt
string
required

a string at most 12000 character(s) long

Required string length: 1 - 12000
aspectRatio
enum<string>
required

Output proportions for the generated image and optional caption overlay.

Available options:
9:16,
16:9,
1:1,
4:5
styleTags
string[]

an array of at most 20 item(s)

Maximum array length: 20

a string at most 2000 character(s) long

Required string length: 1 - 2000
imageModelId
string

a string at most 200 character(s) long

Required string length: 1 - 200
quality
enum<string>

Image generation quality preference. Omit to use the normal quality setting.

Available options:
standard,
detailed
caption
string

a string at most 2000 character(s) long

Maximum string length: 2000
captions
maxItems(20) · object[]

an array of at most 20 item(s)

Maximum array length: 20

Response

Success

id
string<uuid>
required

a Universally Unique Identifier

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
contentItemId
string<uuid>
required

a Universally Unique Identifier

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
kind
enum<string>
required
Available options:
generation,
slide_regeneration,
edit
status
string
required
targetSlideId
string<uuid> | null
required

a Universally Unique Identifier

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
regenerationScope
enum<string> | null
required
Available options:
text,
image,
layout,
style,
all
baseRevision
integer
required

an integer

resultRevision
integer | null
required

an integer

workflowId
string
required
renderJobId
string<uuid> | null
required

a Universally Unique Identifier

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
outputAssetId
string<uuid> | null
required

a Universally Unique Identifier

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
errorCode
string | null
required
diagnostics
string | null
required
pauseReason
string | null
required
maxSpendDecimillicents
number | null
required
spentDecimillicents
number
required
activeDurationMs
number
required