Skip to main content
GET
List Documents

Authorizations

Authorization
string
header
required

Every request authenticates with an API key: Authorization: Bearer {API_KEY}. App endpoints take an app API key; knowledge endpoints take a knowledge base API key (Get Started).

Keep keys server-side; never embed them in client code. Requests with a missing or invalid key fail with HTTP 401 (unauthorized).

Path Parameters

dataset_id
string<uuid>
required

Knowledge base ID. From List Knowledge Bases.

Query Parameters

page
integer
default:1

Page number.

limit
integer
default:20

Number of items per page. Server caps at 100.

keyword
string

Search keyword to filter by document name.

status
enum<string>

Filter by display status.

Available options:
queuing,
indexing,
paused,
error,
available,
disabled,
archived

Response

List of documents.

data
object[]

Array of document objects.

has_more
boolean

Whether more items exist on the next page.

limit
integer

Number of items per page.

total
integer

Total number of matching items.

page
integer

Current page number.