API v1REST · JSON · SSE

Référence API TogoLM

Accès programmatique au corpus togolais — recherche sémantique, RAG en streaming, données publiques structurées.

Clé gratuite

200 req / day

Open-source

REST + SSE

Obtenir une clé API

Gratuit et instantané. La clé n'est affichée qu'une seule fois.

Plans & quotas

Anonymous

20 / day

Par IP

Freedéfaut

200 / day

Avec clé API

Dev

1 000 / day

Sur demande

Institution

100 000 / day

Partenaires

Authentification

Passez votre clé dans le header X-API-Key de chaque requête HTTP.

bash

curl https://api.togolm.kofcorporation.com/v1/search?q=budget \
  -H "X-API-Key: tgolm_your_key_here"

Endpoints

Base URL: https://api.togolm.kofcorporation.com

GET/v1/statsPublic

Retourne les statistiques en direct du corpus : nombre de documents, de fragments, sources actives et langues supportées.

bash

curl https://api.togolm.kofcorporation.com/v1/stats

GET/v1/documentsPublic

Liste paginée de tous les documents du corpus. Filtrable par domaine source, catégorie ou langue.

Parameters

pageintegerquery

Page number

Default: 1

page_sizeintegerquery

Results per page (max 100)

Default: 20

sourcestringquery

Filter by source domain (e.g. jo.gouv.tg)

categorystringquery

legal · education · economy · agriculture · health · politics · press

languagestringquery

Language code

Default: fr

bash

curl "https://api.togolm.kofcorporation.com/v1/documents?category=legal&page=1&page_size=10"

GET/v1/searchClé optionnelle

Recherche plein texte sur le corpus via PostgreSQL FTS optimisé pour le français (ts_rank) avec fallback ILIKE. Retourne des extraits avec score de pertinence.

Parameters

qstringqueryrequired

Search query (min 2, max 500 chars)

sourcestringquery

Restrict to a specific source domain

categorystringquery

Restrict to a category

limitintegerquery

Max results (max 50)

Default: 10

bash

curl "https://api.togolm.kofcorporation.com/v1/search?q=budget+2024&limit=5" \
  -H "X-API-Key: YOUR_KEY"

POST/v1/queryClé optionnelle

Recherche les fragments les plus pertinents par similarité vectorielle, puis génère une réponse ancrée avec Gemini 2.5 Flash. Retourne la réponse complète + sources.

Parameters

questionstringbodyrequired

The question to answer (min 3, max 1000 chars)

categorystringbody

Restrict retrieval to a category

languagestringbody

Response language

Default: fr

bash

curl -X POST https://api.togolm.kofcorporation.com/v1/query \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_KEY" \
  -d '{"question": "Quel est le budget de l\'État togolais ?"}'

POST/v1/query/streamClé optionnelle

Identique à /v1/query mais diffuse la réponse token par token via Server-Sent Events. Trois types d'événements : chunk (texte) · sources (citations) · error.

Parameters

questionstringbodyrequired

The question to answer

categorystringbody

Restrict retrieval to a category

languagestringbody

Response language

Default: fr

bash

curl -X POST https://api.togolm.kofcorporation.com/v1/query/stream \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_KEY" \
  --no-buffer \
  -d '{"question": "Comment créer une entreprise au Togo ?"}'

Codes d'erreur

Code	Signification
200	Succès
400	Requête invalide (paramètre manquant ou malformé)
401	Clé API invalide ou absente
409	Email déjà enregistré
422	Validation échouée (corps de requête invalide)
429	Quota journalier dépassé
500	Erreur serveur interne