Skip to main content
The Hexel Studio API provides programmatic access to all platform capabilities. Every feature in the docs and Console is backed by this API.

Base URLs

All API calls (except agent traffic) go through a single gateway host. Deployed-agent and sandbox traffic use separate subdomain endpoints.

Path prefixes

Authentication

Every request requires a Bearer token obtained from the STS. Exchange your API key or OAuth client credentials for a short-lived token (valid 15 minutes):
The SDKs handle token exchange and refresh automatically. See Authentication for OAuth client credentials and environment variable configuration.

Error responses

Each service returns a consistent error body, but the exact shape varies by product:
The Data Platform error shape includes request_id. Include it when contacting support — it ties directly to the failing request in platform logs.

Rate limits

Exceeding a limit returns 429. The response includes X-RateLimit-Limit, X-RateLimit-Remaining, and Retry-After headers where applicable.

Browse the reference

Use the sidebar to browse each endpoint group. Every endpoint has an interactive playground where you can send real requests and inspect responses.