Skip to main content
GET
/
datasets
/
{dataset_id}
/
documents
/
{document_id}
/
segments
/
{segment_id}
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "position": 123,
    "document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "content": "<string>",
    "answer": "<string>",
    "word_count": 123,
    "tokens": 123,
    "keywords": [
      "<string>"
    ],
    "index_node_id": "<string>",
    "index_node_hash": "<string>",
    "hit_count": 123,
    "enabled": true,
    "disabled_at": 123,
    "disabled_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "<string>",
    "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": 123,
    "indexing_at": 123,
    "completed_at": 123,
    "error": "<string>",
    "stopped_at": 123
  },
  "doc_form": "<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.

​
segment_id
string<uuid>
required

The ID of the segment.

Response

200 - application/json

Detailed information about the segment.

​
data
object
​
doc_form
string