Skip to main content

​
Parameters

NameTypeRequiredDescription
workspaceIdstringYesWorkspace ID from ocoya_list_workspaces.
promptstringYesCampaign prompt or brief.
goalstringNoOne of awareness, leads, launch, offer, education, event. Defaults to awareness.
audiencestringNoOne of business_owners, founders_executives, marketing_teams, buyers_customers, local_community, investors, first_time_buyers, existing_customers. Defaults to business_owners.
durationnumberNoCampaign duration in days, from 1 to 30. Defaults to 7.
countnumberNoNumber of posts to generate, from 3 to 30. Defaults to 5.
postLengthstringNoOne of short, medium, long, extra_long. Defaults to medium.
tonestringNoOne of professional, friendly, educational, bold, founder_led. Defaults to professional.
brandIdstringNoBrand kit ID from ocoya_list_brand_kits. When campaign media is generated, brand kit logos and icons are treated as protected reference assets.
hashtagLibraryIdstringNoHashtag library ID from ocoya_list_hashtag_libraries.
socialProfileIdsstring[]NoConnected social profile IDs to attach when generated campaign posts are saved.
generateMediabooleanNoWhether to generate images for campaign posts.
imageCountnumberNoNumber of images to generate for each campaign post, from 1 to 5. Values above 1 create carousel-style post creatives. Defaults to 1.
referenceUrlsstring[]NoImage URLs to use as visual references when generateMedia is true. Maximum 3.
referenceDesignIdsstring[]NoStudio 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": {
    "workspaceId": "cmayvq3hk00017apshay5qezu",
    "prompt": "Summer launch campaign for our ecommerce analytics dashboard",
    "goal": "launch",
    "audience": "marketing_teams",
    "duration": 10,
    "count": 6,
    "postLength": "medium",
    "tone": "professional",
    "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.