Référence de l'API Lingara

Erreurs

402application/json

L'appel d'un client facturé à l'usage a été refusé avant qu'il ne dépense quoi que ce soit. spend_cap_reached : le client ou son compte a atteint sa limite de dépenses mensuelle ; relevez la limite sur la page Intégrations. metered_billing_inactive : la facturation à l'usage n'est pas active pour ce compte ; configurez-la ou mettez à jour le moyen de paiement sur la page Intégrations.

410application/json

La version de l'API sous laquelle cette requête est traitée a été retirée. Envoyez une version prise en charge dans Lingara-Version, ou rattachez le client à une autre version.

4XXapplication/json

La requête a été refusée. code indique pourquoi, et error l'explique en toutes lettres.

503application/json · text/plain

Le service est temporairement indisponible ; réessayez après le nombre de secondes indiqué dans Retry-After. Pendant la maintenance, le corps est du texte brut plutôt que l'enveloppe d'erreur.

5XXapplication/json

La requête a été refusée. code indique pourquoi, et error l'explique en toutes lettres.

codestringobligatoire

Pourquoi la requête a été refusée, sous forme de code stable sur lequel brancher votre logique : par exemple insufficient_scope (403), rate_limited (429) et, pour un client facturé à l'usage, spend_cap_reached (402) et metered_billing_inactive (402).

errorstringobligatoire

Vocabulaire

Générer des listes de vocabulaire adaptées au niveau d'un apprenant.

• Générer une liste de vocabulaire POST /v1/vocab/stream

Plans de leçon

Créer des plans de leçon, les consulter et se reconnecter à un plan encore en cours de génération.

• Créer un plan de leçon POST /v1/lesson-plans
• Obtenir un plan de leçon GET /v1/lesson-plans/{id}
• Se reconnecter à un plan de leçon GET /v1/lesson-plans/{id}/stream

Tuteur

Mener une conversation avec le tuteur de langue, un tour à la fois.

• Envoyer un tour au tuteur POST /v1/tutor/message

Événements

Lisez les événements qui se produisent dans votre compte, page par page ou en flux.

• Lister les événements GET /v1/events
• Envoyer un événement POST /v1/events
• Diffuser les événements GET /v1/events/stream

Compte

Voir ce qu'il reste de votre quota.

• Obtenir votre quota restant GET /v1/usage

Référence

Ce document, sous une forme lisible par machine.

• Obtenir ce document GET /v1/openapi.json
• Obtenir le document des événements GET /v1/asyncapi.json
• Lister les versions de l'API GET /v1/versions
• Obtenir une version de l'API GET /v1/versions/{id}

Catalogue des événements

Lingara enregistre sous forme d'événements ce qui arrive aux plans de leçon et à l'utilisation de votre compte, et accepte les événements de votre jeu ou de votre application. Chaque événement, quel que soit son mode de transmission, a la même enveloppe, et le catalogue des événements les liste tous. Webhooks et événements

• Lingara → vous lesson_plan.ready
• Lingara → vous lesson_plan.failed
• Lingara → vous usage.threshold_reached
• Lingara → vous webhook.test
• Lingara → vous app.installed
• Lingara → vous app.uninstalled

• Vous → Lingara world.context_changed
• Vous → Lingara world.practice_requested