Skip to main content
Resources use POST action routes under /api/v1. The action is the last path segment, not the HTTP verb.
The TypeScript SDK maps these to methods such as client.tickets.create(). Send JSON. Every body includes workspaceId. List routes also accept limit, cursor, and direction.

Reads

List and info responses wrap the entity:

Mutations

Creates and updates return a public mutation payload:
Deletes return { "success": true, "entityId": "…" }.

Idempotency

On create and send message, send an optional header so retries are safe:
The gateway caches a successful response for 24 hours, scoped by workspace, principal, and route. Reusing a key while the first request is still in flight returns 409 (IDEMPOTENCY_CONFLICT).