OpenAPI und llms.txt
Maschinenlesbare Beschreibungen der API.
Zwei Dateien beschreiben die API in maschinenlesbarer Form: openapi.json für Codegeneratoren und API-Clients, llms.txt für KI-Agenten.
openapi.json
Die Spezifikation im Format OpenAPI 3.0 beschreibt die Endpunkte mit ihren wichtigsten Parametern, Antworten, Fehlern und der Anmeldung. Dazu kommen die Ereignisse, die Webhooks zustellen. Maßgeblich für jedes Detail ist diese Dokumentation.
https://handelsregister.ai/openapi.json
So nutzt du sie:
- Mit einem Generator wie OpenAPI Generator erzeugst du einen typisierten Client für deine Sprache.
- In Postman, Insomnia oder Bruno importierst du die Datei und hast alle Anfragen sofort zur Hand.
- Agenten-Frameworks bauen aus der Datei Tool-Definitionen für ein Sprachmodell.
Öffne die Adresse im Browser, speichere die Datei und importiere sie.
llms.txt
llms.txt fasst die API als kurzen Text für Sprachmodelle zusammen: Endpunkte, Parameter, Features, Preise und die wichtigsten Regeln.
https://handelsregister.ai/llms.txt
Gib die Adresse deinem KI-Agenten, bevor er Code für die API schreibt. So kennt er die echten Parameternamen und Antwortfelder.