Listar Knowledge Bases

Listar as knowledge bases de um workspace com filtro por pasta, busca, ordenação e paginação por cursor opaco. Uma árvore de pastas do workspace com mais de 10.000 pastas é um 413.

GET/api/v2/knowledge

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 query

workspaceId*string

Workspace cujas knowledge bases devem ser listadas.

Tamanho1 <= length <= 128
scope?string

Lifecycle scope: active or archived knowledge bases. Use Restore Knowledge Base to recover archived entries. Folder paths resolve only active folders, so filtering by an archived folder returns no matches.

Padrão"active"
Valor em"active" | "archived"
folderPath?Folder path input

Restrict results to knowledge bases in this folder. Unknown folder paths contribute no matches.

Tamanholength <= 4096
search?string

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

Tamanho1 <= length <= 200
sortBy?string

Campo usado para ordenar o resultado. A ordenação por name 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"createdAt"
Valor em"name" | "createdAt" | "updatedAt"
sortOrder?string

Direção da ordenação.

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

Máximo de knowledge bases a retornar por página. Deve ser um número inteiro de 1 a 100. O padrão é 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?workspaceId=string" \  -H "X-API-Key: YOUR_API_KEY"
{
  "data": [
    {
      "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "name": "Product Documentation",
      "description": "All product documentation and guides",
      "tokenCount": 48213,
      "embeddingModel": "text-embedding-3-small",
      "embeddingDimension": 1536,
      "chunkingConfig": {
        "maxSize": 1024,
        "minSize": 100,
        "overlap": 200,
        "strategy": "auto",
        "strategyOptions": {
          "pattern": "string",
          "separators": [
            "string"
          ],
          "recipe": "plain",
          "strictBoundaries": true
        },
        "property1": null,
        "property2": null
      },
      "docCount": 12,
      "connectorTypes": [
        "notion",
        "google_drive"
      ],
      "createdAt": "2025-01-10T09:00:00Z",
      "updatedAt": "2025-06-18T16:45:00Z",
      "webUrl": "http://example.com",
      "ownerEmail": "owner@example.com",
      "folderPath": "/Product",
      "deletedAt": "2026-01-16T09:00:00Z"
    }
  ],
  "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": "PAYLOAD_TOO_LARGE",
    "message": "Request body is too large"
  }
}
{
  "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"
  }
}
GETGet Next Tag SlotGETList Chunks