logo
Development
Search
Query Doc Status

Query Doc Status

Query the status of the knowledge base document.

Request Method

GET

Request URL

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

Request Authentication

See Overview for authentication details.

Request

Request Example

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}'

                    
This code block in the floating window

Request Headers

Field Type Description
Authorization Bearer ${API Key} Use Authorization: Bearer ${API Key} for authentication. Get API key from API Key page.

Request Parameters

Field Type Required Description
data_ids array Yes Document ID, multiple can be submitted.

Response

Response Example

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

                    
This code block in the floating window

Success Response

Field Type Description
doc JSON Array Doc info.
data_id string Doc id.
data_status string Doc status.

Failure Response

Field Type Description
code int Error code.
message string Error details.

Error Codes

Code Message
40000 Invalid parameter
40127 Developer authentication failed
20059 Agent deleted