Référence de l’API

Authentification

Toutes les requêtes doivent comporter un jeton Bearer dans l’en-tête Authorization. Générez votre clé d’API dans Paramètres → API.

Authorization: Bearer ibk_your_key_here

Gardez votre clé secrète : elle donne un accès complet, en lecture comme en écriture, aux données de votre compte. En cas de fuite, révoquez-la depuis les Paramètres et générez-en une nouvelle.

URL de base

https://intelbrief.xyz/api/v1

Tous les points d’accès fonctionnent uniquement en HTTPS. Les réponses sont au format JSON, avec Content-Type: application/json.

Erreurs

Les réponses d’erreur contiennent toujours une chaîne error :

{ "error": "Account limit (100) reached for your plan" }

Comptes

Un « compte » désigne toute entité que vous suivez : concurrent, client ou prospect. Les comptes correspondent à ce que le tableau de bord appelle Concurrents / Clients / Prospects.

Lister les comptes

Renvoie tous les comptes de votre espace, triés par nom dans l’ordre alphabétique.

curl https://intelbrief.xyz/api/v1/accounts \
  -H "Authorization: Bearer ibk_your_key_here"

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Acme Corp",
    "domain": "acme.com",
    "type": "competitor",
    "status": "active",
    "createdAt": "2025-01-15T09:00:00.000Z"
  }
]

Créer un compte

Crée un nouveau compte suivi et programme ses premières analyses selon vos préférences de sources par défaut (Paramètres).

curl -X POST https://intelbrief.xyz/api/v1/accounts \
  -H "Authorization: Bearer ibk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"name":"Acme Corp","domain":"acme.com","type":"competitor"}'

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "Acme Corp",
  "domain": "acme.com",
  "type": "competitor",
  "status": "pending",
  "createdAt": "2025-06-01T10:00:00.000Z"
}

Renvoie 201 Created en cas de succès. Les comptes créés via l’API sont pris en compte lors de la prochaine analyse hebdomadaire (le dimanche) ; les signaux apparaissent dans /signals après cette analyse.

Signaux

Les signaux sont les changements détectés un par un — une mise à jour tarifaire, une nouvelle offre d’emploi, un lancement produit, etc. L’IA attribue à chaque signal un niveau d’importance : critical (critique), notable (important) ou minor (mineur).

Lister les signaux

curl "https://intelbrief.xyz/api/v1/signals?days=14&importance=critical,notable&limit=50" \
  -H "Authorization: Bearer ibk_your_key_here"

[
  {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "changeType": "pricing",
    "importance": "critical",
    "summary": "Acme Corp removed the free tier from their pricing page",
    "detectedAt": "2025-06-10T14:23:00.000Z"
  }
]

Briefs

Chaque semaine, l’IA rédige un brief qui retient, parmi les signaux de la semaine précédente sur tous vos comptes, les informations qui valent la lecture (moins de 400 mots, sans jamais répéter une info déjà publiée). Les briefs sont générés chaque lundi matin (entre 4 h et 7 h UTC) et envoyés par e-mail.

Obtenir le dernier brief

Renvoie le brief le plus récent. Renvoie 404 si aucun brief n’a encore été généré (les nouveaux comptes attendent le lundi suivant).

curl https://intelbrief.xyz/api/v1/digests/latest \
  -H "Authorization: Bearer ibk_your_key_here"

{
  "id": "d9e8f7a6-b5c4-3210-fedc-ba9876543210",
  "weekOf": "2025-06-09",
  "status": "sent",
  "createdAt": "2025-06-09T04:00:00.000Z",
  "content": {
    "headline": "3 critical signals this week",
    "sections": [...]
  }
}

Lister les briefs

curl "https://intelbrief.xyz/api/v1/digests?limit=4" \
  -H "Authorization: Bearer ibk_your_key_here"

Renvoie un tableau de briefs, du plus récent au plus ancien, chacun ayant la même structure que la réponse de /latest.