ナレッジデータストアへAPI経由でデータを入稿する際は、以下のAPIを使用します。
以下のパラメータをJSON形式でリクエストボディに含めて送信します。
パラメータ名 | 型 | 必須 | 説明 |
---|---|---|---|
api_key | string | ○ | APIキーを指定します。公開設定画面でAPI連携を有効にすると取得できます。 |
agent_id | string | ○ | エージェントのIDを指定します。公開設定画面でAPI連携を有効にすると取得できます。 |
label | string | ○ | データのラベルを指定します。 |
既に登録済みのラベルを指定すると、データが更新(上書き)されます。 | |||
text | string | ○ | データの本文を20000文字以内で指定します。 |
url | string | データのソースとなるURLを指定します。 |
<aside> 💡 今後、「id」パラメータが追加され、データのレコードの識別子が扱えるようになる予定です。
</aside>
bashCopy code
curl -X PUT -H "Content-Type: application/json" \\
-d '{"agent_id":"<エージェントのID>","api_key":"<APIキー>","label":"<ラベル>","text":"<本文>"}' \\
<https://api-mebo.dev/datastore/create>
<aside> 💡 APIリクエストを連続で行う場合は、必ず1秒以上のスリープ期間を設けてください。これはAPIの過負荷を防ぐための措置です。
</aside>
<aside> 💡 エージェントID、APIキーは、miiboの公開設定画面からAPIを有効にすることで取得可能です。
https://miibo.dev/admin/publish
</aside>
Status | |
---|---|
200 | 登録成功 |
400 | リクエストに不備がある場合 |
500 | サーバーエラー |