API Reference
Use this section to reproduce working requests: URLs, bodies, authentication, pagination, errors, and the WebSocket stream. It is intentionally limited to what you need to connect your servers and clients to Kallglot. The API follows common REST patterns: JSON over HTTPS, standard status codes, and Bearer API keys.Base URL
All API endpoints are relative to:Request Format
The API accepts JSON-encoded request bodies and returns JSON-encoded responses. All requests must include theContent-Type: application/json header for POST/PUT/PATCH requests.
Response Format
All responses follow a consistent structure:Success Response
Error Response
Object Types
ID Formats
All objects use prefixed identifiers for easy identification:Pagination
There is noGET /v1/sessions list endpoint. Cursor-style query parameters apply only where a list route exists:
GET /v1/agentsGET /v1/sessions/{session_id}/recordings
Paginated list response shape
Idempotency
For POST requests that create resources, include anIdempotency-Key header to ensure the request is processed only once:
- Keys are valid for roughly 24 hours (server-defined TTL)
- Retrying with the same key returns the cached response when the JSON body matches the original request (see mismatches below)
- Use UUIDs or other unique identifiers
Versioning
The API version is included in the URL path (/v1/). We release new versions when making backwards-incompatible changes.