Skip to content

agents.md

Latest commit

 

History

History
419 lines (384 loc) · 11.7 KB

agents.md

File metadata and controls

419 lines (384 loc) · 11.7 KB
Raw

API Agents

Documentation des endpoints pour la gestion des agents IA.

Base URL : https://api.devana.ai

📑 Table des matières

  1. Authentification
  2. Endpoints disponibles
  3. Récupérer la liste des agents
  4. Récupérer un agent (basique)
  5. Récupérer un agent (détaillé)
  6. Créer un agent
  7. Mettre à jour un agent
  8. Supprimer un agent
  9. Récupérer les conversations
  10. Ajouter des fichiers
  11. Récupérer les tools

Authentification

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

Authorization: Bearer YOUR_API_KEY

Plus d'informations : OAuth 2.0

Endpoints disponibles

Méthode Endpoint Description
GET /v1/agents Liste tous les agents
GET /v1/agents/:id Récupère un agent spécifique (informations basiques)
GET /v1/agent/:id Récupère un agent spécifique (informations détaillées)
POST /v1/agents Crée un nouvel agent
PUT /v1/agents/:id Met à jour un agent
DELETE /v1/agents/:id Supprime un agent
GET /v1/agents/:id/conversations Liste les conversations d'un agent
POST /v1/agents/:id/files Ajoute des fichiers à un agent
GET /v1/agents/:id/tools Liste les tools actifs

Endpoints

v1/agents

Récupérer la liste des agents

  • URL : GET /v1/agents
  • Description : Retourne la liste des agents associés à l'utilisateur.
  • Réponse : 
    {
  "success": true,
  "data": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "chatVersion": "string",
      "folderBaseId": "string",
      "model": "string",
      "publicChat": "boolean",
      "createdAt": "timestamp",
      "updatedAt": "timestamp",
      "folderIds": ["string"],
      "maxFiles": "number"
    }
  ]
}
  • Erreurs possibles :
    • 500 : Erreur interne du serveur.

Récupérer un agent

  • URL : GET /v1/agents/:id
  • Paramètres :
    • id : Identifiant unique de l'agent.
  • Description : Retourne les informations d'un agent spécifique.
  • Réponse : 
    {
  "success": true,
  "data": {
    "id": "string",
    "name": "string",
    "description": "string",
    "chatVersion": "string",
    "folderBaseId": "string",
    "model": "string",
    "publicChat": "boolean",
    "createdAt": "timestamp",
    "updatedAt": "timestamp",
    "folderIds": ["string"],
    "maxFiles": "number"
  }
}
  • Erreurs possibles :
    • 400 : Requête invalide.
    • 403 : Accès non autorisé.
    • 404 : Agent non trouvé.
    • 500 : Erreur interne du serveur.

Récupérer un agent (détaillé)

  • URL : GET /v1/agent/:id
  • Paramètres :
    • id : Identifiant unique de l'agent (CUID).
  • Description : Retourne les informations détaillées et complètes d'un agent spécifique, incluant toutes les propriétés de configuration.
  • Note : Cet endpoint diffère de /v1/agents/:id en retournant l'ensemble des propriétés de l'agent, y compris les paramètres avancés de configuration.
  • Réponse : 
    {
  "success": true,
  "data": {
    "id": "string",
    "name": "string",
    "description": "string",
    "chatVersion": "string",
    "model": "string",
    "publicChat": "boolean",
    "createdAt": "timestamp",
    "updatedAt": "timestamp",
    "folderBaseId": "string",
    "folderIds": ["string"],
    "backgroundColor": "string",
    "textColor": "string",
    "iaType": "string",
    "connectWeb": "boolean",
    "freeLevel": "string",
    "showSources": "boolean",
    "suggestions": ["string"],
    "chappieMode": "boolean",
    "minimumTools": "number",
    "maxTokensMonth": "number",
    "maxContextTokens": "number",
    "alertTokensMonth": "number",
    "overrideUrl": "string",
    "iaIdentity": "string",
    "welcomeMessage": "string",
    "target": "string",
    "customModelId": "string",
    "embedModel": "string",
    "attachedAgents": ["string"],
    "temperature": "number",
    "fullTextMode": "boolean"
  }
}
  • Propriétés supplémentaires retournées :
    • backgroundColor : Couleur de fond pour l'interface
    • textColor : Couleur du texte pour l'interface
    • iaType : Type d'IA (standard, custom, etc.)
    • connectWeb : Autorisation de connexion web
    • freeLevel : Niveau gratuit de l'agent
    • showSources : Affichage des sources dans les réponses
    • suggestions : Suggestions prédéfinies
    • chappieMode : Mode Chappie activé/désactivé
    • minimumTools : Nombre minimum d'outils
    • maxTokensMonth : Limite mensuelle de tokens
    • maxContextTokens : Limite de tokens de contexte
    • alertTokensMonth : Seuil d'alerte pour les tokens
    • overrideUrl : URL de surcharge
    • iaIdentity : Identité/personnalité de l'IA
    • welcomeMessage : Message de bienvenue
    • target : Cible/objectif de l'agent
    • customModelId : ID du modèle personnalisé
    • embedModel : Modèle d'embedding utilisé
    • attachedAgents : Agents attachés
    • temperature : Température du modèle (créativité)
    • fullTextMode : Mode texte complet activé/désactivé
  • Erreurs possibles :
    • 400 : Requête invalide (ID doit être un CUID valide).
    • 403 : Accès non autorisé à cet agent.
    • 404 : Agent non trouvé.
    • 500 : Erreur interne du serveur.

