Get Document

GET

datasets

{dataset_id}

documents

{document_id}

Get Document

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

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://{api_base_url}/datasets/{dataset_id}/documents/{document_id}', 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/{document_id}",
  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/{document_id}"

	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/{document_id}")

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

{
  "archived": false,
  "average_segment_length": 70,
  "completed_at": 1741267260,
  "created_at": 1741267200,
  "created_by": "ad313dd6-ef04-4dd1-a5b0-c0f0b9e2e7e4",
  "created_from": "api",
  "data_source_info": {
    "upload_file": {
      "created_at": 1741267200,
      "created_by": "ad313dd6-ef04-4dd1-a5b0-c0f0b9e2e7e4",
      "extension": "txt",
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "mime_type": "text/plain",
      "name": "guide.txt",
      "size": 2048
    }
  },
  "data_source_type": "upload_file",
  "dataset_process_rule": {
    "id": "e1f2a3b4-c5d6-7890-ef12-345678901234",
    "mode": "custom"
  },
  "dataset_process_rule_id": "e1f2a3b4-c5d6-7890-ef12-345678901234",
  "disabled_at": null,
  "disabled_by": null,
  "display_status": "available",
  "doc_form": "text_model",
  "doc_language": "English",
  "doc_metadata": [],
  "doc_type": null,
  "document_process_rule": {
    "mode": "custom",
    "rules": {
      "pre_processing_rules": [],
      "segmentation": {
        "chunk_overlap": 50,
        "max_tokens": 500,
        "separator": "###"
      }
    }
  },
  "enabled": true,
  "error": null,
  "hit_count": 0,
  "id": "a8e0e5b5-78c6-4130-a5ce-25feb0e0b4ac",
  "indexing_latency": 60,
  "indexing_status": "completed",
  "name": "guide.txt",
  "need_summary": false,
  "position": 1,
  "segment_count": 5,
  "summary_index_status": null,
  "tokens": 512,
  "updated_at": 1741267260
}

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.

document_id

string<uuid>

required

Document ID. From List Documents.

Query Parameters

metadata

enum<string>

default:all

all returns all fields including metadata. only returns only id, doc_type, and doc_metadata. without returns all fields except doc_metadata.

Available options:

all,

only,

without

Response

Document details. The returned fields depend on the metadata query parameter.

archived

boolean

Whether the document is archived.

average_segment_length

number

Average character length of chunks.

completed_at

number | null

Unix timestamp when processing completed, null if not yet completed.

created_at

number

Unix timestamp of document creation.

created_by

string

ID of the user who created the document.

created_from

string

Origin of the document. api for API creation, web for UI creation.

data_source_info

object

Data source details. For file uploads, this detail endpoint returns the full file object under upload_file (the list endpoint returns only upload_file_id).

Show child attributes

data_source_type

string

How the document was uploaded. upload_file for file uploads, notion_import for Notion imports.

dataset_process_rule

object

Knowledge-base-level processing rule configuration.

dataset_process_rule_id

string

ID of the processing rule applied to this document.

disabled_at

number | null

Unix timestamp when the document was disabled, null if enabled.

disabled_by

string | null

ID of the user who disabled the document, null if enabled.

display_status

string

Display-friendly indexing status for the UI.

doc_form

string

Document chunking mode. text_model for standard text, hierarchical_model for parent-child, qa_model for QA pairs.

doc_language

string

Language of the document content.

doc_metadata

object[]

Custom metadata key-value pairs for this document.

Show child attributes

doc_type

string | null

Document type classification, null if not set.

document_process_rule

object

Document-level processing rule configuration.

enabled

boolean

Whether the document is enabled for retrieval.

error

string | null

Error message if indexing failed, null otherwise.

hit_count

integer

Number of times this document has been retrieved.

string

Document identifier.

indexing_latency

number | null

Time taken for indexing in seconds, null if not completed.

indexing_status

string

Current indexing status, e.g. waiting, parsing, cleaning, splitting, indexing, completed, error, paused.

name

string

Document name.

need_summary

boolean

Whether the document needs summary generation.

position

integer

Position index within the knowledge base.

segment_count

integer

Number of chunks in the document.

summary_index_status

string | null

Status of summary indexing, null if summary index is not enabled.

tokens

integer

Number of tokens in the document.

updated_at

number | null

Unix timestamp of last update, null if never updated.

Last modified on September 9, 2026

Get Document

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

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://{api_base_url}/datasets/{dataset_id}/documents/{document_id}', 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/{document_id}",
  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/{document_id}"

	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/{document_id}")

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

{
  "archived": false,
  "average_segment_length": 70,
  "completed_at": 1741267260,
  "created_at": 1741267200,
  "created_by": "ad313dd6-ef04-4dd1-a5b0-c0f0b9e2e7e4",
  "created_from": "api",
  "data_source_info": {
    "upload_file": {
      "created_at": 1741267200,
      "created_by": "ad313dd6-ef04-4dd1-a5b0-c0f0b9e2e7e4",
      "extension": "txt",
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "mime_type": "text/plain",
      "name": "guide.txt",
      "size": 2048
    }
  },
  "data_source_type": "upload_file",
  "dataset_process_rule": {
    "id": "e1f2a3b4-c5d6-7890-ef12-345678901234",
    "mode": "custom"
  },
  "dataset_process_rule_id": "e1f2a3b4-c5d6-7890-ef12-345678901234",
  "disabled_at": null,
  "disabled_by": null,
  "display_status": "available",
  "doc_form": "text_model",
  "doc_language": "English",
  "doc_metadata": [],
  "doc_type": null,
  "document_process_rule": {
    "mode": "custom",
    "rules": {
      "pre_processing_rules": [],
      "segmentation": {
        "chunk_overlap": 50,
        "max_tokens": 500,
        "separator": "###"
      }
    }
  },
  "enabled": true,
  "error": null,
  "hit_count": 0,
  "id": "a8e0e5b5-78c6-4130-a5ce-25feb0e0b4ac",
  "indexing_latency": 60,
  "indexing_status": "completed",
  "name": "guide.txt",
  "need_summary": false,
  "position": 1,
  "segment_count": 5,
  "summary_index_status": null,
  "tokens": 512,
  "updated_at": 1741267260
}

Guides

App APIs

Knowledge APIs

Authorizations

Path Parameters

Query Parameters

Response