Octri: API-Dokumentation erstellen, SDKs und MCP

Eine API-Spezifikation als Grundlage für Dokumentation, SDKs und Agenten.

octri.dev
Octri screenshot

Octri hilft API-Teams, aus einer gemeinsamen Spezifikation lesbare Dokumentation und installierbare Client-Bibliotheken zu erstellen. MCP-Zugriff und Monitoring ergänzen den Ablauf von der Beschreibung bis zum Betrieb.

Was macht Octri? Einfach erklärt

Eine API-Spezifikation beschreibt, welche Aufrufe ein Dienst annimmt und welche Daten er zurückgibt. Octri macht daraus eine Website für Menschen, SDKs für Programme und Werkzeuge für KI-Assistenten. Das Monitoring zeigt anschließend, wo Aufrufe oder Clients Probleme verursachen.

Die Plattform passt zu SaaS-Anbietern und Teams, die ihre API für mehrere Entwicklergruppen bereitstellen. Eine funktionierende API und die Prüfung der erzeugten Inhalte bleiben erforderlich. Die vier Module müssen nicht alle gleichzeitig aktiviert werden.

Eine Dokumentation erstellen, prüfen und aktuell halten

API Studio erzeugt Referenzseiten mit Parametern, verschachtelten Schemas und Anfragebeispielen. Die Texte lassen sich direkt bearbeiten. Für Einstieg, Authentifizierung oder mehrstufige Integrationen können eigene MDX-Anleitungen neben der Referenz stehen.

  1. Lade die Spezifikation hoch oder verbinde das GitHub-Repository.
  2. Prüfe Operationsnamen, Authentifizierung und Ein- sowie Ausgabeschemas.
  3. Erzeuge die Dokumentation und korrigiere die Erklärungen anhand der tatsächlichen API.
  4. Teste einen erfolgreichen Aufruf und eine Fehlerantwort in der eingebauten Konsole.
  5. Konfiguriere Veröffentlichung und gegebenenfalls SDKs; kontrolliere Entwurf und Änderungen vor der Freigabe.

Die Konsole sendet Anfragen aus dem Browser des Lesers. Entsprechend müssen die CORS-Regeln der API passen. GitHub-Synchronisierung kann einen Neubau anstoßen; neue SDK-Versionen werden laut offizieller Beschreibung erst nach Freigabe veröffentlicht.

SDKs für verschiedene Nutzergruppen

SDK Studio unterstützt TypeScript, Python, Go, Java, Kotlin, Ruby, PHP, Rust, Swift und Dart. Methodennamen, ausgeschlossene Endpunkte und sprachspezifische Einstellungen lassen sich vor dem Build festlegen. Anschließend können Pakete über die passenden Registries verteilt werden.

Die zehn Sprachen beschreiben den Gesamtumfang der Plattform, nicht den kostenlosen Tarif. Individueller SDK-Code ist ab Growth vorgesehen. Für produktive Integrationen sollte das Team besonders Authentifizierung und ungewöhnliche Antwortmodelle praktisch prüfen.

Kostenlose Nutzung und kostenpflichtige Grenzen

Stand 6. Oktober 2026 nennt die Website folgende monatliche US-Dollar-Preise; bezahlte Tarife verstehen sich zuzüglich Steuern, nicht als Euro-Angebot:

  • Free: ein Projekt, eine SDK-Sprache, 50 Endpunkte, 100 MB Monitoring pro Monat und einmalig 100 KI-Credits.
  • Starter: 49 US-Dollar, zwei SDK-Sprachen.
  • Growth: 99 US-Dollar, vier Sprachen sowie Versionierung und eigener Code beziehungsweise Komponenten.
  • Business: 249 US-Dollar, alle zehn Sprachen und White-Label.
  • Enterprise: individuelles Angebot; Generator und Dokumentationsrenderer können auf eigener Infrastruktur laufen.

Die Generierung eines Endpunkttexts oder eine Antwort von Ask-the-docs kostet jeweils einen Credit. Manuelles Bearbeiten, SDK-Builds und Hosting gehören nicht zu diesem Creditsystem. Der offizielle Tarifvergleich enthält weitere Mengenlimits und Zusatzoptionen.

Eine eigene Domain und die GitHub-Synchronisierung sind auch im Free-Tarif enthalten.

Dokumentation und ausführbare API-Werkzeuge über MCP

Sieben Dokumentationswerkzeuge liefern veröffentlichten Inhalt an MCP-Clients wie Claude oder Cursor. Zusätzlich können ausgewählte Endpunkte ausführbar werden. Für das Lesen genügt die Projekt-ID; API-Aufrufe benötigen passende Zugangsdaten, die auf dem Rechner des MCP-Servers verbleiben. Zielumgebung, Berechtigungen und ausgeschlossene Operationen sollten bewusst gewählt werden.

Monitoring und Verarbeitung vertraulicher Daten

Monitoring ist zunächst deaktiviert und kann Daten aus generierten SDKs oder Backend-Paketen empfangen. Logs, gruppierte Fehler, Traces, Verfügbarkeitsprüfungen und Alarme unterstützen die Fehlersuche. Octri beschreibt eine Maskierung sensibler Informationen vor dem Versand und beim Empfang.

Laut Datenschutzerklärung werden relevante Spezifikationsinhalte zur Texterzeugung an KI-Anbieter gesendet. Fragen samt passenden Textstellen dienen der Dokumentationsantwort, Dokumenttexte außerdem dem Suchindex. Die Inhalte werden nach offizieller Aussage nicht zum Modelltraining verwendet. Das bedeutet jedoch keine ausschließlich lokale Verarbeitung.

Häufige Fragen

Welche Dateiformate unterstützt Octri?

Genannt werden OpenAPI 3.0/3.1, Swagger 2.0, Postman und AsyncAPI in JSON oder YAML. Nach dem Import sollten konvertierte Modelle kontrolliert werden.

Was bleibt nach Verbrauch der KI-Credits nutzbar?

Veröffentlichte Dokumentation, SDK-Builds und Monitoring laufen weiter. KI-Generierung und Ask-the-docs pausieren; die 100 kostenlosen Credits werden nicht monatlich erneuert.

Gehen eigene Texte bei Updates verloren?

Octri speichert manuelle Feldänderungen getrennt und behält sie bei der Regenerierung bei. Unbearbeitete generierte Felder können aktualisiert werden.

Offizielle Ressourcen