Skip to main content
The Knowledge API provides semantic search over your document collections.

​
Endpoints

MethodEndpointDescription
POST/knowledge-stores/{store_id}/searchSearch documents

​
Authentication

All requests require a Bearer token: 
Authorization: Bearer $HX_API_KEY

​
Store IDs

Knowledge stores use the ks- prefix: 
ks-abc123def456

​
Quick Example

from hx import Client

client = Client()

results = client.knowledge.search(
    store_id="ks-your-store-id",
    query="How do I reset my password?",
    top_k=5
)
cURL
curl -X POST "https://api.hexelstudio.com/runtime/v1/knowledge-stores/{store_id}/search" \
  -H "Authorization: Bearer $HX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query": "How do I reset my password?", "top_k": 5}'

​
Response Structure

{
  "results": [
    {
      "chunk_id": "chunk_abc123",
      "document_id": "doc_xyz789",
      "text": "To reset your password, go to Settings...",
      "score": 0.92,
      "metadata": {}
    }
  ],
  "count": 1,
  "query": "How do I reset my password?",
  "knowledge_store_id": "ks-your-store-id",
  "latency_ms": 45
}

​
Search Parameters

ParameterTypeRequiredDescription
querystringYesSearch query (1-10000 chars)
top_kintegerNoResults to return (1-100, default 10)
score_thresholdfloatNoMinimum score (0.0-1.0)
metadata_filterobjectNoFilter by document metadata