Brand API

The brand profile and the brand kit used by every visual.

6 endpoints. Every path is relative to the API base URL and needs a bearer token unless it is marked public. See the REST API overview for authentication, errors and pagination.

GET/v1/orgs/{orgId}/brand/kit

Bearer tokenMCP tool: get_brand_kit

The workspace's brand colours, fonts, tagline and logo used for branded visuals, and what's missing.

Path parameters

• orgIdstring (uuid)required

Responses

200The workspace's brand colours, fonts, tagline and logo used for branded visuals, and what's missing.

• dataobjectrequired
  Fields

  • colorsobjectrequired
    Fields

    • primarystring | nullrequired
    • secondarystring | nullrequired
    • accentstring | nullrequired
    • backgroundstring | nullrequired
  • headingFontstring | nullrequired
  • bodyFontstring | nullrequired
  • logoobject | nullrequired
    Fields

    • assetIdstring | nullrequired
    • urlstring | nullrequired
    • sourceUrlstring | nullrequired
    • widthnumber | nullrequired
    • heightnumber | nullrequired
    • contentTypestring | nullrequired
  • taglinestring | nullrequired
  • websitestring | nullrequired
  • updatedAtstring | nullrequired
  • missingarray<string>required

Request

curl -X GET "https://api.adventur.ai/v1/orgs/$ORG_ID/brand/kit" \
  -H "Authorization: Bearer $ADVENTURAI_TOKEN"

PATCH/v1/orgs/{orgId}/brand/kit

Bearer tokenMCP tool: update_brand_kit

Sets any of the brand colours, fonts, logo, tagline and website. Omitted fields are unchanged and null clears one. A logo link is downloaded, checked and stored in the workspace (SVGs are sanitised first). Every field is checked before anything is saved: a refused call returns 422 with one error per bad field.

Path parameters

• orgIdstring (uuid)required

Request body application/json

• colorsobject
  Fields

  • primarystring | null
  • secondarystring | null
  • accentstring | null
  • backgroundstring | null
• headingFontstring | null
• bodyFontstring | null
• logoobject | null
  Option 1

  • urlstringrequired
  Option 2

  • assetIdstringrequired
• taglinestring | null
• websitestring | null
• ifUpdatedAtstring
• dryRunboolean

Responses

200Sets any of the brand colours, fonts, logo, tagline and website. Omitted fields are unchanged and null clears one. A logo link is downloaded, checked and stored in the workspace (SVGs are sanitised first). Every field is checked before anything is saved: a refused call returns 422 with one error per bad field.

• dataobjectrequired
  Fields

  • savedbooleanrequired
  • kitobjectrequired
    Fields

    • colorsobjectrequired
      Fields

      • primarystring | nullrequired
      • secondarystring | nullrequired
      • accentstring | nullrequired
      • backgroundstring | nullrequired
    • headingFontstring | nullrequired
    • bodyFontstring | nullrequired
    • logoobject | nullrequired
      Fields

      • assetIdstring | nullrequired
      • urlstring | nullrequired
      • sourceUrlstring | nullrequired
      • widthnumber | nullrequired
      • heightnumber | nullrequired
      • contentTypestring | nullrequired
    • taglinestring | nullrequired
    • websitestring | nullrequired
    • updatedAtstring | nullrequired
    • missingarray<string>required
  • changedarray<string>required
  • warningsarray<object>required
    Item fields

    • fieldstringrequired
    • codestringrequired
    • messagestringrequired
  • missingarray<string>required
  • previewHintstringrequired

Request

curl -X PATCH "https://api.adventur.ai/v1/orgs/$ORG_ID/brand/kit" \
  -H "Authorization: Bearer $ADVENTURAI_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

GET/v1/orgs/{orgId}/brand/kit/website

Bearer tokenMCP tool: find_brand_kit_on_website

Reads a public website and lists colours, logos, images and fonts that could go in the brand kit, with a suggested kit. Saves nothing.

Path parameters

• orgIdstring (uuid)required

Query parameters

• urlstringrequired

Responses

200Reads a public website and lists colours, logos, images and fonts that could go in the brand kit, with a suggested kit. Saves nothing.

