Docs
REST API v1

Errors and status codes

Understand failures and pending cleanup responses.

Error format

JSON
{
  "code": "API_KEY_SCOPE_REQUIRED",
  "description": "The API key requires the rooms:create scope",
  "requestId": "request_example"
}

The description explains the failure. The request ID also appears in the x-request-id response header.

Status codes

StatusMeaning
200Object or collection returned.
201Resource or credentials created.
202Work accepted; inspect the returned operation or delivery.
204Completed with no body.
400Invalid JSON fields, parameters or time window.
401Missing, invalid, expired or revoked key.
403Missing scope or project/environment mismatch.
404Resource, route or runtime operation not found.
409Lifecycle or replay conflict.
429Request limit exceeded.
500Server could not complete the request.
503A required service or signing configuration is unavailable.

Pending cleanup

Room ending and participant removal can return 202 with a runtime operation. Poll the corresponding runtime-operation endpoint until status is completed. A failed operation needs investigation.

Retry carefully

Read requests can be retried after transient failures. Writes are not automatically safe to repeat after a lost response. Check resource state before creating another room, issuing another token, rotating a secret or replaying a delivery.