Parameters
| Name | Type | Required | Description |
|---|---|---|---|
brandId | string | Yes | Brand ID from ocoya_list_brands. |
prompt | string | Yes | Campaign prompt or brief. Describe the audience and the tone here — a sentence says more than a fixed list could. |
goal | string | No | One of awareness, leads, launch, offer, education, event. Defaults to awareness. |
duration | number | No | Campaign duration in days, from 1 to 30. Defaults to 7. |
startDate | string | No | Day of the first post, YYYY-MM-DD. Must be tomorrow or later. Defaults to tomorrow. |
postsPerDay | number | No | How often to post: 0.5 (every other day), 1, 2, 3 or 4. Omit to spread count posts evenly over duration. |
count | number | No | Number of posts to generate, from 1 to 30. Defaults to 7. |
postLength | string | No | One of short, medium, long, extra_long. Defaults to medium. |
hashtagLibraryId | string | No | Hashtag library ID from ocoya_list_hashtag_libraries. |
socialProfileIds | string[] | No | Connected social profile IDs to attach when generated campaign posts are saved. |
generateMedia | boolean | No | Whether to generate images for campaign posts. |
imageCount | number | No | Number of images to generate for each campaign post, from 1 to 10. Values above 1 create carousel-style post creatives. Defaults to 1. |
referenceUrls | string[] | No | Image URLs to use as visual references when generateMedia is true. Maximum 3. |
referenceDesignIds | string[] | No | Studio design IDs from ocoya_list_studio_templates to use as visual references when generateMedia is true. Maximum 3. |
Request example
{
"name": "ocoya_create_ai_campaign",
"arguments": {
"brandId": "cmayvq3hk00017apshay5qezu",
"prompt": "Summer launch campaign for our ecommerce analytics dashboard, aimed at marketing teams already using spreadsheets. Confident, practical tone.",
"goal": "launch",
"duration": 10,
"count": 6,
"postLength": "medium",
"hashtagLibraryId": "cmayw7l5200067apsmz2tv7e8",
"socialProfileIds": ["clh49poxf008x8kov4ncbjty9"],
"generateMedia": true,
"imageCount": 3
}
}Returns
Returns the queued campaign ID, GENERATING status, and generation progress metadata.
This tool does not wait for generated posts. Campaign generation runs in the background, so clients should treat the immediate response as a queued job and check the campaign later in Ocoya.