Create Chunks

Create one or more chunks within a document. Each chunk can include optional keywords and an answer field (for QA-mode documents).

POST /datasets/{dataset_id}/documents/{document_id}/segments

Error

A valid request URL is required to generate request examples

200

success

{
  "data": [
    {
      "id": "f3d1c7be-9f3a-40d8-8eb8-3a1ef9c3f2c1",
      "position": 1,
      "document_id": "a8e0e5b5-78c6-4130-a5ce-25feb0e0b4ac",
      "content": "Dify is an open-source LLM app development platform.",
      "sign_content": "",
      "answer": "",
      "word_count": 9,
      "tokens": 12,
      "keywords": [
        "dify",
        "platform",
        "llm"
      ],
      "index_node_id": "a1b2c3d4-e5f6-7890-abcd-000000000001",
      "index_node_hash": "abc123def456",
      "hit_count": 0,
      "enabled": true,
      "disabled_at": null,
      "disabled_by": null,
      "status": "completed",
      "created_by": "ad313dd6-ef04-4dd1-a5b0-c0f0b9e2e7e4",
      "created_at": 1741267200,
      "updated_at": 1741267200,
      "updated_by": "ad313dd6-ef04-4dd1-a5b0-c0f0b9e2e7e4",
      "indexing_at": 1741267200,
      "completed_at": 1741267200,
      "error": null,
      "stopped_at": null,
      "child_chunks": [],
      "attachments": [],
      "summary": null
    }
  ],
  "doc_form": "text_model"
}

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

Knowledge base ID.

document_id · string<uuid> · required

Document ID.

Body

application/json

segments · object[] · required

Array of chunk objects to create.

Show child attributes

Response

200

application/json

Chunks created successfully.

data · object[]

List of created chunks.

Show child attributes

doc_form · string

Document chunking mode used by this document.