Intégration - API REST

L'API REST NEURASCOPE vous permet d'intégrer les fonctionnalités de la plateforme dans vos propres applications, scripts et systèmes.

Vue d'Ensemble

L'API NEURASCOPE est une API RESTful qui expose les principales fonctionnalités de la plateforme :

  • Chat : Créer des sessions, envoyer des messages, recevoir des réponses en streaming
  • Orchestration : Exécuter des workflows NeuraFlow et des crews NeuraCrew
  • RAG : Ajouter des documents, effectuer des recherches sémantiques
  • Gestion : Gérer les projets, personas et configurations

Base URL

Toutes les requêtes API utilisent la base URL suivante :

https://app.neurascope.ai/api/v1

Authentification

Chaque requête doit inclure une clé API dans le header Authorization :

Authorization: Bearer nsc_VOTRE_CLE_API

Consultez la page API - Authentification pour les détails sur la gestion des clés et des scopes.

Format des Requêtes

  • Content-Type : application/json
  • Méthodes : GET, POST, PUT, DELETE selon l'endpoint
  • Paramètres : Corps JSON pour POST/PUT, query string pour GET

Exemple de Requête

curl -X POST https://app.neurascope.ai/api/v1/chat/sessions \
  -H "Authorization: Bearer nsc_VOTRE_CLE_API" \
  -H "Content-Type: application/json" \
  -d '{"persona_id": 15, "project_id": 1}'

Format des Réponses

Les réponses sont au format JSON avec la structure suivante :

{
  "success": true,
  "data": { ... },
  "message": "Description de l'action effectuée"
}

En cas d'erreur :

{
  "success": false,
  "error": {
    "code": "ERROR_CODE",
    "message": "Description de l'erreur"
  }
}

Codes de Statut HTTP

Code Signification
200 Requête réussie
201 Ressource créée
400 Requête invalide (paramètres manquants ou incorrects)
401 Non authentifié (clé API manquante ou invalide)
403 Non autorisé (scope insuffisant)
404 Ressource non trouvée
429 Trop de requêtes (rate limiting)
500 Erreur serveur

Rate Limiting

L'API applique des limites de débit par clé API :

Plan Requêtes/minute Requêtes/jour
Starter 60 10 000
Business 300 100 000
Enterprise Personnalisé Personnalisé

Les headers de réponse incluent les informations de rate limiting :

  • X-RateLimit-Limit : Limite maximale
  • X-RateLimit-Remaining : Requêtes restantes
  • X-RateLimit-Reset : Timestamp de réinitialisation

Endpoints Principaux

Endpoint Description
POST /chat/sessions Créer une session de chat
POST /chat/messages Envoyer un message (streaming SSE)
POST /orchestration/workflows/{id}/execute Exécuter un workflow
POST /orchestration/crews/{id}/execute Exécuter un crew
POST /rag/documents Ajouter un document au RAG
POST /rag/search Recherche sémantique
GET /projects Lister les projets
GET /personas Lister les personas

Consultez les pages API - Orchestration et API - Chat Streaming pour les détails de chaque endpoint.

Suivant
API - Authentification