API et développeurs

Intégrez EasyRag dans vos applications

Une API REST documentée (OpenAPI), des clés d’API, des réponses avec sources au format JSON et des flux en temps réel.

curl -X POST https://api.exemple.fr/api/v1/chatbots/3f2a…c91e/chat/complete \
  -H "Authorization: Bearer er_••••••••" \
  -H "Content-Type: application/json" \
  -d '{"message": "Quel est le délai de rétractation ?"}'

{
  "response": "Vous disposez de 14 jours… [1]",
  "sessionId": "…",
  "conversationId": "…",
  "sources": [{ "filename": "CGV.pdf", "snippet": "…" }],
  "usage": { "totalTokens": … }
}
Exemple d’appel de l’API (hôte, identifiants et contenu fictifs ; structure de réponse conforme à l’API).

Le problème

Pourquoi c’est utile

Un assistant doit souvent être intégré dans une application métier, un portail existant ou une chaîne d’automatisation, au-delà du widget.

Les équipes techniques ont besoin d’une interface stable, documentée et sécurisée.

En pratique

  1. Créer une cléClé d’API préfixée er_, stockée sous forme d’empreinte, avec expiration facultative.
  2. Appeler l’assistantUne requête POST renvoie la réponse, les sources citées et la consommation de tokens.
  3. ExplorerDocumentation interactive OpenAPI (Swagger) et collection Postman.

Capacités

Ce que vous pouvez faire

Chaque capacité est indiquée avec sa disponibilité réelle.

  • API REST /api/v1 documentée (OpenAPI / Swagger)Disponible
  • Réponse complète en un appel (chat/complete)Réponse texte ou JSON, sources, identifiants de session et de conversation, consommation.Disponible
  • Réponse en flux (Server-Sent Events)Disponible
  • Clés d’API avec expirationDisponible
  • Gestion complète par l’APIAssistants, corpus, documents, outils… selon les droits du propriétaire de la clé.Disponible
  • n8n (modèle fourni) et Power AutomateVia l’API, configuration côté outil d’automatisation.Sur configuration
  • Make, ZapierPas d’intégration native ; possible par appel HTTP générique.Non disponible
  • Clés à portée restreinte (scopes)À l’étude

Bénéfices

Ce que vous y gagnez

Intégrable partout

Toute application capable d’émettre une requête HTTP peut interroger un assistant.

Sources incluses

Les réponses de l’API portent leurs citations, pour un affichage vérifiable.

Automatisable

Création et configuration des assistants scriptables pour vos déploiements.

Prérequis et limites

Prochaine étape

Exemples de requêtes et de réponses commentés.