RTC server API reference
Base URL: https://api.rtc.champrep.com
This reference covers integration routes supported with RTC project API keys. Console sign-in, organization setup, key administration, and platform-admin operations are not server-key integration routes. Manage them through the appropriate UI rather than copying browser session tokens into scripts.
Send Authorization: Bearer YOUR_RTC_API_KEY and, for JSON bodies,
Content-Type: application/json. Examples use placeholders, never working
credentials. Keys remain restricted to their project and current plan access.
Request and response conventions
Section titled “Request and response conventions”- IDs are UUID strings. Use IDs returned by RTC, not display names.
- Names are trimmed and accept 1-80 characters.
- JSON bodies are limited to 64 KiB and reject unknown fields.
- List endpoints return JSON arrays, newest first.
?limit(1-200) sets the page size; when more items exist, theX-Next-Cursorresponse header holds the cursor to pass back as?cursor. - Do not rely on undocumented response fields or construct media/storage URLs.
- Mutations do not offer a general idempotency-key contract. Reconcile results before retrying after a timeout or connection loss.
Method summary
Section titled “Method summary”| Method and path | Required scope | Result |
|---|---|---|
GET /v1/projects | Any valid project key | Project-filtered array |
GET /v1/rooms | rooms:read | Room array |
POST /v1/rooms | rooms:write | 201, created room |
POST /v1/rooms/{roomId}/end | rooms:write | { "ended": true } |
POST /v1/rooms/{roomId}/tokens | tokens:write | Participant credential set |
GET /v1/recordings | recordings:read | Recording array |
POST /v1/recordings | recordings:write | 202, queued recording |
POST /v1/recordings/{recordingId}/stop | recordings:write | { "stopping": true } |
POST /v1/recordings/{recordingId}/tracks/{trackId}/download | recordings:read | Temporary download URL |
POST /v1/recordings/{recordingId}/transcript | recordings:write | 202, the transcript is requested (transcription) |
GET /v1/recordings/{recordingId}/transcript | recordings:read | The transcript as JSON, or a file with ?format=vtt, srt or txt |
GET /v1/transcripts | recordings:read | Your transcripts and their status, without text |
GET /v1/usage | Any valid project key | Completed usage and allowances |
GET /v1/webhooks/endpoints, GET /v1/webhooks/deliveries | webhooks:read | Endpoints and the delivery log (webhooks) |
POST, PATCH /v1/webhooks/endpoints…, replays and tests | webhooks:write | Manage endpoints (webhooks) |
POST /v1/join | None (a join token) | Participant credential set (join tokens) |
GET /v1/error-codes | None | The error code catalog |
Successful responses use 200 unless otherwise stated. Both read routes with
no named scope still require a valid, unexpired project key and service access.
Projects and rooms
Section titled “Projects and rooms”GET /v1/projects returns only the project associated with the key. Project
creation is performed in the console.
For POST /v1/rooms, send:
{ "projectId": "00000000-0000-4000-8000-000000000001", "name": "Customer conversation", "maxParticipants": 4}projectId and name are required. maxParticipants is optional, defaults
to 8, and must be a whole number of at least 2 within your plan allowance. Explicitly
set a smaller value if your plan does not allow the default. The response
includes the new room’s id, projectId, name, maxParticipants, status
(open), and createdAt.
GET /v1/rooms lists the key’s project rooms. End a room with
POST /v1/rooms/{roomId}/end, with no body. Ending blocks new joins and
disconnects active sessions. It also requests that active recording jobs stop.
Repeating the operation on an ended room returns 404; it is not an idempotent
success response. There is currently no room rename, reopen, or delete method.
Issue participant credentials
Section titled “Issue participant credentials”POST /v1/rooms/{roomId}/tokens accepts an optional JSON object:
{ "canPublish": false }canPublish defaults to true. Set it to false for a receive-only client.
The room must be open and in the key’s project. The response contains:
| Field | Meaning |
|---|---|
token | Sensitive, short-lived participant token |
participantId | Identifier assigned to this join |
expiresIn | Join credential lifetime in seconds, currently 300 |
url | Signaling URL for the client |
iceServers | ICE configuration, including temporary relay credentials |
Request fresh credentials for each join and reconnect. Do not infer successful admission from token issuance: room state, capacity, and authorization are also checked at join time. See the complete client flow.
Recording jobs and downloads
Section titled “Recording jobs and downloads”Start with POST /v1/recordings and { "roomId": "ROOM_UUID" }. The 202
response includes a recording id and status: "queued"; it does not mean
a downloadable file already exists. A duplicate active recording for the same
room returns 409.
GET /v1/recordings returns project-filtered jobs, including their id,
roomId, status, and tracks. Track metadata includes id, kind,
source, participantId, and bytes. Use track IDs returned by RTC.
Stop a queued or recording job with
POST /v1/recordings/{recordingId}/stop, with no body. Poll the list or use a
recording.ready webhook to determine completion. A job that is already
processing, ready, or failed is not an active stop target and returns 404.
For a ready track, post to its /download route. The response is
{ "url": "TEMPORARY_DOWNLOAD_URL", "expiresIn": 300 }. Fetch the returned
URL unchanged to download attachment bytes. The URL itself authorizes access
until expiry; treat it like a credential. It is not a public permanent link.
See recording security and formats.
GET /v1/usage returns:
| Field | Meaning |
|---|---|
participantSeconds | Sum of completed participant-session durations in scope |
sessions | Number of completed connections in scope |
period | all-time for these activity counters |
billingStatus | Indicates centrally managed billing |
quotas | Current entitlement decisions for the workspace’s RTC features |
Divide participant seconds by 60 to display participant minutes. These activity counters are not an invoice or a live participant count. A project key filters activity to its project, while allowances belong to the owning workspace. Billing usage can update asynchronously; use central Billing for subscription and invoice information.
Errors
Section titled “Errors”Errors return a JSON error string and a stable code, also sent in the
X-Error-Code header. Send RTC-Version: 2026-11-01 for the structured error
envelope. See errors for the shapes and the code catalog,
rate limits for 429, and versioning for
what may change under /v1. Do not depend on exact message text.
| Status | Check or action |
|---|---|
400 | Required fields, UUIDs, unknown fields, or input ranges |
401 | Missing, invalid, revoked, or expired credentials |
403 | Key scope, project access, plan entitlement, or allowance |
404 | Resource absent, out of scope, or not in the required state |
409 | Conflicting operation, such as an active recording |
413 | Request body exceeds the size limit |
429 | Rate limiting; back off and honor Retry-After when supplied |
5xx | Temporary service failure; retry reads with backoff and reconcile writes |
Never probe another customer’s resources to distinguish access denial from absence. Follow troubleshooting guidance.