• dataobjectrequired
  Fields

  • websiteUrlstringrequired
  • reachablebooleanrequired
  • siteNamestring | nullrequired
  • taglinestring | nullrequired
  • colorsarray<object>required
    Item fields

    • hexstringrequired
    • sourcestringrequired

      one of theme-color, css-variable, stylesheet, inline

    • detailstring | nullrequired
    • usesintegerrequired
    • neutralbooleanrequired
  • logosarray<object>required
    Item fields

    • urlstringrequired
    • sourcestringrequired

      one of structured-data, og:logo, img, apple-touch-icon, icon

  • imagesarray<object>required
    Item fields

    • urlstringrequired
    • sourcestringrequired

      one of og:image, twitter:image

  • fontsarray<object>required
    Item fields

    • familystringrequired
    • sourcestringrequired

      one of google-fonts, css

  • suggestionobjectrequired
    Fields

    • websitestringrequired
    • colorsobject
      Fields

      • primarystring
      • secondarystring
      • accentstring
      • backgroundstring
    • headingFontstring
    • bodyFontstring
    • logoobject
      Fields

      • urlstringrequired

Request

curl -X GET "https://api.adventur.ai/v1/orgs/$ORG_ID/brand/kit/website?url=https%3A%2F%2Fexample.com" \
  -H "Authorization: Bearer $ADVENTURAI_TOKEN"

GET/v1/orgs/{orgId}/brand/profile

Bearer token

Path parameters

• orgIdstring (uuid)required

Responses

200

• dataobjectrequired
  Fields

  • websiteUrlstring (uri) | nullrequired
  • logoUrlstring (uri) | nullrequired
  • primaryFontstring | nullrequired
  • secondaryFontstring | nullrequired
  • colorPalettearray<string>required
  • taglinestring | nullrequired
  • missionstring | nullrequired
  • voiceobjectrequired
    Fields

    • tonestringrequired
    • personalityTraitsarray<string>required
    • writingGuidelinesarray<string>required
    • bannedPhrasesarray<string>required
  • businessOutlineobjectrequired
    Fields

    • overviewstringrequired
    • productsOrServicesarray<string>required
    • targetAudiencearray<string>required
    • valuePropositionstringrequired
    • differentiatorsarray<string>required
  • backgroundColorstring | null
  • logoAssetobject | null
    Fields

    • assetIdstringrequired
    • contentTypestringrequired
    • widthnumber | nullrequired
    • heightnumber | nullrequired
    • sourceAssetIdstring | null
  • kitUpdatedAtstring | null
  • brandTypestring

    one of personal, business, unknown

  • identitystring | null
  • expertisearray<string>
  • goalsarray<string>
  • topicsarray<string>
  • opinionsarray<string>
  • guardrailsarray<object>
    Item fields

    • idstringrequired
    • textstringrequired
    • disclosurestring

      one of private, restricted

  • knowledgeItemsarray<object>
    Item fields

    • idstringrequired
    • kindstringrequired

      one of claim, fact, opinion, preference, topic

    • textstringrequired
    • provenanceobjectrequired
      Fields

      • originstringrequired

        one of user, inferred, imported, learned

      • sourceTypestring | null
      • sourceUrlstring | null
      • sourceExternalIdstring | null
      • fetchedAtstring | null
      • updatedAtstring | null
      • confidencestring

        one of high, medium, low

      • userSuppliedboolean
    • disclosurestring

      one of public, private, restricted

    • durabilitystring

      one of durable, time_sensitive

    • confirmedboolean
  • preferenceSignalsarray<object>
    Item fields

    • idstringrequired
    • signalstringrequired
    • kindstringrequired

      one of approval, edit, reject, explicit

    • lastSeenAtstringrequired
    • confidencestring

      one of high, medium, low

    • occurrencesinteger
    • promotedboolean
  • profileDisclosurestring

    one of public, private, restricted

  • metaobject
    Fields

    • schemaVersioninteger
    • confirmedAtstring | null
    • lastInferredAtstring | null
    • lastRefreshedAtstring | null

