API Reference

The Hexel Studio API is organized around REST.

Base URL

https://api.hexelstudio.com/runtime/v1

All requests require a Bearer token:

Authorization: Bearer $HX_API_KEY

Your API key contains your org, workspace, and environment context.

{
  "results": [...],
  "count": 10,
  "latency_ms": 45
}

{
  "detail": [
    {
      "loc": ["body", "query"],
      "msg": "field required",
      "type": "value_error.missing"
    }
  ]
}

Rate limits vary by plan. Headers are included in responses:

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1704412800

We recommend using the Python SDK for easier integration:

from hx import Client

client = Client()
results = client.knowledge.search("ks-...", "query")

The SDK handles authentication, retries, and error handling automatically.