Search Knowledge

Search one or more knowledge bases with semantic vector retrieval, optional hybrid full-text retrieval, and structured tag filters. Every result names the knowledgeBaseId it came from. A request body over 2 MiB is a 413. Reranking returns 409 when the stored results cannot pass secret-provenance enforcement.

OAuth scope: api:read.

POST/api/v2/knowledge/search

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

Request Body

application/json

Knowledge bases, query, result limit, retrieval mode, and optional tag filters.

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://www.sim.ai/api/v2/knowledge/search" \  -H "X-API-Key: YOUR_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "workspaceId": "string",    "knowledgeBaseIds": [      "7c9e6679-7425-40de-944b-e07fc1f90ae7"    ]  }'
{
  "data": {
    "results": [
      {
        "knowledgeBaseId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
        "documentId": "b2d4f8a0-1c3e-4a5b-9d7c-2e6f0a8b4c12",
        "documentName": "getting-started.pdf",
        "sourceUrl": "string",
        "content": "To reset your password, open Settings and choose Security.",
        "chunkIndex": 3,
        "metadata": {
          "category": "billing",
          "priority": 2
        },
        "similarity": 0.8423,
        "rerankerScore": 0.9312
      }
    ],
    "query": "How do I reset my password?",
    "knowledgeBaseIds": [
      "7c9e6679-7425-40de-944b-e07fc1f90ae7"
    ],
    "topK": 10,
    "totalResults": 4,
    "rerankerStatus": "applied"
  }
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "Invalid request"
  }
}
{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication required"
  }
}
{
  "error": {
    "code": "USAGE_LIMIT_EXCEEDED",
    "message": "Usage limit exceeded. Please upgrade your plan to continue."
  }
}
{
  "error": {
    "code": "FORBIDDEN",
    "message": "Insufficient workspace permissions",
    "details": {
      "code": "INSUFFICIENT_WORKSPACE_ROLE"
    }
  }
}
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Not found"
  }
}
{
  "error": {
    "code": "CONFLICT",
    "message": "Upload has already been completed"
  }
}
{
  "error": {
    "code": "PAYLOAD_TOO_LARGE",
    "message": "Request body is too large"
  }
}
{
  "error": {
    "code": "UNSUPPORTED_MEDIA_TYPE",
    "message": "Request body must be sent as application/json"
  }
}
{
  "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"
  }
}
POSTRestore Knowledge BasePOSTSync Knowledge Connector