Request

curl -X GET "https://api.adventur.ai/v1/orgs/$ORG_ID/brand/profile" \
  -H "Authorization: Bearer $ADVENTURAI_TOKEN"

PATCH/v1/orgs/{orgId}/brand/profile

Bearer token

Path parameters

• orgIdstring (uuid)required

Request body application/json

• websiteUrlstring (uri) | null
• logoUrlstring (uri) | null
• primaryFontstring | null
• secondaryFontstring | null
• colorPalettearray<string>
• taglinestring | null
• missionstring | null
• voiceobject
  Fields

  • tonestring
  • personalityTraitsarray<string>
  • writingGuidelinesarray<string>
  • bannedPhrasesarray<string>
• businessOutlineobject
  Fields

  • overviewstring
  • productsOrServicesarray<string>
  • targetAudiencearray<string>
  • valuePropositionstring
  • differentiatorsarray<string>
• brandTypestring

  one of personal, business, unknown

• identitystring | null
• expertisearray<string>
• goalsarray<string>
• topicsarray<string>
• opinionsarray<string>
• guardrailsarray<object>
  Item fields

  • idstringrequired
  • textstringrequired
  • disclosurestring

    one of private, restricted

• knowledgeItemsarray<object>
  Item fields

  • idstringrequired
  • kindstringrequired

    one of claim, fact, opinion, preference, topic

  • textstringrequired
  • provenanceobjectrequired
    Fields

    • originstringrequired

      one of user, inferred, imported, learned

    • sourceTypestring | null
    • sourceUrlstring | null
    • sourceExternalIdstring | null
    • fetchedAtstring | null
    • updatedAtstring | null
    • confidencestring

      one of high, medium, low

    • userSuppliedboolean
  • disclosurestring

    one of public, private, restricted

  • durabilitystring

    one of durable, time_sensitive

  • confirmedboolean
• preferenceSignalsarray<object>
  Item fields

  • idstringrequired
  • signalstringrequired
  • kindstringrequired

    one of approval, edit, reject, explicit

  • lastSeenAtstringrequired
  • confidencestring

    one of high, medium, low

  • occurrencesinteger
  • promotedboolean
• profileDisclosurestring

  one of public, private, restricted

• metaobject
  Fields

  • schemaVersioninteger
  • confirmedAtstring | null
  • lastInferredAtstring | null
  • lastRefreshedAtstring | null
• confirmBrandContextboolean

Responses

200

• dataobjectrequired
  Fields

  • websiteUrlstring (uri) | nullrequired
  • logoUrlstring (uri) | nullrequired
  • primaryFontstring | nullrequired
  • secondaryFontstring | nullrequired
  • colorPalettearray<string>required
  • taglinestring | nullrequired
  • missionstring | nullrequired
  • voiceobjectrequired
    Fields

    • tonestringrequired
    • personalityTraitsarray<string>required
    • writingGuidelinesarray<string>required
    • bannedPhrasesarray<string>required
  • businessOutlineobjectrequired
    Fields

    • overviewstringrequired
    • productsOrServicesarray<string>required
    • targetAudiencearray<string>required
    • valuePropositionstringrequired
    • differentiatorsarray<string>required
  • backgroundColorstring | null
  • logoAssetobject | null
    Fields

    • assetIdstringrequired
    • contentTypestringrequired
    • widthnumber | nullrequired
    • heightnumber | nullrequired
    • sourceAssetIdstring | null
  • kitUpdatedAtstring | null
  • brandTypestring

    one of personal, business, unknown

  • identitystring | null
  • expertisearray<string>
  • goalsarray<string>
  • topicsarray<string>
  • opinionsarray<string>
  • guardrailsarray<object>
    Item fields

    • idstringrequired
    • textstringrequired
    • disclosurestring

      one of private, restricted

  • knowledgeItemsarray<object>
    Item fields

    • idstringrequired
    • kindstringrequired

      one of claim, fact, opinion, preference, topic

    • textstringrequired
    • provenanceobjectrequired
      Fields

      • originstringrequired

        one of user, inferred, imported, learned

      • sourceTypestring | null
      • sourceUrlstring | null
      • sourceExternalIdstring | null
      • fetchedAtstring | null
      • updatedAtstring | null
      • confidencestring

        one of high, medium, low

      • userSuppliedboolean
    • disclosurestring

      one of public, private, restricted

    • durabilitystring

      one of durable, time_sensitive

    • confirmedboolean
  • preferenceSignalsarray<object>
    Item fields

    • idstringrequired
    • signalstringrequired
    • kindstringrequired

      one of approval, edit, reject, explicit

    • lastSeenAtstringrequired
    • confidencestring

      one of high, medium, low

    • occurrencesinteger
    • promotedboolean
  • profileDisclosurestring

    one of public, private, restricted

  • metaobject
    Fields

    • schemaVersioninteger
    • confirmedAtstring | null
    • lastInferredAtstring | null
    • lastRefreshedAtstring | null

