Skip to main content
GET
/
datasets
/
{dataset_id}
/
documents
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "position": 123,
      "data_source_type": "<string>",
      "data_source_info": {},
      "dataset_process_rule_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "created_from": "<string>",
      "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": 123,
      "tokens": 123,
      "indexing_status": "<string>",
      "error": "<string>",
      "enabled": true,
      "disabled_at": 123,
      "disabled_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "archived": true,
      "display_status": "<string>",
      "word_count": 123,
      "hit_count": 123,
      "doc_form": "<string>"
    }
  ],
  "has_more": true,
  "limit": 123,
  "total": 123,
  "page": 123
}

Authorizations

​
Authorization
string
header
required

API Key authentication. For all API requests, include your API Key in the Authorization HTTP Header, prefixed with 'Bearer '. Example: Authorization: Bearer {API_KEY}. Strongly recommend storing your API Key on the server-side, not shared or stored on the client-side, to avoid possible API-Key leakage that can lead to serious consequences.

Path Parameters

​
dataset_id
string<uuid>
required

The ID of the knowledge base.

Query Parameters

​
keyword
string

Keyword to search for in document names.

​
page
integer
default:1

Page number for pagination.

​
limit
integer
default:20

Number of items to return per page.

Required range: 1 <= x <= 100

Response

200 - application/json

A paginated list of documents.

​
data
object[]
​
has_more
boolean
​
limit
integer
​
total
integer
​
page
integer