OpenAPIとllms.txt
機械可読なAPIの記述。
2つのファイルがAPIを機械可読な形で記述しています：コードジェネレーターとAPIクライアント向けのopenapi.json、AIエージェント向けのllms.txtです。
openapi.json
OpenAPI 3.0形式の仕様は、エンドポイントを主なパラメータ、レスポンス、エラー、認証とともに記述しています。Webhookが配信するイベントも含みます。細部については、このドキュメントが正となります。
URL
https://handelsregister.ai/openapi.json
使い方：
- OpenAPI Generatorなどのジェネレーターで、自分の言語用の型付きクライアントを作成します。
- ファイルをPostman、Insomnia、Brunoにインポートすれば、すぐにすべてのリクエストを使えます。
- エージェントフレームワークは、このファイルから言語モデル用のツール定義を作成します。
ブラウザでURLを開き、ファイルを保存してインポートしてください。
バージョン1の中では、新しいフィールドと値が追加され、既存のものは残ります。クライアントは未知のフィールドを無視するように作ってください。詳しくは変更履歴で。
llms.txt
llms.txtは、言語モデル向けにAPIを短いテキストにまとめたものです：エンドポイント、パラメータ、機能、料金、最も重要なルール。
URL
https://handelsregister.ai/llms.txt
AIエージェントがAPI用のコードを書く前に、このURLを渡してください。そうすれば、実際のパラメータ名とレスポンスのフィールドがわかります。