OpenAPI och llms.txt
Maskinläsbara beskrivningar av API:et.
Två filer beskriver API:et i maskinläsbar form: openapi.json för kodgeneratorer och API-klienter, llms.txt för AI-agenter.
openapi.json
Specifikationen i formatet OpenAPI 3.0 beskriver endpoints med sina viktigaste parametrar, svar, fel och autentisering. Den omfattar även de händelser som webhooks levererar. För varje detalj är denna dokumentation avgörande.
URL
https://handelsregister.ai/openapi.json
Så använder du den:
- Med en generator som OpenAPI Generator skapar du en typad klient för ditt språk.
- Importera filen till Postman, Insomnia eller Bruno så har du alla förfrågningar till hands direkt.
- Agentramverk bygger verktygsdefinitioner för en språkmodell ur filen.
Öppna URL:en i webbläsaren, spara filen och importera den.
Inom version 1 tillkommer nya fält och värden, och befintliga finns kvar. Bygg din klient så att den ignorerar okända fält. Mer i changelog.
llms.txt
llms.txt sammanfattar API:et som en kort text för språkmodeller: endpoints, parametrar, funktioner, priser och de viktigaste reglerna.
URL
https://handelsregister.ai/llms.txt
Ge URL:en till din AI-agent innan den skriver kod för API:et. Då känner den till de riktiga parameternamnen och svarsfälten.