Skip to content

Create Ad Creative

POST
/ad-creatives

Generate an ad creative. SPENDS CREDIT - a copy pass and an image pass.

ASYNCHRONOUS: the row is committed as generating and returned immediately; the copy and the image land afterwards. Poll GET /ad-creatives/{id} until its status settles.

image_source: "library" with a library_image_id skips the image pass and is materially cheaper. image_source: "ai" is the default and is what the cost of this call mostly is.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Generate an ad creative. SPENDS CREDIT - copy and, by default, imagery.

image_source ‘ai’ generates the image; ‘library’ takes library_image_id from the image library instead and is the cheaper of the two.

object
ad_format
required
string
campaign_id
Any of:
string
image_source

‘ai’ generates an image; ‘library’ reuses one.

string
default: ai
library_image_id
Any of:
string
name
Any of:
string
platform
required
string
prompt
Any of:
string
<= 2000 characters
reference_image_ids
Any of:
Array<string>

Responses

201

Successful Response

object
data
required

One Studio object, open-shaped. See the module docstring.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string