OpenAPI i llms.txt
Opisy API czytelne dla maszyn.
Dwa pliki opisują API w formie czytelnej dla maszyn: openapi.json dla generatorów kodu i klientów API, llms.txt dla agentów AI.
openapi.json
Specyfikacja w formacie OpenAPI 3.0 opisuje endpointy z głównymi parametrami, odpowiedziami, błędami i uwierzytelnianiem. Obejmuje też zdarzenia dostarczane przez webhooki. We wszystkich szczegółach rozstrzyga ta dokumentacja.
URL
https://handelsregister.ai/openapi.json
Jak z niej korzystać:
- Generatorem, np. OpenAPI Generator, tworzysz typowanego klienta dla swojego języka.
- Zaimportuj plik do Postmana, Insomnii lub Bruno i od razu masz wszystkie zapytania pod ręką.
- Frameworki agentów budują z pliku definicje narzędzi dla modelu językowego.
Otwórz URL w przeglądarce, zapisz plik i go zaimportuj.
W wersji 1 nowe pola i wartości dochodzą, a istniejące zostają. Zbuduj klienta tak, by ignorował nieznane pola. Więcej w changelogu.
llms.txt
llms.txt podsumowuje API jako krótki tekst dla modeli językowych: endpointy, parametry, features, ceny i najważniejsze zasady.
URL
https://handelsregister.ai/llms.txt
Podaj URL swojemu agentowi AI, zanim napisze kod dla API. Wtedy zna prawdziwe nazwy parametrów i pola odpowiedzi.