Skip to main content

REST API reference

All REST operations use a single action-based endpoint:
Send Content-Type: application/json, a valid X-Api-Key header and an action in the JSON body.

Available actions

JWT-only actions are list_api_keys, create_api_key and revoke_api_key.

Create a campaign

Only client_id is required. Defaults are: Untitled Campaign, ratio 1:1, volume 1, empty text and angle/platform lists, and no image URLs. use_brand_kit is forced to true by this action.

Generate and poll

Generation runs in the background. Poll list_creatives until the expected image count is available. Each successfully generated image consumes one credit; the whole batch is checked against the remaining quota before dispatch. The effective job count is combinations x max(1, floor(volume / combinations)), where combinations are selected angles (or one empty angle) times ratios. A non-divisible volume is rounded down; a volume smaller than the combinations produces one job per combination and can be exceeded. Use the response’s jobs field as the effective batch size. The API does not expose the complete Mode Pro modes/presets matrix available in the application.

Generate angles

This creates ten angles with a name, hook, awareness level, visual style and copy direction. Angle generation does not consume an image credit.

Not exposed

There is currently no public REST action for Inspiration, Explorer, Ads Library search, Clone, favorites or winners. These are application workflows.