List Chunks

List document chunks with content search, enabled filtering, sorting, and cursor pagination. Tags use slots; use List Tags to resolve display names. Documents that have not finished processing return 409 with their current status. Workspace API keys return 403; use a personal API key or scoped OAuth token.

OAuth scope: api:read.

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

Authorization

X-API-Key<token>

Sua API key do Studio, pessoal ou com escopo de workspace. Gere uma em Settings e depois API Keys. As operações que rejeitam API keys de workspace dizem isso na própria descrição.

Em: header

Parâmetros de path

documentId*string

Identificador único do documento de knowledge base.

Tamanho1 <= length
knowledgeBaseId*string

Identificador único da knowledge base.

Tamanho1 <= length

Parâmetros de query

workspaceId*string

Workspace dono da knowledge base.

Tamanho1 <= length <= 128
search?string

Case-insensitive substring match against chunk content.

Tamanho1 <= length <= 200
enabled?string

Restrict to enabled or disabled chunks. all returns both.

Padrão"all"
Valor em"true" | "false" | "all"
sortBy?string

Campo usado para ordenar o resultado.

Padrão"chunkIndex"
Valor em"chunkIndex" | "tokenCount" | "enabled"
sortOrder?string

Direção da ordenação.

Padrão"asc"
Valor em"asc" | "desc"
limit?integer

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

Padrão50
Intervalo1 <= value <= 100
cursor?string

Cursor opaco da página anterior. Devolva-o com a mesma ordenação e os mesmos filtros; apenas limit pode mudar. Altere qualquer outra coisa e a paginação precisa recomeçar sem cursor.

Tamanho1 <= length

Corpo da resposta

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://agent-studio.seeyu.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": "Authentication 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"
  }
}
GETListar Knowledge BasesGETList Knowledge Connector Documents