Get Knowledge Base

Get a knowledge base's metadata and document counts. Inaccessible knowledge bases return 404. Workspace folder trees exceeding 10,000 folders return 413.

OAuth scope: api:read.

GET/api/v2/knowledge/{knowledgeBaseId}

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

Response Body

application/json

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?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"
  }
}
{
  "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"
  }
}
GETExport Knowledge BaseGETGet Chunk