Endpoints

MethodePadBeschrijving
GET/brandsAlle merken weergeven
POST/brandsEen merk aanmaken
GET/brands/{brandId}Details van een merk opvragen
PATCH/brands/{brandId}Een merk wijzigen
DELETE/brands/{brandId}Een merk verwijderen

GET /brands

Geeft alle merken weer die bij het geauthenticeerde account horen.

curl https://mentova.ai/api/v1/brands \
  -H "X-API-Key: mtv_live_votre_cle"

Antwoord 200

{
  "data": [
    {
      "id": "clxabc123",
      "name": "Acme Corp",
      "domain": "acme.com",
      "aliases": ["Acme"],
      "language": "fr",
      "country": "FR",
      "autoWeeklyAnalysis": false,
      "createdAt": "2026-01-10T09:00:00.000Z"
    }
  ]
}

POST /brands

Maakt een nieuw merk aan. Het aantal toegestane merken hangt af van uw abonnement.

Aanvraagbody

VeldTypeVerplichtBeschrijving
namestringJaNaam van het merk (max. 100 tekens)
domainstringNeeDomein van het merk (max. 253 tekens)
aliasesstring[]NeeAlternatieve namen om te volgen
languagestringNeeBCP-47-taalcode, bijv. fr (2-5 tekens)
countrystringNeeISO 3166-1 alpha-2-landcode, bijv. FR (2-5 tekens)
curl -X POST https://mentova.ai/api/v1/brands \
  -H "X-API-Key: mtv_live_votre_cle" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Acme Corp",
    "domain": "acme.com",
    "aliases": ["Acme"],
    "language": "fr",
    "country": "FR"
  }'

Antwoord 201

{
  "data": {
    "id": "clxabc123",
    "name": "Acme Corp",
    "domain": "acme.com",
    "aliases": ["Acme"],
    "language": "fr",
    "country": "FR",
    "autoWeeklyAnalysis": false,
    "createdAt": "2026-06-01T09:00:00.000Z"
  }
}

Fouten

HTTPcodeOorzaak
409CONFLICTEr bestaat al een merk met deze naam
422VALIDATION_ERROROngeldige aanvraagbody
422LIMIT_REACHEDLimiet van het aantal merken van uw abonnement bereikt

GET /brands/

Haalt de volledige details van een merk op.

curl https://mentova.ai/api/v1/brands/clxabc123 \
  -H "X-API-Key: mtv_live_votre_cle"

Padparameters

ParameterBeschrijving
brandIdID van het merk

Antwoord 200

{
  "data": {
    "id": "clxabc123",
    "name": "Acme Corp",
    "domain": "acme.com",
    "aliases": ["Acme"],
    "language": "fr",
    "country": "FR",
    "autoWeeklyAnalysis": false,
    "createdAt": "2026-01-10T09:00:00.000Z"
  }
}

PATCH /brands/

Wijzigt een of meer velden van een merk. Alleen de velden die in de aanvraagbody zijn opgenomen, worden bijgewerkt.

Aanvraagbody

VeldTypeVerplichtBeschrijving
namestringNeeNieuwe naam (max. 100 tekens)
domainstring | nullNeeNieuw domein, of null om het te verwijderen
aliasesstring[]NeeNieuwe array met aliassen
languagestringNeeTaal van de belangrijkste markt (2-5 tekens, genormaliseerd: pt-BR wordt pt). Als dit veld alleen wordt meegestuurd, vervangt het de belangrijkste markt, zonder er een toe te voegen
marketsstring[]NeeGevolgde markten, in het formaat LAND-taal (BE-fr, BE-nl); de eerste is de belangrijkste markt. Tussen 1 en 100 items
autoWeeklyAnalysisbooleanNeeAutomatische wekelijkse campagnes in- of uitschakelen

Markten volgen dezelfde regels als in de applicatie: slechts één tijdens de proefperiode van 14 dagen (403, code MARKETS_TRIAL_LIMIT), zo veel als u wilt op een betaald abonnement. De talen van extra markten moeten deel uitmaken van de aangeboden analysetalen (anders 422). Een thema kan alleen worden aangemaakt binnen een markt die het merk volgt: voeg de markt hier eerst toe voordat u de bijbehorende thema's aanmaakt (zie Thema's en prompts).

