List Documents

GET

datasets

{dataset_id}

documents

List Documents

curl --request GET \
  --url https://{api_base_url}/datasets/{dataset_id}/documents \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{api_base_url}/datasets/{dataset_id}/documents', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{api_base_url}/datasets/{dataset_id}/documents",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{api_base_url}/datasets/{dataset_id}/documents"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{api_base_url}/datasets/{dataset_id}/documents")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "a8e0e5b5-78c6-4130-a5ce-25feb0e0b4ac",
      "position": 1,
      "data_source_type": "upload_file",
      "data_source_info": {
        "upload_file_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
      },
      "data_source_detail_dict": {
        "upload_file": {
          "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
          "name": "guide.txt",
          "size": 2048,
          "extension": "txt",
          "mime_type": "text/plain",
          "created_by": "ad313dd6-ef04-4dd1-a5b0-c0f0b9e2e7e4",
          "created_at": 1741267200
        }
      },
      "dataset_process_rule_id": "e1f2a3b4-c5d6-7890-ef12-345678901234",
      "name": "guide.txt",
      "created_from": "api",
      "created_by": "ad313dd6-ef04-4dd1-a5b0-c0f0b9e2e7e4",
      "created_at": 1741267200,
      "tokens": 512,
      "indexing_status": "completed",
      "error": null,
      "enabled": true,
      "disabled_at": null,
      "disabled_by": null,
      "archived": false,
      "display_status": "available",
      "word_count": 350,
      "hit_count": 0,
      "doc_form": "text_model",
      "doc_metadata": [],
      "summary_index_status": null,
      "need_summary": false
    }
  ],
  "has_more": false,
  "limit": 20,
  "total": 1,
  "page": 1
}

{
  "status": 403,
  "code": "forbidden",
  "message": "Dataset api access is not enabled."
}

{
  "status": 404,
  "code": "not_found",
  "message": "Dataset not found."
}

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.

Show child attributes

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.

Last modified on August 10, 2026

List Documents

curl --request GET \
  --url https://{api_base_url}/datasets/{dataset_id}/documents \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{api_base_url}/datasets/{dataset_id}/documents', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{api_base_url}/datasets/{dataset_id}/documents",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{api_base_url}/datasets/{dataset_id}/documents"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{api_base_url}/datasets/{dataset_id}/documents")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "a8e0e5b5-78c6-4130-a5ce-25feb0e0b4ac",
      "position": 1,
      "data_source_type": "upload_file",
      "data_source_info": {
        "upload_file_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
      },
      "data_source_detail_dict": {
        "upload_file": {
          "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
          "name": "guide.txt",
          "size": 2048,
          "extension": "txt",
          "mime_type": "text/plain",
          "created_by": "ad313dd6-ef04-4dd1-a5b0-c0f0b9e2e7e4",
          "created_at": 1741267200
        }
      },
      "dataset_process_rule_id": "e1f2a3b4-c5d6-7890-ef12-345678901234",
      "name": "guide.txt",
      "created_from": "api",
      "created_by": "ad313dd6-ef04-4dd1-a5b0-c0f0b9e2e7e4",
      "created_at": 1741267200,
      "tokens": 512,
      "indexing_status": "completed",
      "error": null,
      "enabled": true,
      "disabled_at": null,
      "disabled_by": null,
      "archived": false,
      "display_status": "available",
      "word_count": 350,
      "hit_count": 0,
      "doc_form": "text_model",
      "doc_metadata": [],
      "summary_index_status": null,
      "need_summary": false
    }
  ],
  "has_more": false,
  "limit": 20,
  "total": 1,
  "page": 1
}

{
  "status": 403,
  "code": "forbidden",
  "message": "Dataset api access is not enabled."
}

{
  "status": 404,
  "code": "not_found",
  "message": "Dataset not found."
}

Guides

App APIs

Knowledge APIs

Authorizations

Path Parameters

Query Parameters

Response