Request

curl -X PATCH "https://api.adventur.ai/v1/orgs/$ORG_ID/brand/profile" \
  -H "Authorization: Bearer $ADVENTURAI_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

POST/v1/orgs/{orgId}/brand/profile/from-website

Bearer token

Path parameters

• orgIdstring (uuid)required

Request body application/json

• websiteUrlstringrequired

Responses

200

• dataobjectrequired
  Fields

  • profileobjectrequired
    Fields

    • websiteUrlstring (uri) | nullrequired
    • logoUrlstring (uri) | nullrequired
    • primaryFontstring | nullrequired
    • secondaryFontstring | nullrequired
    • colorPalettearray<string>required
    • taglinestring | nullrequired
    • missionstring | nullrequired
    • voiceobjectrequired
      Fields

      • tonestringrequired
      • personalityTraitsarray<string>required
      • writingGuidelinesarray<string>required
      • bannedPhrasesarray<string>required
    • businessOutlineobjectrequired
      Fields

      • overviewstringrequired
      • productsOrServicesarray<string>required
      • targetAudiencearray<string>required
      • valuePropositionstringrequired
      • differentiatorsarray<string>required
    • backgroundColorstring | null
    • logoAssetobject | null
      Fields

      • assetIdstringrequired
      • contentTypestringrequired
      • widthnumber | nullrequired
      • heightnumber | nullrequired
      • sourceAssetIdstring | null
    • kitUpdatedAtstring | null
    • brandTypestring

      one of personal, business, unknown

    • identitystring | null
    • expertisearray<string>
    • goalsarray<string>
    • topicsarray<string>
    • opinionsarray<string>
    • guardrailsarray<object>
      Item fields

      • idstringrequired
      • textstringrequired
      • disclosurestring

        one of private, restricted

    • knowledgeItemsarray<object>
      Item fields

      • idstringrequired
      • kindstringrequired

        one of claim, fact, opinion, preference, topic

      • textstringrequired
      • provenanceobjectrequired
        Fields

        • originstringrequired

          one of user, inferred, imported, learned

        • sourceTypestring | null
        • sourceUrlstring | null
        • sourceExternalIdstring | null
        • fetchedAtstring | null
        • updatedAtstring | null
        • confidencestring

          one of high, medium, low

        • userSuppliedboolean
      • disclosurestring

        one of public, private, restricted

      • durabilitystring

        one of durable, time_sensitive

      • confirmedboolean
    • preferenceSignalsarray<object>
      Item fields

      • idstringrequired
      • signalstringrequired
      • kindstringrequired

        one of approval, edit, reject, explicit

      • lastSeenAtstringrequired
      • confidencestring

        one of high, medium, low

      • occurrencesinteger
      • promotedboolean
    • profileDisclosurestring

      one of public, private, restricted

    • metaobject
      Fields

      • schemaVersioninteger
      • confirmedAtstring | null
      • lastInferredAtstring | null
      • lastRefreshedAtstring | null
  • sourcestringrequired

    one of ai, heuristic

Request

curl -X POST "https://api.adventur.ai/v1/orgs/$ORG_ID/brand/profile/from-website" \
  -H "Authorization: Bearer $ADVENTURAI_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"websiteUrl":"string"}'