OpenAPI a llms.txt
Strojově čitelné popisy API.
API ve strojově čitelné podobě popisují dva soubory: openapi.json pro generátory kódu a API klienty, llms.txt pro AI agenty.
openapi.json
Specifikace ve formátu OpenAPI 3.0 popisuje endpointy s hlavními parametry, odpověďmi, chybami a autentizací. Pokrývá i události, které doručují webhooky. Pro každý detail je rozhodující tato dokumentace.
URL
https://handelsregister.ai/openapi.json
Jak ji použít:
- Generátorem jako OpenAPI Generator vytvoříš typovaného klienta pro svůj jazyk.
- Importuj soubor do Postmanu, Insomnie nebo Bruna a máš hned po ruce všechny požadavky.
- Agentní frameworky ze souboru sestaví definice nástrojů pro jazykový model.
Otevři URL v prohlížeči, ulož soubor a importuj ho.
V rámci verze 1 přibývají nová pole a hodnoty a stávající zůstávají. Postav svého klienta tak, aby neznámá pole ignoroval. Více v changelogu.
llms.txt
llms.txt shrnuje API jako krátký text pro jazykové modely: endpointy, parametry, funkce, ceny a nejdůležitější pravidla.
URL
https://handelsregister.ai/llms.txt
Dej URL svému AI agentovi dřív, než začne psát kód pro API. Bude tak znát skutečné názvy parametrů a pole odpovědí.