OpenAPI e llms.txt
Descrizioni dell’API leggibili dalle macchine.
Due file descrivono l’API in forma leggibile dalle macchine: openapi.json per generatori di codice e client API, llms.txt per gli agenti AI.
openapi.json
La specifica in formato OpenAPI 3.0 descrive gli endpoint con i loro parametri principali, risposte, errori e autenticazione. Copre anche gli eventi che i webhook consegnano. Per ogni dettaglio fa fede questa documentazione.
URL
https://handelsregister.ai/openapi.json
Come usarla:
- Con un generatore come OpenAPI Generator crei un client tipizzato per il tuo linguaggio.
- Importa il file in Postman, Insomnia o Bruno e hai subito a portata di mano tutte le richieste.
- I framework per agenti costruiscono dal file le definizioni degli strumenti per un modello linguistico.
Apri l’URL nel browser, salva il file e importalo.
All’interno della versione 1 si aggiungono nuovi campi e valori e quelli esistenti restano. Costruisci il tuo client in modo che ignori i campi sconosciuti. Maggiori dettagli nel changelog.
llms.txt
llms.txt riassume l’API in un breve testo per i modelli linguistici: endpoint, parametri, feature, prezzi e le regole più importanti.
URL
https://handelsregister.ai/llms.txt
Dai l’URL al tuo agente AI prima che scriva codice per l’API. Così conosce i veri nomi dei parametri e i campi della risposta.