Référence API
Documentation complète de l'API REST DataForge.
URL de base
https://api.dev-growthsystemes.com
Authentification
Tous les endpoints requièrent une authentification :
curl "https://api.dev-growthsystemes.com/api/queries/nodes" \
-H "Authorization: Bearer df_live_xxxxxxxxxxxxxxxxxxxx" \
-H "x-workspace-id: 550e8400-e29b-41d4-a716-446655440000"
Headers requis
| Header | Requis | Description |
|---|---|---|
Authorization | Oui | Bearer <API_KEY> |
x-workspace-id | Oui* | UUID du workspace (*sauf routes globales) |
Content-Type | Pour POST/PUT | application/json |
Voir le Guide des clés API pour la gestion des clés.
Format des réponses
Réponse de succès
{
"success": true,
"data": { ... },
"meta": {
"total": 100,
"limit": 50,
"offset": 0
},
"requestId": "req_xxxxxxxxxxxx"
}
Réponse d'erreur
{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Type d'entité invalide",
"details": { ... }
},
"requestId": "req_xxxxxxxxxxxx"
}
Endpoints principaux
Requêtes (Lecture)
| Méthode | Endpoint | Description |
|---|---|---|
GET | /api/queries/nodes | Lister toutes les entités |
GET | /api/queries/nodes/:id | Obtenir une entité par ID |
GET | /api/queries/edges | Lister toutes les relations |
GET | /api/queries/edges/:id | Obtenir une relation par ID |
Commandes (Écriture)
| Méthode | Endpoint | Description |
|---|---|---|
POST | /api/commands/execute | Exécuter une commande |
Types de commandes :
CREATE_NODE- Créer une entitéUPDATE_NODE- Modifier une entitéDELETE_NODE- Supprimer une entitéCREATE_EDGE- Créer une relationDELETE_EDGE- Supprimer une relationUNDO- Annuler la dernière actionREDO- Rétablir la dernière action annulée
Live Data
| Méthode | Endpoint | Description |
|---|---|---|
GET | /api/live-data/sources | Lister les sources de données |
POST | /api/live-data/sources | Créer une source de données |
POST | /api/live-data/ingest | Ingérer des points de données |
GET | /api/live-data/query | Requêter les séries temporelles |
RAG
| Méthode | Endpoint | Description |
|---|---|---|
POST | /api/rag/search | Recherche sémantique |
POST | /api/rag/hybrid-search | Recherche hybride vecteur+graphe |
GET | /api/rag/index/status | Status de l'index |
Pagination
GET /api/queries/nodes?limit=50&offset=100
| Paramètre | Défaut | Max | Description |
|---|---|---|---|
limit | 50 | 100 | Éléments par page |
offset | 0 | - | Éléments à sauter |
Filtrage
GET /api/queries/nodes?entityType=concept&name=Client
Tri
GET /api/queries/nodes?sort=-createdAt,name
- Préfixe
-pour ordre descendant - Champs multiples séparés par virgule
Rate Limits
| Plan | Requêtes/min | Requêtes/jour |
|---|---|---|
| Starter | 60 | 10 000 |
| Pro | 300 | 100 000 |
| Enterprise | Personnalisé | Personnalisé |
Headers dans la réponse :
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 45
X-RateLimit-Reset: 1700000000
Codes HTTP
| Code | Signification |
|---|---|
200 | Succès |
201 | Créé |
204 | Pas de contenu (DELETE) |
400 | Requête invalide |
401 | Non authentifié |
403 | Accès interdit |
404 | Non trouvé |
409 | Conflit de version |
429 | Rate limit dépassé |
500 | Erreur serveur |