Aller au contenu principal
Retour

API REST

Intégrez AI ARTEDUSA à vos outils existants via notre API REST : endpoints disponibles, authentification JWT, exemples de code et limites.

PRÉSENTATION DE L'API

AI ARTEDUSA expose une API REST construite avec FastAPI, vous permettant d'intégrer votre centre d'appels IA à vos outils existants. Le schéma OpenAPI décrit l'ensemble des endpoints.

L'API utilise le format JSON pour les requêtes et les réponses, avec des codes de statut HTTP standard.

AUTHENTIFICATION

L'API s'authentifie via le jeton de session :

  • JWT de session : incluez le jeton dans l'en-tête Authorization: Bearer <token>. Ce jeton, obtenu lors de la connexion, authentifie toutes vos requêtes.

ENDPOINTS PRINCIPAUX

Voici les catégories d'endpoints disponibles :

  • GET /api/v1/tenants/{tenant_id}/calls : liste des appels (pagination + filtres canal/dates/recherche)
  • GET /api/v1/tenants/{tenant_id}/calls/{call_id} : détail d'un appel (transcription, synthèse, métadonnées)
  • GET /api/v1/tenants/{tenant_id}/knowledge : liste des documents de la base de connaissances
  • POST /api/v1/tenants/{tenant_id}/knowledge : ajouter un document
  • DELETE /api/v1/tenants/{tenant_id}/knowledge/{item_id} : supprimer un document
  • POST /api/v1/tenants/{tenant_id}/knowledge/sync : lancer la synchronisation de la base de connaissances
  • GET /api/v1/ai-agents/{agent_id} : récupérer la configuration du bot
  • PUT /api/v1/ai-agents/{agent_id} : modifier la configuration du bot

LIMITES ET BONNES PRATIQUES

L'API est soumise à des limites de débit (rate limiting) pour garantir la stabilité du service :

  • 200 requêtes par minute par tenant sur les endpoints appels et base de connaissances
  • 100 requêtes par minute (par adresse IP) sur les endpoints de configuration (ai-agents, workspace)
  • 10 téléversements de documents par minute
  • Les requêtes excédentaires reçoivent une réponse 429 (Too Many Requests)

Questions fréquentes

EXISTE-T-IL DES SDK DANS DIFFÉRENTS LANGAGES ?

Nous ne fournissons pas encore de SDK officiel. Le schéma OpenAPI de l'API permet de générer un client dans le langage de votre choix (Python, JavaScript, etc.) avec les outils habituels.

L'API EST-ELLE VERSIONNÉE ?

Oui, l'API est versionnée (actuellement v1). Les changements majeurs seront introduits dans de nouvelles versions, et les versions précédentes resteront supportées pendant au moins 6 mois.

Conseil : l'API est versionnée (v1) et scoped par établissement — indiquez toujours l'identifiant de votre établissement (tenant_id) dans le chemin des requêtes.