List Chunks

List the passages a document was split into, with content search, enabled filtering, sorting, and opaque cursor pagination. Tag values are projected by slot; resolve slots to display names with GET /api/v2/knowledge/{knowledgeBaseId}/tags. A document that has not finished processing answers 409; the message names the status it is in. A workspace API key is rejected with 403; use a personal API key.

GET/api/v2/knowledge/{knowledgeBaseId}/documents/{documentId}/chunks

Authorization

apiKey
X-API-Key<token>

Your Sim API key, personal or workspace-scoped. Generate one under Settings, then API Keys. Operations that reject workspace keys say so in their own description.

In: header

Path Parameters

documentId*string

Unique knowledge document identifier.

Length1 <= length
knowledgeBaseId*string

Unique knowledge base identifier.

Length1 <= length

Query Parameters

workspaceId*string

Workspace that owns the knowledge base.

Length1 <= length <= 128
search?string

Case-insensitive substring match against chunk content.

Length1 <= length <= 200
enabled?string

Restrict to enabled or disabled chunks. all returns both.

Default"all"
Value in"true" | "false" | "all"
sortBy?string

Field used to sort the result.

Default"chunkIndex"
Value in"chunkIndex" | "tokenCount" | "enabled"
sortOrder?string

Sort direction.

Default"asc"
Value in"asc" | "desc"
limit?integer

Maximum chunks to return per page. Must be a whole number from 1 to 100. Defaults to 50.

Default50
Range1 <= value <= 100
cursor?string

Opaque cursor from the previous page. Send it back with the same sort and filters; only limit may change. Change anything else and pagination must restart without a cursor.

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://www.sim.ai/api/v2/knowledge/string/documents/string/chunks?workspaceId=string" \  -H "X-API-Key: YOUR_API_KEY"
{
  "data": [
    {
      "id": "4c1f9e77-2b3a-4f8d-9e10-6a2c8d4b1e05",
      "chunkIndex": 3,
      "content": "To reset your password, open Settings and choose Security.",
      "contentLength": 58,
      "tokenCount": 14,
      "enabled": true,
      "startOffset": 0,
      "endOffset": 0,
      "tag1": "string",
      "tag2": "string",
      "tag3": "string",
      "tag4": "string",
      "tag5": "string",
      "tag6": "string",
      "tag7": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "nextCursor": "string"
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "Invalid request"
  }
}
{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "API key required"
  }
}
{
  "error": {
    "code": "FORBIDDEN",
    "message": "Insufficient workspace permissions",
    "details": {
      "code": "INSUFFICIENT_WORKSPACE_ROLE"
    }
  }
}
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Not found"
  }
}
{
  "error": {
    "code": "CONFLICT",
    "message": "Upload has already been completed"
  }
}
{
  "error": {
    "code": "RATE_LIMITED",
    "message": "API rate limit exceeded",
    "details": {
      "retryAfter": "2026-01-01T00:00:30.000Z"
    }
  }
}
{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal server error"
  }
}
{
  "error": {
    "code": "SERVICE_UNAVAILABLE",
    "message": "Service temporarily unavailable"
  }
}