Parameters

NameTypeRequiredDescription
brandIdstringYesID de la marque depuis ocoya_list_brands.
promptstringYesPrompt ou brief de la campagne. Décrivez ici l’audience et le ton — une phrase en dit plus qu’une liste figée.
goalstringNoL’une des valeurs suivantes : awareness, leads, launch, offer, education, event. Par défaut : awareness.
durationnumberNoDurée de la campagne en jours, de 1 à 30. Par défaut : 7.
startDatestringNoJour du premier post, au format YYYY-MM-DD. Doit être demain ou plus tard. Par défaut : demain.
postsPerDaynumberNoFréquence de publication : 0.5 (un jour sur deux), 1, 2, 3 ou 4. Omettez ce champ pour répartir les posts count uniformément sur la duration.
countnumberNoNombre de posts à générer, de 1 à 30. Par défaut : 7.
postLengthstringNoL’une des valeurs suivantes : short, medium, long, extra_long. Par défaut : medium.
hashtagLibraryIdstringNoID de bibliothèque de hashtags depuis ocoya_list_hashtag_libraries.
socialProfileIdsstring[]NoIDs des profils sociaux connectés à associer lorsque les posts de campagne générés sont enregistrés.
generateMediabooleanNoIndique s’il faut générer des images pour les posts de la campagne.
imageCountnumberNoNombre d’images à générer pour chaque post de la campagne, de 1 à 10. Des valeurs supérieures à 1 créent des créations de posts au format carrousel. Par défaut : 1.
referenceUrlsstring[]NoURLs d’images à utiliser comme références visuelles lorsque generateMedia est true. Maximum 3.
referenceDesignIdsstring[]NoIDs de designs Studio depuis ocoya_list_studio_templates à utiliser comme références visuelles lorsque generateMedia est 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

Renvoie l’ID de la campagne mise en file d’attente, le statut GENERATING, et les métadonnées sur la progression de la génération.

Cet outil n’attend pas la fin de la génération des posts. La génération de la campagne s’exécute en arrière-plan, donc les clients doivent considérer la réponse immédiate comme un job mis en file d’attente et vérifier la campagne plus tard dans Ocoya.