Generate Campaign Ideas

POST

/campaigns/generate-ideas

• Production
• QA

Generate campaign ideas. SPENDS CREDIT, scaled by num_ideas.

SYNCHRONOUS: the generation runs during this call, so a large num_ideas is a long request. Use /generate-ideas-async for anything big.

Authorizations

• BearerAuth

Parameters

Query Parameters

num_ideas

How many ideas. Scales the spend.

integer

default: 5 >= 1 <= 50

How many ideas. Scales the spend.

user_direction

Any of:

string

string

null

null

Free-text steer for the generator.

Header Parameters

X-Target-Org-Id

Any of:

string

string

null

null

Request Body ^required

Generate campaign ideas from a goal. SPENDS CREDIT.

object

campaign_goal

required

string

campaign_type

Any of:

string

string

null

null

organization_id

Any of:

string

string

null

null

target_persona

Any of:

string

string

null

null

website_url

required

string

Responses

200

Successful Response

object

data

required

A LIST result, open-shaped, with items always present.

The app returns a bare list from some routes and a named key from others (pages, grids, images, creatives, reports, items). Both are published: the original key is preserved AND mirrored onto items, so a client can page any Studio collection the same way without a per-route lookup table.

object

items

Array

key

additional properties

any

pagination

Any of:

PaginationMeta

object

has_next

required

Whether there are more pages

boolean

limit

required

Items per page

integer

next_cursor

Any of:

string

string

null

null

notes

Any of:

Array<string>

Array<string>

null

null

page

required

Current page number (1-indexed)

integer

total

required

Total number of items

integer

total_available

Any of:

integer

integer

null

null

total_is_lower_bound

Any of:

boolean

boolean

null

null

null

null

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string