Appearance
API Reference
Everything you can do in the GatherCloud dashboard is also available over a REST API, so you can create events, drive their lifecycle, and pull recordings and transcripts from your own systems.
Base URL
https://api.gathercloud.devAll endpoints are versioned under /v1.
Authentication
Server-to-server calls authenticate with a workspace API key in the x-api-key header. See Authentication.
sh
curl https://api.gathercloud.dev/v1/events \
-H "x-api-key: gck_..."Conventions
- Requests and responses are JSON (
content-type: application/json). - Timestamps are ISO 8601 strings (
2026-06-11T18:00:00.000Z). - IDs are UUIDs.
- Successful deletes return
204 No Content.
Errors
Errors use a problem+json style body with a stable code:
json
{
"type": "https://gathercloud.dev/errors/not_found",
"code": "not_found",
"detail": "event not found"
}| Status | Code | Meaning |
|---|---|---|
| 400 | bad_request | Malformed or missing input |
| 401 | unauthorized | Missing or invalid credentials |
| 403 | forbidden | Authenticated, but not allowed |
| 404 | not_found | No such resource in your workspace |
| 409 | conflict (e.g. slug_taken) | State conflict |
Resources
- Events & phases — create events, build agendas, drive the lifecycle.
- Broadcasts, recordings & transcripts — go live, manage segments, pull assets.
- Webhooks — receive signed event notifications.