Lingara-API-Referenz

Fehler

402application/json

Der Aufruf eines nutzungsbasiert abgerechneten Clients wurde abgelehnt, bevor er etwas verbraucht hat. spend_cap_reached: Der Client oder sein Konto hat sein monatliches Ausgabenlimit erreicht; erhöhe das Limit auf der Seite Integrationen. metered_billing_inactive: Die Nutzungsabrechnung ist für dieses Konto nicht aktiv; richte sie ein oder aktualisiere die Zahlungsmethode auf der Seite Integrationen.

410application/json

Die API-Version, unter der diese Anfrage beantwortet wird, wurde eingestellt. Sende eine unterstützte Version in Lingara-Version oder binde den Client an eine andere Version.

4XXapplication/json

Die Anfrage wurde abgelehnt. code nennt den Grund, und error beschreibt ihn in Worten.

503application/json · text/plain

Der Dienst ist vorübergehend nicht verfügbar; versuche es nach der in Retry-After angegebenen Anzahl Sekunden erneut. Während Wartungsarbeiten ist der Body reiner Text statt des Fehlerumschlags.

5XXapplication/json

Die Anfrage wurde abgelehnt. code nennt den Grund, und error beschreibt ihn in Worten.

codestringerforderlich

Warum die Anfrage abgelehnt wurde, als stabiler Code, nach dem du verzweigen kannst: zum Beispiel insufficient_scope (403), rate_limited (429) und, bei einem nutzungsbasiert abgerechneten Client, spend_cap_reached (402) und metered_billing_inactive (402).

errorstringerforderlich

Vokabeln

Vokabellisten auf dem Niveau eines Lernenden erzeugen.

• Vokabelliste erzeugen POST /v1/vocab/stream

Lektionspläne

Lektionspläne erstellen, lesen und sich erneut mit einem Plan verbinden, der noch erstellt wird.

• Lektionsplan erstellen POST /v1/lesson-plans
• Lektionsplan abrufen GET /v1/lesson-plans/{id}
• Erneut mit einem Lektionsplan verbinden GET /v1/lesson-plans/{id}/stream

Tutor

Ein Gespräch mit dem Sprachtutor führen, Zug um Zug.

• Tutor-Zug senden POST /v1/tutor/message

Ereignisse

Lesen Sie die Ereignisse in Ihrem Konto, seitenweise oder als Stream.

• Ereignisse auflisten GET /v1/events
• Ereignis senden POST /v1/events
• Ereignisse streamen GET /v1/events/stream

Konto

Sehen, wie viel von deinem Kontingent noch übrig ist.

• Verbleibendes Kontingent abrufen GET /v1/usage

Referenz

Dieses Dokument in maschinenlesbarer Form.

• Dieses Dokument abrufen GET /v1/openapi.json
• Das Ereignisdokument abrufen GET /v1/asyncapi.json
• API-Versionen auflisten GET /v1/versions
• Eine API-Version abrufen GET /v1/versions/{id}

Ereigniskatalog

Lingara erfasst als Ereignisse, was mit den Lektionsplänen und der Nutzung deines Kontos geschieht, und nimmt Ereignisse von deinem Spiel oder deiner App entgegen. Jedes Ereignis hat, egal auf welchem Weg es kommt, dieselbe Hülle, und der Ereigniskatalog listet sie alle auf. Webhooks und Ereignisse

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

• Du → Lingara world.context_changed
• Du → Lingara world.practice_requested