Skip to main content
GET
/
datasets
/
{dataset_id}
/
documents
/
{document_id}
Error
A valid request URL is required to generate request examples
{
  "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>",
  "dataset_process_rule": {
    "mode": "automatic",
    "rules": {
      "pre_processing_rules": [
        {
          "id": "remove_extra_spaces",
          "enabled": true
        }
      ],
      "segmentation": {
        "separator": "<string>",
        "max_tokens": 123
      },
      "parent_mode": "full-doc",
      "subchunk_segmentation": {
        "separator": "<string>",
        "max_tokens": 123,
        "chunk_overlap": 123
      }
    }
  },
  "document_process_rule": {
    "mode": "automatic",
    "rules": {
      "pre_processing_rules": [
        {
          "id": "remove_extra_spaces",
          "enabled": true
        }
      ],
      "segmentation": {
        "separator": "<string>",
        "max_tokens": 123
      },
      "parent_mode": "full-doc",
      "subchunk_segmentation": {
        "separator": "<string>",
        "max_tokens": 123,
        "chunk_overlap": 123
      }
    },
    "id": "<string>",
    "dataset_id": "<string>"
  },
  "indexing_latency": 123,
  "segment_count": 123,
  "average_segment_length": 123,
  "doc_language": "<string>"
}

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.

​
document_id
string<uuid>
required

The ID of the document.

Query Parameters

​
metadata
enum<string>
default:all

Metadata filter: all returns all metadata, only returns only custom metadata, without returns no metadata.

Available options:
all,
only,
without

Response

200 - application/json

Detailed information about the document.

​
id
string<uuid>
​
position
integer
​
data_source_type
string
​
data_source_info
object
​
dataset_process_rule_id
string<uuid> | null
​
name
string
​
created_from
string
​
created_by
string<uuid>
​
created_at
integer<int64>
​
tokens
integer
​
indexing_status
string
​
error
string | null
​
enabled
boolean
​
disabled_at
integer<int64> | null
​
disabled_by
string<uuid> | null
​
archived
boolean
​
display_status
string
​
word_count
integer
​
hit_count
integer
​
doc_form
string
​
dataset_process_rule
object

A set of rules for processing a document, including cleaning and segmentation.

​
document_process_rule
object

A set of rules for processing a document, including cleaning and segmentation.

​
indexing_latency
number<float> | null
​
segment_count
integer
​
average_segment_length
integer
​
doc_language
string | null