Parameters

NameTypeRequiredDescription
brandIdstringYesBrand ID from ocoya_list_brands.

Request example

{
  "name": "ocoya_get_brand",
  "arguments": {
    "brandId": "cmayvq3hk00017apshay5qezu"
  }
}

Returns

Returns the brand profile as the Brand page shows it:

FieldDescription
id, name, image, timezone, weekStartThe brand itself.
descriptionWhat the brand does. AI writing reads it.
urlWebsite, or an empty string.
logosLogo image URLs.
colorsBrand colors as hex values.
fontsHeading and body fonts used for designs.
socialsSocial profile links, by network.
toneTone of voice: up to 3 tones.
guidelinesExtra writing guidelines every AI prompt follows.
keywordsSEO keywords, each with monthlySearches where keyword detection found a number.
hashtagsThe brand’s hashtags, lowercase and without #. AI campaigns use them.
channelCountConnected channels and stores.
scorescore, the brand score out of 100 (the same as in Ocoya’s sidebar), and nextStep: the step worth the most points (section, sectionLabel, label, points), or null at 100.

This tool only reads: it changes nothing in Ocoya. To change the profile, use ocoya_update_brand.