Parameters
| Name | Type | Required | Description |
|---|---|---|---|
brandId | string | Yes | ID da Brand obtido a partir de ocoya_list_brands. |
prompt | string | Yes | Prompt ou briefing da campanha. Descreva aqui o público‑alvo e o tom — uma frase diz mais do que uma lista fixa poderia. |
goal | string | No | Um de awareness, leads, launch, offer, education, event. O valor por omissão é awareness. |
duration | number | No | Duração da campanha em dias, de 1 a 30. O valor por omissão é 7. |
startDate | string | No | Dia do primeiro post, em formato YYYY-MM-DD. Tem de ser amanhã ou uma data posterior. O valor por omissão é amanhã. |
postsPerDay | number | No | Frequência de publicação: 0.5 (dia sim, dia não), 1, 2, 3 ou 4. Se omitir, distribui os posts de count de forma uniforme ao longo de duration. |
count | number | No | Número de posts a gerar, de 1 a 30. O valor por omissão é 7. |
postLength | string | No | Um de short, medium, long, extra_long. O valor por omissão é medium. |
hashtagLibraryId | string | No | ID da hashtag library obtido a partir de ocoya_list_hashtag_libraries. |
socialProfileIds | string[] | No | IDs dos social profiles ligados a associar quando os posts gerados da campanha forem guardados. |
generateMedia | boolean | No | Se deve gerar imagens para os posts da campanha. |
imageCount | number | No | Número de imagens a gerar para cada post da campanha, de 1 a 10. Valores acima de 1 criam criativos em formato de carrossel. O valor por omissão é 1. |
referenceUrls | string[] | No | URLs de imagem a usar como referências visuais quando generateMedia é true. Máximo 3. |
referenceDesignIds | string[] | No | IDs de Studio designs de ocoya_list_studio_templates a usar como referências visuais quando generateMedia é true. Máximo 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
Devolve o ID da campanha em fila, o estado GENERATING e metadados sobre o progresso da geração.
Esta ferramenta não espera pelos posts gerados. A geração da campanha é executada em segundo plano, por isso os clientes devem tratar a resposta imediata como um trabalho em fila e verificar a campanha mais tarde na Ocoya.