Console (admin) API
The API behind the admin console. Every route needs a console session and the listed console role; responses are never cached. Generated from the OpenAPI specification.
The API behind the admin console. Every route needs a console session and the listed console role; responses are never cached.
POST /v1/admin/auth/login
Console sign-in. Accounts are provisioned by the operator CLI; there is no signup.
Authentication: None (public).
Request body (application/json, required)
| Field | Type | Required | Notes |
|---|---|---|---|
email | string (email) | Yes | max length 320 |
password | string | Yes | min length 1; max length 1024 |
Response 204 No content
Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.
POST /v1/admin/auth/logout
Revoke the current console session.
Authentication: None (public).
Response 204 No content
Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.
GET /v1/admin/me
Authentication: Console session cookie; console role owner, admin, developer, auditor.
Response 200 OK
| Field | Type | Required | Notes |
|---|---|---|---|
email | string | Yes | |
roles | object[] | Yes | |
roles[].role | "owner", "admin", "developer", "auditor" | Yes | |
roles[].projectId | string or null | Yes | nullable |
Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.
GET /v1/admin/projects
Authentication: Console session cookie; console role owner, admin, developer, auditor.
Response 200 OK
| Field | Type | Required | Notes |
|---|---|---|---|
[].id | string (uuid) | Yes | |
[].slug | string | Yes | |
[].name | string | Yes | |
[].status | "active", "disabled" | Yes | |
[].createdAt | string | Yes | |
[].environments | object[] | Yes | |
[].environments[].id | string (uuid) | Yes | |
[].environments[].projectId | string (uuid) | Yes | |
[].environments[].environment | "staging", "production" | Yes | |
[].environments[].status | "active", "disabled" | Yes | |
[].environments[].allowedOrigins | string[] | Yes | |
[].environments[].webhookUrl | string or null | Yes | nullable |
[].environments[].webhookSecretConfigured | boolean | Yes | |
[].environments[].livekitKeyRef | string | Yes | |
[].environments[].pushCredentialRef | string or null | Yes | nullable |
[].environments[].features | object | Yes | |
[].environments[].features.calls | boolean | No | default true |
[].environments[].features.livestream | boolean | No | default false |
[].environments[].features.messaging | boolean | No | default false |
[].environments[].features.presence | boolean | No | default false |
[].environments[].features.attachments | boolean | No | default false |
[].environments[].features.singleDeviceCalls | boolean | No | default false |
[].environments[].features.push | boolean | No | default false |
[].environments[].features.recording | boolean | No | default false |
[].environments[].limits | object | Yes | |
[].environments[].limits.maxRoomSize | integer | No | ≥ 2; ≤ 1000; default 50 |
[].environments[].limits.maxConcurrentRooms | integer | No | ≥ 1; ≤ 100000; default 100 |
[].environments[].limits.tokensPerMinute | integer | No | ≥ 1; ≤ 100000; default 600 |
[].environments[].messagingPolicy | object | Yes | |
[].environments[].messagingPolicy.allowDms | boolean | No | default true |
[].environments[].messagingPolicy.allowGroups | boolean | No | default true |
[].environments[].messagingPolicy.allowAttachments | boolean | No | default false |
[].environments[].messagingPolicy.allowThreads | boolean | No | default false |
[].environments[].messagingPolicy.allowReactions | boolean | No | default true |
[].environments[].messagingPolicy.maxAttachmentBytes | integer | No | ≥ 1; ≤ 5368709120; default 26214400 |
[].environments[].messagingPolicy.allowedAttachmentTypes | string[] | No | at most 50 items; default ["image/*","video/mp4","application/pdf"] |
[].environments[].messagingPolicy.retentionDays | integer or null | No | ≥ 1; ≤ 36500; default null; nullable |
[].environments[].createdAt | string | Yes | |
[].environments[].updatedAt | string | Yes |
Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.
POST /v1/admin/projects
Authentication: Console session cookie; console role owner, admin.
Request body (application/json, required)
| Field | Type | Required | Notes |
|---|---|---|---|
slug | string | Yes | pattern ^[a-z][a-z0-9-]{1,30}$ |
name | string | Yes | min length 1; max length 100 |
Response 201 Created
| Field | Type | Required | Notes |
|---|---|---|---|
id | string (uuid) | Yes | |
slug | string | Yes | |
name | string | Yes | |
status | "active", "disabled" | Yes | |
createdAt | string | Yes | |
environments | object[] | Yes | |
environments[].id | string (uuid) | Yes | |
environments[].projectId | string (uuid) | Yes | |
environments[].environment | "staging", "production" | Yes | |
environments[].status | "active", "disabled" | Yes | |
environments[].allowedOrigins | string[] | Yes | |
environments[].webhookUrl | string or null | Yes | nullable |
environments[].webhookSecretConfigured | boolean | Yes | |
environments[].livekitKeyRef | string | Yes | |
environments[].pushCredentialRef | string or null | Yes | nullable |
environments[].features | object | Yes | |
environments[].features.calls | boolean | No | default true |
environments[].features.livestream | boolean | No | default false |
environments[].features.messaging | boolean | No | default false |
environments[].features.presence | boolean | No | default false |
environments[].features.attachments | boolean | No | default false |
environments[].features.singleDeviceCalls | boolean | No | default false |
environments[].features.push | boolean | No | default false |
environments[].features.recording | boolean | No | default false |
environments[].limits | object | Yes | |
environments[].limits.maxRoomSize | integer | No | ≥ 2; ≤ 1000; default 50 |
environments[].limits.maxConcurrentRooms | integer | No | ≥ 1; ≤ 100000; default 100 |
environments[].limits.tokensPerMinute | integer | No | ≥ 1; ≤ 100000; default 600 |
environments[].messagingPolicy | object | Yes | |
environments[].messagingPolicy.allowDms | boolean | No | default true |
environments[].messagingPolicy.allowGroups | boolean | No | default true |
environments[].messagingPolicy.allowAttachments | boolean | No | default false |
environments[].messagingPolicy.allowThreads | boolean | No | default false |
environments[].messagingPolicy.allowReactions | boolean | No | default true |
environments[].messagingPolicy.maxAttachmentBytes | integer | No | ≥ 1; ≤ 5368709120; default 26214400 |
environments[].messagingPolicy.allowedAttachmentTypes | string[] | No | at most 50 items; default ["image/*","video/mp4","application/pdf"] |
environments[].messagingPolicy.retentionDays | integer or null | No | ≥ 1; ≤ 36500; default null; nullable |
environments[].createdAt | string | Yes | |
environments[].updatedAt | string | Yes |
Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.
GET /v1/admin/projects/{projectId}
Authentication: Console session cookie; console role owner, admin, developer, auditor.
Path parameters
| Field | Type | Required | Notes |
|---|---|---|---|
projectId | string (uuid) | Yes |
Response 200 OK
| Field | Type | Required | Notes |
|---|---|---|---|
id | string (uuid) | Yes | |
slug | string | Yes | |
name | string | Yes | |
status | "active", "disabled" | Yes | |
createdAt | string | Yes | |
environments | object[] | Yes | |
environments[].id | string (uuid) | Yes | |
environments[].projectId | string (uuid) | Yes | |
environments[].environment | "staging", "production" | Yes | |
environments[].status | "active", "disabled" | Yes | |
environments[].allowedOrigins | string[] | Yes | |
environments[].webhookUrl | string or null | Yes | nullable |
environments[].webhookSecretConfigured | boolean | Yes | |
environments[].livekitKeyRef | string | Yes | |
environments[].pushCredentialRef | string or null | Yes | nullable |
environments[].features | object | Yes | |
environments[].features.calls | boolean | No | default true |
environments[].features.livestream | boolean | No | default false |
environments[].features.messaging | boolean | No | default false |
environments[].features.presence | boolean | No | default false |
environments[].features.attachments | boolean | No | default false |
environments[].features.singleDeviceCalls | boolean | No | default false |
environments[].features.push | boolean | No | default false |
environments[].features.recording | boolean | No | default false |
environments[].limits | object | Yes | |
environments[].limits.maxRoomSize | integer | No | ≥ 2; ≤ 1000; default 50 |
environments[].limits.maxConcurrentRooms | integer | No | ≥ 1; ≤ 100000; default 100 |
environments[].limits.tokensPerMinute | integer | No | ≥ 1; ≤ 100000; default 600 |
environments[].messagingPolicy | object | Yes | |
environments[].messagingPolicy.allowDms | boolean | No | default true |
environments[].messagingPolicy.allowGroups | boolean | No | default true |
environments[].messagingPolicy.allowAttachments | boolean | No | default false |
environments[].messagingPolicy.allowThreads | boolean | No | default false |
environments[].messagingPolicy.allowReactions | boolean | No | default true |
environments[].messagingPolicy.maxAttachmentBytes | integer | No | ≥ 1; ≤ 5368709120; default 26214400 |
environments[].messagingPolicy.allowedAttachmentTypes | string[] | No | at most 50 items; default ["image/*","video/mp4","application/pdf"] |
environments[].messagingPolicy.retentionDays | integer or null | No | ≥ 1; ≤ 36500; default null; nullable |
environments[].createdAt | string | Yes | |
environments[].updatedAt | string | Yes |
Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.
PATCH /v1/admin/projects/{projectId}
Authentication: Console session cookie; console role owner, admin.
Path parameters
| Field | Type | Required | Notes |
|---|---|---|---|
projectId | string (uuid) | Yes |
Request body (application/json, required)
| Field | Type | Required | Notes |
|---|---|---|---|
name | string | No | min length 1; max length 100 |
status | "active", "disabled" | No |
Response 200 OK
| Field | Type | Required | Notes |
|---|---|---|---|
id | string (uuid) | Yes | |
slug | string | Yes | |
name | string | Yes | |
status | "active", "disabled" | Yes | |
createdAt | string | Yes | |
environments | object[] | Yes | |
environments[].id | string (uuid) | Yes | |
environments[].projectId | string (uuid) | Yes | |
environments[].environment | "staging", "production" | Yes | |
environments[].status | "active", "disabled" | Yes | |
environments[].allowedOrigins | string[] | Yes | |
environments[].webhookUrl | string or null | Yes | nullable |
environments[].webhookSecretConfigured | boolean | Yes | |
environments[].livekitKeyRef | string | Yes | |
environments[].pushCredentialRef | string or null | Yes | nullable |
environments[].features | object | Yes | |
environments[].features.calls | boolean | No | default true |
environments[].features.livestream | boolean | No | default false |
environments[].features.messaging | boolean | No | default false |
environments[].features.presence | boolean | No | default false |
environments[].features.attachments | boolean | No | default false |
environments[].features.singleDeviceCalls | boolean | No | default false |
environments[].features.push | boolean | No | default false |
environments[].features.recording | boolean | No | default false |
environments[].limits | object | Yes | |
environments[].limits.maxRoomSize | integer | No | ≥ 2; ≤ 1000; default 50 |
environments[].limits.maxConcurrentRooms | integer | No | ≥ 1; ≤ 100000; default 100 |
environments[].limits.tokensPerMinute | integer | No | ≥ 1; ≤ 100000; default 600 |
environments[].messagingPolicy | object | Yes | |
environments[].messagingPolicy.allowDms | boolean | No | default true |
environments[].messagingPolicy.allowGroups | boolean | No | default true |
environments[].messagingPolicy.allowAttachments | boolean | No | default false |
environments[].messagingPolicy.allowThreads | boolean | No | default false |
environments[].messagingPolicy.allowReactions | boolean | No | default true |
environments[].messagingPolicy.maxAttachmentBytes | integer | No | ≥ 1; ≤ 5368709120; default 26214400 |
environments[].messagingPolicy.allowedAttachmentTypes | string[] | No | at most 50 items; default ["image/*","video/mp4","application/pdf"] |
environments[].messagingPolicy.retentionDays | integer or null | No | ≥ 1; ≤ 36500; default null; nullable |
environments[].createdAt | string | Yes | |
environments[].updatedAt | string | Yes |
Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.
POST /v1/admin/projects/{projectId}/environments
Authentication: Console session cookie; console role owner, admin.
Path parameters
| Field | Type | Required | Notes |
|---|---|---|---|
projectId | string (uuid) | Yes |
Request body (application/json, required)
| Field | Type | Required | Notes |
|---|---|---|---|
environment | "staging", "production" | Yes | |
allowedOrigins | string (uri)[] | No | at most 50 items; default [] |
webhookUrl | string (uri) or null | No | default null; nullable |
livekitKeyRef | string | Yes | min length 1; max length 100 |
pushCredentialRef | string or null | No | min length 1; max length 100; default null; nullable |
features | object | No | default {} |
features.calls | boolean | No | default true |
features.livestream | boolean | No | default false |
features.messaging | boolean | No | default false |
features.presence | boolean | No | default false |
features.attachments | boolean | No | default false |
features.singleDeviceCalls | boolean | No | default false |
features.push | boolean | No | default false |
features.recording | boolean | No | default false |
limits | object | No | default {} |
limits.maxRoomSize | integer | No | ≥ 2; ≤ 1000; default 50 |
limits.maxConcurrentRooms | integer | No | ≥ 1; ≤ 100000; default 100 |
limits.tokensPerMinute | integer | No | ≥ 1; ≤ 100000; default 600 |
messagingPolicy | object | No | default {} |
messagingPolicy.allowDms | boolean | No | default true |
messagingPolicy.allowGroups | boolean | No | default true |
messagingPolicy.allowAttachments | boolean | No | default false |
messagingPolicy.allowThreads | boolean | No | default false |
messagingPolicy.allowReactions | boolean | No | default true |
messagingPolicy.maxAttachmentBytes | integer | No | ≥ 1; ≤ 5368709120; default 26214400 |
messagingPolicy.allowedAttachmentTypes | string[] | No | at most 50 items; default ["image/*","video/mp4","application/pdf"] |
messagingPolicy.retentionDays | integer or null | No | ≥ 1; ≤ 36500; default null; nullable |
Response 201 Created
| Field | Type | Required | Notes |
|---|---|---|---|
id | string (uuid) | Yes | |
projectId | string (uuid) | Yes | |
environment | "staging", "production" | Yes | |
status | "active", "disabled" | Yes | |
allowedOrigins | string[] | Yes | |
webhookUrl | string or null | Yes | nullable |
webhookSecretConfigured | boolean | Yes | |
livekitKeyRef | string | Yes | |
pushCredentialRef | string or null | Yes | nullable |
features | object | Yes | |
features.calls | boolean | No | default true |
features.livestream | boolean | No | default false |
features.messaging | boolean | No | default false |
features.presence | boolean | No | default false |
features.attachments | boolean | No | default false |
features.singleDeviceCalls | boolean | No | default false |
features.push | boolean | No | default false |
features.recording | boolean | No | default false |
limits | object | Yes | |
limits.maxRoomSize | integer | No | ≥ 2; ≤ 1000; default 50 |
limits.maxConcurrentRooms | integer | No | ≥ 1; ≤ 100000; default 100 |
limits.tokensPerMinute | integer | No | ≥ 1; ≤ 100000; default 600 |
messagingPolicy | object | Yes | |
messagingPolicy.allowDms | boolean | No | default true |
messagingPolicy.allowGroups | boolean | No | default true |
messagingPolicy.allowAttachments | boolean | No | default false |
messagingPolicy.allowThreads | boolean | No | default false |
messagingPolicy.allowReactions | boolean | No | default true |
messagingPolicy.maxAttachmentBytes | integer | No | ≥ 1; ≤ 5368709120; default 26214400 |
messagingPolicy.allowedAttachmentTypes | string[] | No | at most 50 items; default ["image/*","video/mp4","application/pdf"] |
messagingPolicy.retentionDays | integer or null | No | ≥ 1; ≤ 36500; default null; nullable |
createdAt | string | Yes | |
updatedAt | string | Yes |
Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.
PATCH /v1/admin/projects/{projectId}/environments/{envId}
Authentication: Console session cookie; console role owner, admin.
Path parameters
| Field | Type | Required | Notes |
|---|---|---|---|
projectId | string (uuid) | Yes | |
envId | string (uuid) | Yes |
Request body (application/json, required)
| Field | Type | Required | Notes |
|---|---|---|---|
status | "active", "disabled" | No | |
allowedOrigins | string (uri)[] | No | at most 50 items |
webhookUrl | string (uri) or null | No | nullable |
livekitKeyRef | string | No | min length 1; max length 100 |
pushCredentialRef | string or null | No | min length 1; max length 100; nullable |
features | object | No | |
features.calls | boolean | No | |
features.livestream | boolean | No | |
features.messaging | boolean | No | |
features.presence | boolean | No | |
features.attachments | boolean | No | |
features.singleDeviceCalls | boolean | No | |
features.push | boolean | No | |
features.recording | boolean | No | |
limits | object | No | |
limits.maxRoomSize | integer | No | ≥ 2; ≤ 1000 |
limits.maxConcurrentRooms | integer | No | ≥ 1; ≤ 100000 |
limits.tokensPerMinute | integer | No | ≥ 1; ≤ 100000 |
messagingPolicy | object | No | |
messagingPolicy.allowDms | boolean | No | |
messagingPolicy.allowGroups | boolean | No | |
messagingPolicy.allowAttachments | boolean | No | |
messagingPolicy.allowThreads | boolean | No | |
messagingPolicy.allowReactions | boolean | No | |
messagingPolicy.maxAttachmentBytes | integer | No | ≥ 1; ≤ 5368709120 |
messagingPolicy.allowedAttachmentTypes | string[] | No | at most 50 items |
messagingPolicy.retentionDays | integer or null | No | ≥ 1; ≤ 36500; nullable |
Response 200 OK
| Field | Type | Required | Notes |
|---|---|---|---|
id | string (uuid) | Yes | |
projectId | string (uuid) | Yes | |
environment | "staging", "production" | Yes | |
status | "active", "disabled" | Yes | |
allowedOrigins | string[] | Yes | |
webhookUrl | string or null | Yes | nullable |
webhookSecretConfigured | boolean | Yes | |
livekitKeyRef | string | Yes | |
pushCredentialRef | string or null | Yes | nullable |
features | object | Yes | |
features.calls | boolean | No | default true |
features.livestream | boolean | No | default false |
features.messaging | boolean | No | default false |
features.presence | boolean | No | default false |
features.attachments | boolean | No | default false |
features.singleDeviceCalls | boolean | No | default false |
features.push | boolean | No | default false |
features.recording | boolean | No | default false |
limits | object | Yes | |
limits.maxRoomSize | integer | No | ≥ 2; ≤ 1000; default 50 |
limits.maxConcurrentRooms | integer | No | ≥ 1; ≤ 100000; default 100 |
limits.tokensPerMinute | integer | No | ≥ 1; ≤ 100000; default 600 |
messagingPolicy | object | Yes | |
messagingPolicy.allowDms | boolean | No | default true |
messagingPolicy.allowGroups | boolean | No | default true |
messagingPolicy.allowAttachments | boolean | No | default false |
messagingPolicy.allowThreads | boolean | No | default false |
messagingPolicy.allowReactions | boolean | No | default true |
messagingPolicy.maxAttachmentBytes | integer | No | ≥ 1; ≤ 5368709120; default 26214400 |
messagingPolicy.allowedAttachmentTypes | string[] | No | at most 50 items; default ["image/*","video/mp4","application/pdf"] |
messagingPolicy.retentionDays | integer or null | No | ≥ 1; ≤ 36500; default null; nullable |
createdAt | string | Yes | |
updatedAt | string | Yes |
Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.
POST /v1/admin/projects/{projectId}/environments/{envId}/webhook-secret
Rotate the product webhook signing secret. The secret is shown once.
Authentication: Console session cookie; console role owner, admin.
Path parameters
| Field | Type | Required | Notes |
|---|---|---|---|
projectId | string (uuid) | Yes | |
envId | string (uuid) | Yes |
Response 200 OK
| Field | Type | Required | Notes |
|---|---|---|---|
secret | string | Yes | |
version | integer | Yes |
Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.
GET /v1/admin/projects/{projectId}/keys
Authentication: Console session cookie; console role owner, admin, developer, auditor.
Path parameters
| Field | Type | Required | Notes |
|---|---|---|---|
projectId | string (uuid) | Yes |
Response 200 OK
| Field | Type | Required | Notes |
|---|---|---|---|
[].id | string | Yes | |
[].environmentId | string (uuid) | Yes | |
[].mode | "live", "test" | Yes | |
[].displayName | string | Yes | |
[].prefix | string | Yes | |
[].suffix | string | Yes | |
[].scopes | string[] | Yes | |
[].expiresAt | string or null | Yes | nullable |
[].revokedAt | string or null | Yes | nullable |
[].lastUsedAt | string or null | Yes | nullable |
[].createdBy | string | Yes | |
[].createdAt | string | Yes |
Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.
POST /v1/admin/projects/{projectId}/keys
Create a service key. The secret is returned once and never again.
Authentication: Console session cookie; console role owner, admin.
Path parameters
| Field | Type | Required | Notes |
|---|---|---|---|
projectId | string (uuid) | Yes |
Request body (application/json, required)
| Field | Type | Required | Notes |
|---|---|---|---|
environmentId | string (uuid) | Yes | |
displayName | string | Yes | min length 1; max length 100 |
scopes | "calls:write", "messaging:write", "users:write"[] | No | at least 1 items; default ["calls:write","messaging:write","users:write"] |
expiresAt | string (date-time) or null | No | default null; nullable |
Response 201 Created
| Field | Type | Required | Notes |
|---|---|---|---|
key | object | Yes | |
key.id | string | Yes | |
key.environmentId | string (uuid) | Yes | |
key.mode | "live", "test" | Yes | |
key.displayName | string | Yes | |
key.prefix | string | Yes | |
key.suffix | string | Yes | |
key.scopes | string[] | Yes | |
key.expiresAt | string or null | Yes | nullable |
key.revokedAt | string or null | Yes | nullable |
key.lastUsedAt | string or null | Yes | nullable |
key.createdBy | string | Yes | |
key.createdAt | string | Yes | |
secret | string | Yes |
Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.
POST /v1/admin/projects/{projectId}/keys/{id}/rotate
Create a replacement key; the old key stays active until revoked (zero-downtime rotation).
Authentication: Console session cookie; console role owner, admin.
Path parameters
| Field | Type | Required | Notes |
|---|---|---|---|
projectId | string (uuid) | Yes | |
id | string | Yes | pattern ^[A-Za-z0-9]{12}$ |
Response 201 Created
| Field | Type | Required | Notes |
|---|---|---|---|
key | object | Yes | |
key.id | string | Yes | |
key.environmentId | string (uuid) | Yes | |
key.mode | "live", "test" | Yes | |
key.displayName | string | Yes | |
key.prefix | string | Yes | |
key.suffix | string | Yes | |
key.scopes | string[] | Yes | |
key.expiresAt | string or null | Yes | nullable |
key.revokedAt | string or null | Yes | nullable |
key.lastUsedAt | string or null | Yes | nullable |
key.createdBy | string | Yes | |
key.createdAt | string | Yes | |
secret | string | Yes |
Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.
DELETE /v1/admin/projects/{projectId}/keys/{id}
Revoke a service key (effective on the next request).
Authentication: Console session cookie; console role owner, admin.
Path parameters
| Field | Type | Required | Notes |
|---|---|---|---|
projectId | string (uuid) | Yes | |
id | string | Yes | pattern ^[A-Za-z0-9]{12}$ |
Response 204 No content
Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.
GET /v1/admin/projects/{projectId}/usage
Authentication: Console session cookie; console role owner, admin, developer, auditor.
Path parameters
| Field | Type | Required | Notes |
|---|---|---|---|
projectId | string (uuid) | Yes |
Query parameters
| Field | Type | Required | Notes |
|---|---|---|---|
env | string (uuid) | No | |
from | string (date) | No | |
to | string (date) | No |
Response 200 OK
| Field | Type | Required | Notes |
|---|---|---|---|
[].environmentId | string (uuid) | Yes | |
[].date | string | Yes | |
[].callCount | number | Yes | |
[].participantMinutes | number | Yes | |
[].peakParticipants | number | Yes | |
[].apiRequests | number | Yes | |
[].apiErrors | number | Yes | |
[].tokensIssued | number | Yes | |
[].messagesSent | number | Yes |
Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.
GET /v1/admin/projects/{projectId}/usage/export
Daily usage as CSV (at most 400 days). Built on the server and recorded in the audit log.
Authentication: Console session cookie; console role owner, admin, developer, auditor.
Path parameters
| Field | Type | Required | Notes |
|---|---|---|---|
projectId | string (uuid) | Yes |
Query parameters
| Field | Type | Required | Notes |
|---|---|---|---|
env | string (uuid) | No | |
from | string (date) | No | |
to | string (date) | No |
Response 200 CSV
Body: string
Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.
GET /v1/admin/projects/{projectId}/webhook-deliveries
Pending or dead-lettered outbound webhook deliveries.
Authentication: Console session cookie; console role owner, admin, developer, auditor.
Path parameters
| Field | Type | Required | Notes |
|---|---|---|---|
projectId | string (uuid) | Yes |
Query parameters
| Field | Type | Required | Notes |
|---|---|---|---|
status | "pending", "dead" | No | default "dead" |
Response 200 OK
| Field | Type | Required | Notes |
|---|---|---|---|
[].id | string (uuid) | Yes | |
[].environmentId | string (uuid) | Yes | |
[].type | string | Yes | |
[].attempts | integer | Yes | |
[].lastError | string or null | Yes | nullable |
[].createdAt | string | Yes | |
[].availableAt | string | Yes | |
[].deliveredAt | string or null | Yes | nullable |
[].deadAt | string or null | Yes | nullable |
Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.
GET /v1/admin/projects/{projectId}/operations
Recent push deliveries, recordings and attachment scan results (no secrets or content).
Authentication: Console session cookie; console role owner, admin, developer, auditor.
Path parameters
| Field | Type | Required | Notes |
|---|---|---|---|
projectId | string (uuid) | Yes |
Response 200 OK
| Field | Type | Required | Notes |
|---|---|---|---|
pushDeliveries | object[] | Yes | |
pushDeliveries[].id | string (uuid) | Yes | |
pushDeliveries[].environmentId | string (uuid) | Yes | |
pushDeliveries[].provider | "fcm", "apns", "apns_voip" | Yes | |
pushDeliveries[].kind | string | Yes | |
pushDeliveries[].status | "pending", "sent", "failed", "dead" | Yes | |
pushDeliveries[].attempts | integer | Yes | |
pushDeliveries[].lastError | string or null | Yes | nullable |
pushDeliveries[].createdAt | string | Yes | |
pushDeliveries[].sentAt | string or null | Yes | nullable |
recordings | object[] | Yes | |
recordings[].id | string (uuid) | Yes | |
recordings[].callId | string (uuid) | Yes | |
recordings[].kind | "room_composite", "participant", "audio_only" | Yes | |
recordings[].outputs | string[] | Yes | |
recordings[].status | "starting", "active", "ending", "complete", "failed", "aborted", "deleted" | Yes | |
recordings[].files | object[] | Yes | |
recordings[].files[].name | string | Yes | |
recordings[].files[].size | integer or null | Yes | nullable |
recordings[].files[].durationMs | integer or null | Yes | nullable |
recordings[].error | string or null | Yes | nullable |
recordings[].startedAt | string or null | Yes | nullable |
recordings[].endedAt | string or null | Yes | nullable |
recordings[].expiresAt | string or null | Yes | nullable |
recordings[].createdAt | string | Yes | |
scans | object | Yes | |
scans.counts | map | Yes | |
scans.recent | object[] | Yes | |
scans.recent[].id | string (uuid) | Yes | |
scans.recent[].environmentId | string (uuid) | Yes | |
scans.recent[].scanStatus | string | Yes | |
scans.recent[].detectedType | string or null | Yes | nullable |
scans.recent[].scanDetail | string or null | Yes | nullable |
scans.recent[].size | integer | Yes | |
scans.recent[].scannedAt | string or null | Yes | nullable |
Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.
POST /v1/admin/projects/{projectId}/webhook-deliveries/{eventId}/retry
Authentication: Console session cookie; console role owner, admin.
Path parameters
| Field | Type | Required | Notes |
|---|---|---|---|
projectId | string (uuid) | Yes | |
eventId | string (uuid) | Yes |
Response 204 No content
Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.
GET /v1/admin/audit-logs
Authentication: Console session cookie; console role owner, admin, auditor.
Query parameters
| Field | Type | Required | Notes |
|---|---|---|---|
projectId | string (uuid) | No | |
action | string | No | max length 100 |
actor | string | No | max length 320 |
from | string (date-time) | No | |
to | string (date-time) | No | |
before | string | No | max length 200 |
limit | integer | No | ≥ 1; ≤ 200; default 50 |
Response 200 OK
| Field | Type | Required | Notes |
|---|---|---|---|
items | object[] | Yes | |
items[].id | string (uuid) | Yes | |
items[].actor | string | Yes | |
items[].projectId | string or null | Yes | nullable |
items[].action | string | Yes | |
items[].targetType | string | Yes | |
items[].targetId | string or null | Yes | nullable |
items[].ip | string or null | Yes | nullable |
items[].userAgent | string or null | Yes | nullable |
items[].requestId | string or null | Yes | nullable |
items[].metadata | map | Yes | |
items[].createdAt | string | Yes | |
nextBefore | string or null | Yes | nullable |
Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.
GET /v1/admin/roles
Authentication: Console session cookie; console role owner, admin, auditor.
Response 200 OK
| Field | Type | Required | Notes |
|---|---|---|---|
[].id | string (uuid) | Yes | |
[].email | string | Yes | |
[].role | "owner", "admin", "developer", "auditor" | Yes | |
[].projectId | string or null | Yes | nullable |
[].createdAt | string | Yes | |
[].lastActivityAt | string or null | No | nullable |
Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.
POST /v1/admin/roles
Authentication: Console session cookie; console role owner.
Request body (application/json, required)
| Field | Type | Required | Notes |
|---|---|---|---|
email | string (email) | Yes | |
role | "owner", "admin", "developer", "auditor" | Yes | |
projectId | string (uuid) or null | No | default null; nullable |
Response 201 Created
| Field | Type | Required | Notes |
|---|---|---|---|
id | string (uuid) | Yes | |
email | string | Yes | |
role | "owner", "admin", "developer", "auditor" | Yes | |
projectId | string or null | Yes | nullable |
createdAt | string | Yes | |
lastActivityAt | string or null | No | nullable |
Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.
DELETE /v1/admin/roles/{id}
Authentication: Console session cookie; console role owner.
Path parameters
| Field | Type | Required | Notes |
|---|---|---|---|
id | string (uuid) | Yes |
Response 204 No content
Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.
GET /v1/admin/me/sessions
The signed-in user's active console sessions.
Authentication: Console session cookie; console role owner, admin, developer, auditor.
Response 200 OK
| Field | Type | Required | Notes |
|---|---|---|---|
items | object[] | Yes | |
items[].id | string | Yes | |
items[].current | boolean | Yes | |
items[].createdAt | string | Yes | |
items[].lastSeenAt | string | Yes | |
items[].expiresAt | string | Yes | |
items[].ip | string or null | Yes | nullable |
items[].userAgent | string or null | Yes | nullable |
Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.
DELETE /v1/admin/me/sessions/{id}
End one of the signed-in user's own sessions (signs that browser out).
Authentication: Console session cookie; console role owner, admin, developer, auditor.
Path parameters
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | Yes | pattern ^[A-Za-z0-9_-]{43}$ |
Response 204 No content
Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.
GET /v1/admin/me/activity
The signed-in user's recent sign-ins, failed sign-ins, sign-outs and revocations.
Authentication: Console session cookie; console role owner, admin, developer, auditor.
Response 200 OK
| Field | Type | Required | Notes |
|---|---|---|---|
items | object[] | Yes | |
items[].id | string (uuid) | Yes | |
items[].actor | string | Yes | |
items[].projectId | string or null | Yes | nullable |
items[].action | string | Yes | |
items[].targetType | string | Yes | |
items[].targetId | string or null | Yes | nullable |
items[].ip | string or null | Yes | nullable |
items[].userAgent | string or null | Yes | nullable |
items[].requestId | string or null | Yes | nullable |
items[].metadata | map | Yes | |
items[].createdAt | string | Yes |
Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.
GET /v1/admin/usage
Usage over time for every readable project (or one project or environment), in hourly (up to 7 days, last 35 days) or daily (up to 400 days) buckets, with per-project totals.
Authentication: Console session cookie; console role owner, admin, developer, auditor.
Query parameters
| Field | Type | Required | Notes |
|---|---|---|---|
bucket | "hour", "day" | No | default "day" |
from | string | Yes | max length 40 |
to | string | Yes | max length 40 |
project | string (uuid) | No | |
env | string (uuid) | No |
Response 200 OK
| Field | Type | Required | Notes |
|---|---|---|---|
bucket | "hour", "day" | Yes | |
from | string | Yes | |
to | string | Yes | |
since | string or null | Yes | nullable |
points | object[] | Yes | |
points[].callCount | number | Yes | |
points[].participantMinutes | number | Yes | |
points[].peakParticipants | number | Yes | |
points[].messagesSent | number | Yes | |
points[].tokensIssued | number | Yes | |
points[].apiRequests | number | Yes | |
points[].apiErrors | number | Yes | |
points[].bucket | string | Yes | |
totals | object | Yes | |
totals.callCount | number | Yes | |
totals.participantMinutes | number | Yes | |
totals.peakParticipants | number | Yes | |
totals.messagesSent | number | Yes | |
totals.tokensIssued | number | Yes | |
totals.apiRequests | number | Yes | |
totals.apiErrors | number | Yes | |
byProject | object[] | Yes | |
byProject[].callCount | number | Yes | |
byProject[].participantMinutes | number | Yes | |
byProject[].peakParticipants | number | Yes | |
byProject[].messagesSent | number | Yes | |
byProject[].tokensIssued | number | Yes | |
byProject[].apiRequests | number | Yes | |
byProject[].apiErrors | number | Yes | |
byProject[].projectId | string (uuid) | Yes |
Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.
GET /v1/admin/live
Current activity per readable project: active calls and livestreams, connected participants, livestream audience, possibly stale calls and webhook backlog.
Authentication: Console session cookie; console role owner, admin, developer, auditor.
Response 200 OK
| Field | Type | Required | Notes |
|---|---|---|---|
generatedAt | string | Yes | |
projects | object[] | Yes | |
projects[].projectId | string (uuid) | Yes | |
projects[].activeCalls | integer | Yes | |
projects[].livestreams | integer | Yes | |
projects[].connectedParticipants | integer | Yes | |
projects[].livestreamAudience | integer | Yes | |
projects[].staleCalls | integer | Yes | |
projects[].webhooksPending | integer | Yes | |
projects[].webhooksDead | integer | Yes |
Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.
GET /v1/admin/projects/{projectId}/calls
Calls and livestreams, newest first, with connected and total participant counts.
Authentication: Console session cookie; console role owner, admin, developer, auditor.
Path parameters
| Field | Type | Required | Notes |
|---|---|---|---|
projectId | string (uuid) | Yes |
Query parameters
| Field | Type | Required | Notes |
|---|---|---|---|
status | "active", "ended", "all" | No | default "active" |
type | "one_to_one", "group", "livestream" | No | |
env | string (uuid) | No | |
q | string | No | max length 128 |
cursor | string | No | max length 200 |
limit | integer | No | ≥ 1; ≤ 100; default 50 |
Response 200 OK
| Field | Type | Required | Notes |
|---|---|---|---|
items | object[] | Yes | |
items[].id | string (uuid) | Yes | |
items[].environmentId | string (uuid) | Yes | |
items[].tenantId | string | Yes | |
items[].productCallId | string | Yes | |
items[].type | "one_to_one", "group", "livestream" | Yes | |
items[].status | "active", "ended" | Yes | |
items[].maxParticipants | integer | Yes | |
items[].e2ee | boolean | Yes | |
items[].startedAt | string | Yes | |
items[].endedAt | string or null | Yes | nullable |
items[].durationSeconds | integer | Yes | |
items[].connected | integer | Yes | |
items[].participantSessions | integer | Yes | |
items[].stale | boolean | Yes | |
nextCursor | string or null | Yes | nullable |
Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.
GET /v1/admin/projects/{projectId}/calls/{callId}
One call with its participant sessions (identities only; no media or messages).
Authentication: Console session cookie; console role owner, admin, developer, auditor.
Path parameters
| Field | Type | Required | Notes |
|---|---|---|---|
projectId | string (uuid) | Yes | |
callId | string (uuid) | Yes |
Response 200 OK
| Field | Type | Required | Notes |
|---|---|---|---|
call | object | Yes | |
call.id | string (uuid) | Yes | |
call.environmentId | string (uuid) | Yes | |
call.tenantId | string | Yes | |
call.productCallId | string | Yes | |
call.type | "one_to_one", "group", "livestream" | Yes | |
call.status | "active", "ended" | Yes | |
call.maxParticipants | integer | Yes | |
call.e2ee | boolean | Yes | |
call.startedAt | string | Yes | |
call.endedAt | string or null | Yes | nullable |
call.durationSeconds | integer | Yes | |
call.connected | integer | Yes | |
call.participantSessions | integer | Yes | |
call.stale | boolean | Yes | |
participants | object[] | Yes | |
participants[].identity | string | Yes | |
participants[].userId | string | Yes | |
participants[].deviceId | string | Yes | |
participants[].joinedAt | string | Yes | |
participants[].leftAt | string or null | Yes | nullable |
participants[].durationSeconds | integer | Yes | |
participantTotal | integer | Yes |
Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.
POST /v1/admin/projects/{projectId}/calls/{callId}/end
End a call for everyone: disconnects participants, stops new join tokens and sends call.ended (reason ended_by_console).
Authentication: Console session cookie; console role owner, admin.
Path parameters
| Field | Type | Required | Notes |
|---|---|---|---|
projectId | string (uuid) | Yes | |
callId | string (uuid) | Yes |
Response 204 No content
Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.
POST /v1/admin/projects/{projectId}/calls/{callId}/participants/{identity}/remove
Disconnect one participant device from an active call.
Authentication: Console session cookie; console role owner, admin.
Path parameters
| Field | Type | Required | Notes |
|---|---|---|---|
projectId | string (uuid) | Yes | |
callId | string (uuid) | Yes | |
identity | string | Yes | min length 3; max length 400 |
Response 204 No content
Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.
GET /v1/admin/projects/{projectId}/live
Current activity per environment: active calls by type, connected participants, livestream audience, possibly stale calls, quota limits and webhook backlog.
Authentication: Console session cookie; console role owner, admin, developer, auditor.
Path parameters
| Field | Type | Required | Notes |
|---|---|---|---|
projectId | string (uuid) | Yes |
Response 200 OK
| Field | Type | Required | Notes |
|---|---|---|---|
generatedAt | string | Yes | |
environments | object[] | Yes | |
environments[].environmentId | string (uuid) | Yes | |
environments[].environment | "staging", "production" | Yes | |
environments[].activeCalls | object | Yes | |
environments[].activeCalls.total | integer | Yes | |
environments[].activeCalls.one_to_one | integer | Yes | |
environments[].activeCalls.group | integer | Yes | |
environments[].activeCalls.livestream | integer | Yes | |
environments[].connectedParticipants | integer | Yes | |
environments[].livestreamAudience | integer | Yes | |
environments[].staleCalls | integer | Yes | |
environments[].limits | object | Yes | |
environments[].limits.maxRoomSize | integer | No | ≥ 2; ≤ 1000; default 50 |
environments[].limits.maxConcurrentRooms | integer | No | ≥ 1; ≤ 100000; default 100 |
environments[].limits.tokensPerMinute | integer | No | ≥ 1; ≤ 100000; default 600 |
environments[].webhooks | object | Yes | |
environments[].webhooks.pending | integer | Yes | |
environments[].webhooks.dead | integer | Yes | |
environments[].webhooks.oldestPendingAt | string or null | Yes | nullable |
Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.
GET /v1/admin/projects/{projectId}/webhook-events
Outbound webhook deliveries by status (pending, dead or delivered), newest first, paginated. Payloads and secrets are never returned.
Authentication: Console session cookie; console role owner, admin, developer, auditor.
Path parameters
| Field | Type | Required | Notes |
|---|---|---|---|
projectId | string (uuid) | Yes |
Query parameters
| Field | Type | Required | Notes |
|---|---|---|---|
status | "pending", "dead", "delivered" | No | default "dead" |
env | string (uuid) | No | |
cursor | string | No | max length 200 |
limit | integer | No | ≥ 1; ≤ 100; default 50 |
Response 200 OK
| Field | Type | Required | Notes |
|---|---|---|---|
items | object[] | Yes | |
items[].id | string (uuid) | Yes | |
items[].environmentId | string (uuid) | Yes | |
items[].type | string | Yes | |
items[].attempts | integer | Yes | |
items[].lastError | string or null | Yes | nullable |
items[].createdAt | string | Yes | |
items[].availableAt | string | Yes | |
items[].deliveredAt | string or null | Yes | nullable |
items[].deadAt | string or null | Yes | nullable |
nextCursor | string or null | Yes | nullable |
Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.