API仕様

ナレッジデータストアへAPI経由でデータを削除する際は、以下のAPIを使用します。

リクエスト情報

リクエストパラメータ

以下のパラメータをJSON形式でリクエストボディに含めて送信します。

パラメータ名 必須 説明
api_key string APIキーを指定します。公開設定画面でAPI連携を有効にすると取得できます。
agent_id string エージェントのIDを指定します。公開設定画面でAPI連携を有効にすると取得できます。
label string 削除をするデータのラベルを指定します。

<aside> 💡 今後、「id」パラメータが追加され、データのレコードの識別子が扱えるようになる予定です。

</aside>

Curlコマンドサンプル

bashCopy code
curl -X DELETE -H "Content-Type: application/json" \\
-d '{"agent_id":"<エージェントのID>","api_key":"<APIキー>","label":"<削除するデータのラベル>"}' \\
<https://api-mebo.dev/datastore/delete>

<aside> 💡 APIリクエストを連続で行う場合は、必ず1秒以上のスリープ期間を設けてください。これはAPIの過負荷を防ぐための措置です。

</aside>

<aside> 💡 エージェントID、APIキーは、miiboの公開設定画面からAPIを有効にすることで取得可能です。

https://miibo.dev/admin/publish

</aside>

レスポンスパラメータ

Status
200 登録成功
400 リクエストに不備がある場合
404 削除対象のデータがない場合
※ 今後導入予定のパラメータです。
(現在は、削除対象のデータがなくても200が返ります。)
500 サーバーエラー