Create an AI-generated campaign
Queues generation for a multi-post AI campaign and returns immediately with GENERATING status. Campaign posts are generated asynchronously in the background.
Authorizations
Query Parameters
Ocoya workspace ID. Get one from GET /workspaces.
"cmayvq3hk00017apshay5qezu"
Body
Campaign prompt or brief.
3"Summer launch campaign for our ecommerce analytics dashboard."
Campaign objective.
awareness, leads, launch, offer, education, event "launch"
Primary campaign audience.
business_owners, founders_executives, marketing_teams, buyers_customers, local_community, investors, first_time_buyers, existing_customers "marketing_teams"
Campaign duration in days, from 1 to 30. Defaults to 7.
1 <= x <= 3010
Number of posts to generate, from 3 to 30. Defaults to 5.
3 <= x <= 306
Target caption length for each generated campaign post.
short, medium, long, extra_long "medium"
Caption tone for campaign posts.
professional, friendly, educational, bold, founder_led "professional"
Brand kit ID used for brand context. When campaign media is generated, brand kit logos and icons are treated as protected reference assets. Get IDs from GET /brand-kits.
"cmayw38dz00047apsue9nw4tf"
Hashtag library ID used for hashtag context. Get IDs from GET /hashtag-libraries.
"cmayw7l5200067apsmz2tv7e8"
Connected social profile IDs to attach when generated campaign posts are saved. Get IDs from GET /social-profiles.
Whether to generate images for campaign posts.
true
Number of images to generate for each campaign post, from 1 to 5. Values above 1 create carousel-style post creatives. Defaults to 1.
1 <= x <= 53
Optional image URLs to use as visual references when generateMedia is true. Maximum 3.
Optional Studio design IDs to use as visual references when generateMedia is true. Get IDs from GET /studio-templates. Maximum 3.