APIの利用方法 – AI inside Leapnet

本記事では、Leapnet エージェント作成後に取得できるエンドポイントURLとAPIキーを使用し、外部システムからエージェントへリクエストを送信する方法について説明します。

本記事では、以下の内容について説明します。

エンドポイントURLとAPIキーの確認方法
APIの認証方式
APIリクエストの実行方法

エンドポイントURLとAPIキーの確認方法

Leapnet エージェントの作成完了後、管理画面上に対象エージェント専用の「エンドポイントURL」と「APIキー」が表示されます。これらの情報を使用して、外部システムから対象エージェントへリクエストを送信できます。

API仕様のダウンロード（マークダウンエクスポート）

API仕様をローカルに保存して確認したい場合は、マークダウン形式でエクスポートできます。APIドキュメント右側の「↓」ボタンをクリックして、API仕様をマークダウン形式でダウンロードできます。

ダウンロードファイル名

エージェントID_api_doc.md

認証方式

Leapnet APIでは、「x-api-key」というHTTPヘッダーにAPIキーを設定して認証を行います。すべてのリクエストにおいて、このヘッダーを付与する必要があります。

認証ヘッダーの指定方法

x-api-key: {{API_KEY}}

⚠️ 注意
本APIは Authorization: Bearer 形式の認証には対応していません。
必ず x-api-key ヘッダーを使用してください。

リクエスト例

作成したエージェントの設定に応じて、リクエスト形式はJSON形式またはform-data形式を使用します。

テキストのみのリクエスト：JSON形式
ファイルを含むリクエスト：form-data形式

リクエストボディ (json)

curlコマンド例

curl -X POST "{{エンドポイントURL}}/chat" \
-H "Content-Type: application/json" \
-H "x-api-key: {{API_KEY}}" \
-d '{
    "query": "Leapnetの料金プランについて教えてください。"
}'

※：エンドポイント（例：/chat、/analyze-incident など）は、エージェントの用途や設定によって異なります。利用するエンドポイントは、APIドキュメントをご確認ください。

リクエストボディ (form-data)