OpenAPI en llms.txt
Machineleesbare beschrijvingen van de API.
Twee bestanden beschrijven de API machineleesbaar: openapi.json voor codegeneratoren en API-clients, llms.txt voor AI-agents.
openapi.json
De specificatie in OpenAPI 3.0-formaat beschrijft de endpoints met hun belangrijkste parameters, antwoorden, fouten en authenticatie. Ze dekt ook de events die webhooks leveren. Voor elk detail is deze documentatie leidend.
URL
https://handelsregister.ai/openapi.json
Zo gebruik je haar:
- Met een generator zoals OpenAPI Generator maak je een getypeerde client voor je taal.
- Importeer het bestand in Postman, Insomnia of Bruno en je hebt alle aanvragen meteen bij de hand.
- Agentframeworks bouwen uit het bestand tooldefinities voor een taalmodel.
Open de URL in je browser, sla het bestand op en importeer het.
Binnen versie 1 komen er nieuwe velden en waarden bij en blijven bestaande behouden. Bouw je client zo dat hij onbekende velden negeert. Meer in de changelog.
llms.txt
llms.txt vat de API samen als korte tekst voor taalmodellen: endpoints, parameters, features, prijzen en de belangrijkste regels.
URL
https://handelsregister.ai/llms.txt
Geef de URL aan je AI-agent voordat hij code voor de API schrijft. Zo kent hij de echte parameternamen en antwoordvelden.