Skip to main content
POST
Error

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
projectId
string<uuid>
required
​
assetKind
enum<string>
required
Available options:
CAMPAIGN_MEDIA
​
aspectRatio
enum<string>
required
Available options:
SQUARE,
PORTRAIT
​
userNotes
string
required
Required string length: 1 - 2000
​
destinationUrl
string | null

A hint about who the advertiser is, and nothing more: only the scheme, host and path reach the image model, never the query string. Placeholders (see CreateCampaignRequest.destinationUrl) cannot be substituted at this point — the image is generated before the campaign exists, so there is no campaign to name — and a URL still carrying one after the query string is cut is left out of the prompt altogether.

Maximum string length: 2048
​
objective
enum<string> | null
Available options:
AWARENESS,
TRAFFIC,
CONVERSIONS,
APP_INSTALLS
​
adCopy
string | null
Maximum string length: 4000

Response

Accepted

​
requestId
string<uuid>
required