Listar Documentos

Listar os documentos de uma knowledge base com busca por nome de arquivo, filtro por estado, filtro por tag, ordenação e paginação por cursor opaco. Os valores de tag são chaveados pelo nome de exibição; resolva-os para os slots de escrita com GET /api/v2/knowledge/{id}/tags.

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

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

knowledgeBaseId*string

Identificador único da knowledge base.

Tamanho1 <= length

Parâmetros de query

workspaceId*string

Workspace dono da knowledge base.

Tamanho1 <= length
limit?integer

Máximo de documentos a retornar por página. Deve ser um número inteiro de 1 a 100. O padrão é 50.

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

Correspondência de substring com o nome de arquivo do documento, sem diferenciar maiúsculas de minúsculas.

Tamanho1 <= length <= 200
enabledFilter?string

Filtrar por documentos estarem ou não ativados para busca.

Padrão"all"
Valor em"all" | "enabled" | "disabled"
sortBy?string

Campo usado para ordenar o resultado. A ordenação por filename diferencia maiúsculas de minúsculas e segue a collation do armazenamento, então não conte com uma ordem que ignore maiúsculas e minúsculas.

Padrão"uploadedAt"
Valor em"filename" | "fileSize" | "tokenCount" | "chunkCount" | "uploadedAt" | "processingStatus" | "enabled"
sortOrder?string

Direção da ordenação.

Padrão"desc"
Valor em"asc" | "desc"
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
tagFilters?string

Um array codificado em JSON com no máximo 10 filtros de tag, no mesmo formato de nome de exibição da busca em knowledge base: [{"tagName":"category","operator":"eq","value":"billing"}]. Todos os filtros precisam valer, inclusive dois que nomeiem a mesma tag. Um nome que não esteja definido nesta knowledge base é rejeitado, nunca ignorado.

Corpo da resposta

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?workspaceId=string" \  -H "X-API-Key: YOUR_API_KEY"
{
  "data": [
    {
      "id": "b2d4f8a0-1c3e-4a5b-9d7c-2e6f0a8b4c12",
      "knowledgeBaseId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "filename": "getting-started.pdf",
      "fileSize": 248913,
      "mimeType": "application/pdf",
      "processingStatus": "completed",
      "chunkCount": 24,
      "tokenCount": 8123,
      "characterCount": 41205,
      "enabled": true,
      "createdAt": "2025-06-18T16:45:00Z",
      "tags": {
        "category": "billing",
        "priority": 2
      }
    }
  ],
  "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": "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"
  }
}
GETList Knowledge ConnectorsGETListar Pastas