Skip to content

README.md

Latest commit

 

History

History
295 lines (225 loc) · 8.95 KB

README.md

File metadata and controls

295 lines (225 loc) · 8.95 KB
Raw

API Documentation

Documentation complète de l'API Devana.ai pour intégrer l'intelligence artificielle dans vos applications.

Base URL : https://api.devana.ai Authentification : Bearer token (clé API) Format : JSON Protocole : HTTPS uniquement

📑 Table des matières

  1. Authentification
  2. Endpoints
  3. Intégration
  4. Démarrage rapide
  5. Exemples
  6. Gestion des erreurs
  7. Limites et quotas

Authentification

Toutes les requêtes API nécessitent une clé API fournie dans le header Authorization.

Documentation complète : OAuth 2.0

Authorization: Bearer YOUR_API_KEY

Obtenir une clé API :

  1. Créez un compte sur app.devana.ai
  2. Accédez à Paramètres → API
  3. Générez une nouvelle clé API

Endpoints

Agents

Gestion des agents IA

Endpoint Description Documentation
GET /v1/agents Lister tous vos agents agents.md
GET /v1/agents/:id Récupérer un agent spécifique agents.md
POST /v1/agents Créer un nouvel agent agents.md
PUT /v1/agents/:id Mettre à jour un agent agents.md
DELETE /v1/agents/:id Supprimer un agent agents.md
GET /v1/agents/:id/conversations Récupérer les conversations d'un agent agents.md
POST /v1/agents/:id/files Ajouter des fichiers à un agent agents.md
GET /v1/agents/:id/tools Récupérer les tools actifs agents.md

Documentation complète :

Gestion des fichiers

Upload et gestion de documents

Endpoint Description Documentation
POST /api/upload Upload multi-fichiers (jusqu'à 5000) files.md
GET /v1/folders Lister tous les dossiers folders.md
POST /v1/folders Créer un dossier folders.md
GET /v1/documents/:id Récupérer le contenu d'un document documents.md
POST /v1/documents Upload et extraction de document documents.md

Documentation complète :

Conversations & Completions

Génération de texte et gestion des conversations

Endpoint Description Documentation
POST /v1/chat/completions Créer une conversation avec un agent completions.md
GET /v1/conversations Lister les conversations conversations.md
GET /v1/conversations/:id Récupérer une conversation conversations.md
GET /v1/conversations/:id/metrics Métriques détaillées d'une conversation conversations.md
DELETE /v1/conversations/:id Supprimer une conversation conversations.md
POST /v1/interactions Gérer les interactions utilisateur interactions.md

Documentation complète :

Système & Monitoring

Suivi et gestion des tâches asynchrones

Endpoint Description Documentation
GET /v1/jobs Liste et suivi des tâches asynchrones jobs.md

Documentation complète :

  • Jobs API - Monitoring des tâches asynchrones (extraction, embeddings, etc.)

Intégration

Intégrer Devana.ai dans vos applications

  • IFrame Integration - Intégrer Devana.ai directement dans vos pages web
  • IFrame Examples - Exemples concrets d'intégration (chatbot, assistant)
  • Tools - Configuration et utilisation des outils (API calls, webhooks)

Démarrage rapide

Étape 1 : Obtenir une clé API

  1. Créez un compte sur app.devana.ai
  2. Accédez à Paramètres → API
  3. Cliquez sur "Générer une nouvelle clé"
  4. Copiez et conservez votre clé en lieu sûr

Étape 2 : Premier appel API

Lister vos agents :

curl -X GET https://api.devana.ai/v1/agents \
  -H "Authorization: Bearer YOUR_API_KEY"

Réponse :

{
  "success": true,
  "data": [
    {
      "id": "cm123abc",
      "name": "Assistant Support",
      "model": "gpt-4o",
      "publicChat": false
    }
  ]
}

Étape 3 : Créer une conversation

curl -X POST https://api.devana.ai/v1/chat/completions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "agentId": "cm123abc",
    "messages": [
      {"role": "user", "content": "Bonjour, peux-tu m'\''aider ?"}
    ]
  }'

Réponse :

{
  "success": true,
  "data": {
    "id": "conv_abc123",
    "message": "Bonjour ! Bien sûr, je suis là pour vous aider. Que puis-je faire pour vous ?",
    "model": "gpt-4o",
    "tokens": 45,
    "sources": []
  }
}

Exemples

Conversation avec RAG (Retrieval Augmented Generation)

curl -X POST https://api.devana.ai/v1/chat/completions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "agentId": "cm123abc",
    "messages": [
      {"role": "user", "content": "Quelles sont les fonctionnalités principales de notre produit ?"}
    ]
  }'

L'agent utilisera automatiquement les documents de sa base de connaissances pour répondre avec contexte.

Conversation streaming

curl -X POST https://api.devana.ai/v1/chat/completions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "agentId": "cm123abc",
    "messages": [{"role": "user", "content": "Explique-moi l'\''IA"}],
    "stream": true
  }'

Plus d'exemples : completions.md

Gestion des erreurs

Tous les endpoints retournent des codes HTTP standards.

Code Signification Action
200 Succès Requête traitée correctement
400 Bad Request Vérifier le format de la requête
401 Unauthorized Clé API manquante ou invalide
403 Forbidden Accès non autorisé à la ressource
404 Not Found Ressource introuvable
429 Too Many Requests Rate limit dépassé, ralentir les requêtes
500 Internal Server Error Erreur serveur, réessayer plus tard

Format des erreurs :

{
  "success": false,
  "error": {
    "code": "INVALID_AGENT_ID",
    "message": "L'agent spécifié n'existe pas ou vous n'y avez pas accès"
  }
}

Limites et quotas

Rate Limiting

Limites par défaut :

  • 100 requêtes/minute par clé API
  • 10 000 tokens/heure par agent

Headers de réponse :

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 87
X-RateLimit-Reset: 1640995200

Si limite dépassée :

{
  "success": false,
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Trop de requêtes. Veuillez réessayer dans 42 secondes.",
    "retryAfter": 42
  }
}

Quotas

Configurable par agent via l'interface d'administration :

  • Tokens maximum par mois
  • Nombre de fichiers maximum
  • Taille maximale de base de connaissances

Ressources

Support : support-it@devana.ai