ドキュメントステータスの確認

ナレッジベースに登録されたドキュメントのステータスを確認します。

リクエストメソッド

GET

リクエストURL

https://api-${endpoint}.gptbots.ai/v1/bot/data/detail/list

リクエスト認証

認証方法の説明についてはAPI Overviewをご参照ください。

リクエスト

リクエスト例

curl -X GET https://api-${endpoint}.gptbots.ai/v1/bot/data/detail/list?data_ids=65e18b26e121ab08cefb4a53&data_ids=65e18b26e121ab08cefb4a5333 \ -H 'Authorization: Bearer ${API Key}'

                      
                      curl -X GET https://api-${endpoint}.gptbots.ai/v1/bot/data/detail/list?data_ids=65e18b26e121ab08cefb4a53&data_ids=65e18b26e121ab08cefb4a5333 \ 
-H 'Authorization: Bearer ${API Key}'

このコードブロックをポップアップで表示

リクエストヘッダー

フィールド	タイプ	説明
Authorization	Bearer ${API Key}	認証には `Authorization: Bearer ${API Key}` を使用してください。トークンはAPIキーページから取得できます。

リクエストボディ

Field	タイプ	必須	説明
data_ids	Array	必須	ドキュメントID。複数指定することができます。

レスポンス

レスポンス例

[ { "data_id": "65e18b26e121ab08cefb4a53", "data_status": "AVAILABLE" } ]

                      
                      [
    {
        "data_id": "65e18b26e121ab08cefb4a53",
        "data_status": "AVAILABLE"
    }
]

このコードブロックをポップアップで表示

成功時のレスポンス

フィールド	タイプ	説明
doc	JSON Array	ドキュメント情報です。
data_id	String	ドキュメントのIDです。
data_status	String	ドキュメントのステータスです。

エラー時のレスポンス

フィールド	タイプ	説明
code	int	エラーコード
message	string	エラーの詳細内容

エラーコード

コード	メッセージ
40000	無効なパラメータです
40127	開発者認証に失敗しました
20059	エージェントが削除されています