Aller au contenu principal

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

HeaderRequisDescription
AuthorizationOuiBearer <API_KEY>
x-workspace-idOui*UUID du workspace (*sauf routes globales)
Content-TypePour POST/PUTapplication/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éthodeEndpointDescription
GET/api/queries/nodesLister toutes les entités
GET/api/queries/nodes/:idObtenir une entité par ID
GET/api/queries/edgesLister toutes les relations
GET/api/queries/edges/:idObtenir une relation par ID

Commandes (Écriture)

MéthodeEndpointDescription
POST/api/commands/executeExé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 relation
  • DELETE_EDGE - Supprimer une relation
  • UNDO - Annuler la dernière action
  • REDO - Rétablir la dernière action annulée

Live Data

MéthodeEndpointDescription
GET/api/live-data/sourcesLister les sources de données
POST/api/live-data/sourcesCréer une source de données
POST/api/live-data/ingestIngérer des points de données
GET/api/live-data/queryRequêter les séries temporelles

RAG

MéthodeEndpointDescription
POST/api/rag/searchRecherche sémantique
POST/api/rag/hybrid-searchRecherche hybride vecteur+graphe
GET/api/rag/index/statusStatus de l'index

Pagination

GET /api/queries/nodes?limit=50&offset=100
ParamètreDéfautMaxDescription
limit50100Éléments par page
offset0-É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

PlanRequêtes/minRequêtes/jour
Starter6010 000
Pro300100 000
EnterprisePersonnaliséPersonnalisé

Headers dans la réponse :

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 45
X-RateLimit-Reset: 1700000000

Codes HTTP

CodeSignification
200Succès
201Créé
204Pas de contenu (DELETE)
400Requête invalide
401Non authentifié
403Accès interdit
404Non trouvé
409Conflit de version
429Rate limit dépassé
500Erreur serveur

Exemples cURL

export API_KEY="df_live_xxx"
export WORKSPACE_ID="550e8400-..."
export API_URL="https://api.dev-growthsystemes.com"

curl "$API_URL/api/queries/nodes" \
-H "Authorization: Bearer $API_KEY" \
-H "x-workspace-id: $WORKSPACE_ID"

Spécification OpenAPI

La spécification OpenAPI est disponible dans le dépôt à docs/api/openapi.yaml.

Importez-la dans Postman, Insomnia, ou générez des SDKs clients.

Support