OpenAPI e llms.txt

Descrições da API legíveis por máquina.

Dois arquivos descrevem a API de forma legível por máquina: openapi.json para geradores de código e clientes de API, llms.txt para agentes de IA.

openapi.json

A especificação no formato OpenAPI 3.0 descreve os endpoints com seus principais parâmetros, respostas, erros e autenticação. Ela também cobre os eventos que os webhooks entregam. Para todos os detalhes, esta documentação é a referência.

URL

https://handelsregister.ai/openapi.json

Como usar:

Com um gerador como o OpenAPI Generator, você cria um cliente tipado para a sua linguagem.
Importe o arquivo no Postman, Insomnia ou Bruno e você tem todas as requisições à mão na hora.
Frameworks de agentes criam definições de ferramentas para um modelo de linguagem a partir do arquivo.

Abra a URL no navegador, salve o arquivo e importe-o.

Dentro da versão 1, novos campos e valores são acrescentados e os existentes ficam. Construa seu cliente de modo que ele ignore campos desconhecidos. Mais no changelog.

llms.txt

llms.txt resume a API como um texto curto para modelos de linguagem: endpoints, parâmetros, recursos, preços e as regras mais importantes.

URL

https://handelsregister.ai/llms.txt

Passe a URL ao seu agente de IA antes que ele escreva código para a API. Assim ele conhece os nomes reais dos parâmetros e os campos da resposta.

Plugin do ChatGPT e MCP Quando o seu agente de IA deve consultar os dados por conta própria. Changelog O que muda na API e como ela evolui.