curl -X PATCH https://mentova.ai/api/v1/brands/clxabc123 \
  -H "X-API-Key: mtv_live_votre_cle" \
  -H "Content-Type: application/json" \
  -d '{"markets": ["BE-fr", "BE-nl"]}'

Antwoord 200

{
  "data": {
    "id": "clxabc123",
    "name": "Acme Corp",
    "domain": "acme.com",
    "autoWeeklyAnalysis": true
  }
}

DELETE /brands/

Verwijdert een merk en alle bijbehorende gegevens definitief.

curl -X DELETE https://mentova.ai/api/v1/brands/clxabc123 \
  -H "X-API-Key: mtv_live_votre_cle"

Antwoord 200

{
  "data": { "deleted": true }
}

Avatars

Doelgroepavatars definiëren persona-profielen die worden gebruikt om LLM-prompts tijdens campagnes van context te voorzien. Limiet per abonnement: 5 avatars per merk op Pro, onbeperkt vanaf Pro+.

Endpoints

MethodePadBeschrijving
GET/brands/{brandId}/avatarsAvatars weergeven
POST/brands/{brandId}/avatarsEen avatar aanmaken
PATCH/brands/{brandId}/avatars/{avatarId}Een avatar wijzigen
DELETE/brands/{brandId}/avatars/{avatarId}Een avatar verwijderen

GET /brands//avatars

curl https://mentova.ai/api/v1/brands/clxabc123/avatars \
  -H "X-API-Key: mtv_live_votre_cle"

Antwoord 200

{
  "data": [
    {
      "id": "clxavatar1",
      "brandId": "clxabc123",
      "name": "Sophie, Directrice Marketing",
      "sector": "SaaS B2B",
      "role": "Directrice Marketing",
      "objectives": "Augmenter le share of voice de la marque dans les résultats IA",
      "description": null,
      "isDefault": true,
      "createdAt": "2026-04-17T10:00:00.000Z",
      "updatedAt": "2026-04-17T10:00:00.000Z"
    }
  ]
}

POST /brands//avatars

Aanvraagbody

VeldTypeVerplichtBeschrijving
namestringJaWeergavenaam van de avatar (max. 100 tekens)
sectorstringJaSector (max. 100 tekens)
rolestringJaRol of type persona (max. 100 tekens)
objectivesstringJaDoelen en context van deze persona (max. 500 tekens)
descriptionstringNeeOptionele uitgebreide beschrijving (max. 1000 tekens)
isDefaultbooleanNeeInstellen als standaardavatar voor nieuwe campagnes
curl -X POST https://mentova.ai/api/v1/brands/clxabc123/avatars \
  -H "X-API-Key: mtv_live_votre_cle" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Sophie, Directrice Marketing",
    "sector": "SaaS B2B",
    "role": "Directrice Marketing",
    "objectives": "Augmenter le share of voice de la marque dans les résultats IA",
    "isDefault": true
  }'

Antwoord 201

{
  "data": {
    "id": "clxavatar1",
    "brandId": "clxabc123",
    "name": "Sophie, Directrice Marketing",
    "sector": "SaaS B2B",
    "role": "Directrice Marketing",
    "objectives": "Augmenter le share of voice de la marque dans les résultats IA",
    "description": null,
    "isDefault": true,
    "createdAt": "2026-04-17T10:00:00.000Z",
    "updatedAt": "2026-04-17T10:00:00.000Z"
  }
}

PATCH /brands//avatars/

Alle velden zijn optioneel. Alleen de meegestuurde velden worden bijgewerkt.

curl -X PATCH https://mentova.ai/api/v1/brands/clxabc123/avatars/clxavatar1 \
  -H "X-API-Key: mtv_live_votre_cle" \
  -H "Content-Type: application/json" \
  -d '{"isDefault": false}'

Antwoord 200

{
  "data": {
    "id": "clxavatar1",
    "isDefault": false
  }
}

DELETE /brands//avatars/

curl -X DELETE https://mentova.ai/api/v1/brands/clxabc123/avatars/clxavatar1 \
  -H "X-API-Key: mtv_live_votre_cle"

Antwoord 200

{
  "data": { "id": "clxavatar1" }
}