Créer un agent

  • URL : POST /v1/agents
  • Description : Crée un nouvel agent.
  • Body : 
    {
  "name": "string",
  "description": "string" | null,
  "model": "string" | null,
  "publicChat": "boolean" | null,
  "iaIdentity": "string" | null,
  "welcomeMessage": "string" | null,
  "target": "string" | null,
  "customModelId": "string" | null,
  "embedModel": "string" | null,
  "folderIds": ["string"] | null,
  "attachedAgents": ["string"] | null,
  "backgroundColor": "string" | null,
  "textColor": "string" | null,
  "iaType": "string" | null,
  "connectWeb": "boolean" | null,
  "freeLevel": "string" | null,
  "showSources": "boolean" | null,
  "suggestions": ["string"] | null,
  "chappieMode": "boolean" | null,
  "minimumTools": "number" | null,
  "maxTokensMonth": "number" | null,
  "maxContextTokens": "number" | null,
  "alertTokensMonth": "number" | null,
  "overrideUrl": "string" | null,
  "maxFiles": "number" | null
}
  • Réponse : 
    {
  "success": true,
  "data": {
    "id": "string",
    "name": "string",
    "description": "string",
    "chatVersion": "string",
    "folderBaseId": "string",
    "model": "string",
    "publicChat": "boolean",
    "createdAt": "timestamp",
    "updatedAt": "timestamp",
    "folderIds": ["string"],
    "maxFiles": "number"
  }
}
  • Erreurs possibles :
    • 400 : Requête invalide.
    • 500 : Erreur interne du serveur.

Mettre à jour un agent

  • URL : PUT /v1/agents/:id
  • Paramètres :
    • id : Identifiant unique de l'agent.
  • Body : 
    {
  "name": "string" | null,
  "description": "string" | null,
  "model": "string" | null,
  "publicChat": "boolean" | null,
  "iaIdentity": "string" | null,
  "welcomeMessage": "string" | null,
  "target": "string" | null,
  "customModelId": "string" | null,
  "embedModel": "string" | null,
  "folderIds": ["string"] | null,
  "attachedAgents": ["string"] | null,
  "backgroundColor": "string" | null,
  "textColor": "string" | null,
  "iaType": "string" | null,
  "connectWeb": "boolean" | null,
  "freeLevel": "string" | null,
  "showSources": "boolean" | null,
  "suggestions": ["string"] | null,
  "chappieMode": "boolean" | null,
  "minimumTools": "number" | null,
  "maxTokensMonth": "number" | null,
  "maxContextTokens": "number" | null,
  "alertTokensMonth": "number" | null,
  "overrideUrl": "string" | null,
  "maxFiles": "number" | null
}
  • Réponse : 
    {
  "success": true,
  "data": {
    "id": "string",
    "name": "string",
    "description": "string",
    "chatVersion": "string",
    "folderBaseId": "string",
    "model": "string",
    "publicChat": "boolean",
    "createdAt": "timestamp",
    "updatedAt": "timestamp",
    "folderIds": ["string"],
    "maxFiles": "number"
  }
}
  • Erreurs possibles :
    • 400 : Requête invalide.
    • 403 : Accès non autorisé.
    • 500 : Erreur interne du serveur.

Supprimer un agent

  • URL : DELETE /v1/agents/:id
  • Paramètres :
    • id : Identifiant unique de l'agent.
  • Réponse : 
    {
  "success": true,
  "data": {
    "message": "string"
  }
}
  • Erreurs possibles :
    • 400 : Requête invalide.
    • 403 : Accès non autorisé.
    • 500 : Erreur interne du serveur.

Récupérer les conversations d'un agent

  • URL : GET /v1/agents/:id/conversations
  • Paramètres :
    • id : Identifiant unique de l'agent.
  • Description : Retourne les conversations associées à un agent spécifique.
  • Réponse : 
    {
  "success": true,
  "data": [
    {
      "id": "string",
      "date": "timestamp",
      "message": "string",
      "model": "string"
    }
  ]
}
  • Erreurs possibles :
    • 400 : Requête invalide.
    • 403 : Accès non autorisé.
    • 404 : Agent non trouvé.
    • 500 : Erreur interne du serveur.

Ajouter des fichiers à un agent

  • URL : POST /v1/agents/:id/files
  • Paramètres :
    • id : Identifiant unique de l'agent.
  • Body : 
    {
  "filesIds": ["string"]
}
  • Réponse : 
    {
  "success": true,
  "data": ["string"]
}
  • Erreurs possibles :
    • 400 : Requête invalide.
    • 403 : Accès non autorisé.
    • 404 : Agent non trouvé.
    • 500 : Erreur interne du serveur.

Récupérer les tools actifs sur un agent

  • URL : GET /v1/agents/:id/tools
  • Paramètres :
    • id : Identifiant unique de l'agent.
  • Réponse : 
    {
  "success": true,
  "data": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "url": "string",
      "method": "string",
      "advanced": "boolean",
      "authorization": "string",
      "authorizationKeyParams": "string",
      "authorizationType": "string",
      "execConfirmation": "boolean",
      "isPublic": "boolean",
      "schema": {
        "arguments": [
          {
            "name": "string",
            "type": "string",
            "nullable": "boolean",
            "description": "string"
          }
        ]
      },
      "createdAt": "string",
      "updatedAt": "string"
    }
  ]
}
  • Erreurs possibles :
    • 400 : Requête invalide.
    • 401 : Authentification manquante.
    • 403 : Accès non autorisé.
    • 500 : Erreur interne du serveur.