List Documents

List documents with filename search, state and tag filters, sorting, and cursor pagination. Tag values use display names; use List Tags to resolve the slots required for writes.

OAuth scope: api:read.

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

Authorization

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

knowledgeBaseId*string

Unique knowledge base identifier.

Length1 <= length

Query Parameters

workspaceId*string

Workspace that owns the knowledge base.

Length1 <= length
limit?integer

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

Default50
Range1 <= value <= 100
search?string

Case-insensitive substring match against the document filename.

Length1 <= length <= 200
enabledFilter?string

Filter by whether documents are enabled for search.

Default"all"
Value in"all" | "enabled" | "disabled"
sortBy?string

Field used to sort the result. Sorting by filename is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order.

Default"uploadedAt"
Value in"filename" | "fileSize" | "tokenCount" | "chunkCount" | "uploadedAt" | "processingStatus" | "enabled"
sortOrder?string

Sort direction.

Default"desc"
Value in"asc" | "desc"
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
tagFilters?string

A JSON-encoded array of at most 10 tag filters, using the same display-name shape as knowledge search: [{"tagName":"category","operator":"eq","value":"billing"}]. Every filter must hold, including two that name the same tag. A name that is not defined in this knowledge base is rejected, never ignored.

Response Body

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?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 ConnectorsGETList Folders