List Documents

List documents in a knowledge base with filename search, state filtering, sorting, and opaque cursor pagination.

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

Authorization

apiKey
X-API-Key<token>

Your Sim API key, personal or workspace-scoped. Generate one from the Sim dashboard under Settings > API Keys. A workspace API key is not accepted everywhere: operations that act on behalf of a specific human — administrative reads, secret access, and irreversible or governance-affecting writes — always reject it, whatever role the key carries. Each such operation says so in its own description, and the rejection surfaces as 403 unless the operation conceals unauthorized resources, in which case it is reported as 404. Use a personal API key for those.

In: header

Path Parameters

id*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, between 1 and 100.

Default50
Range1 <= value <= 100
search?string

Case-insensitive filename search.

enabledFilter?string

Filter by whether documents are enabled for search.

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

Document field used to sort results.

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 returned by the previous page.

Length1 <= length

Response Body

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"
{
  "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"
    }
  ],
  "nextCursor": "string"
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "The request is invalid."
  }
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "The request is invalid."
  }
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "The request is invalid."
  }
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "The request is invalid."
  }
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "The request is invalid."
  }
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "The request is invalid."
  }
}