Recordings
Server-side recording and streaming through LiveKit Egress. Generated from the OpenAPI specification.
Server-side recording and streaming through LiveKit Egress.
GET /v1/calls/{id}/recordings
Authentication: Service key with scope calls:write (Authorization: Bearer lynk_…), from your backend only.
Path parameters
| Field | Type | Required | Notes |
|---|---|---|---|
id | string (uuid) | Yes |
Response 200 OK
| Field | Type | Required | Notes |
|---|---|---|---|
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 |
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/calls/{id}/recordings
Start recording or streaming a call through LiveKit Egress (refused for E2EE calls).
Authentication: Service key with scope calls:write (Authorization: Bearer lynk_…), from your backend only.
Path parameters
| Field | Type | Required | Notes |
|---|---|---|---|
id | string (uuid) | Yes |
Request body (application/json, required)
| Field | Type | Required | Notes |
|---|---|---|---|
kind | "room_composite", "participant", "audio_only" | No | default "room_composite" |
participantIdentity | string | No | min length 1; max length 400 |
outputs | "mp4", "ogg", "hls"[] | No | at least 1 items; at most 2 items; default ["mp4"] |
rtmpUrls | string (uri)[] | No | at most 3 items; default [] |
layout | "grid", "speaker", "single-speaker" | No | default "grid" |
Response 201 Started
| Field | Type | Required | Notes |
|---|---|---|---|
id | string (uuid) | Yes | |
callId | string (uuid) | Yes | |
kind | "room_composite", "participant", "audio_only" | Yes | |
outputs | string[] | Yes | |
status | "starting", "active", "ending", "complete", "failed", "aborted", "deleted" | Yes | |
files | object[] | Yes | |
files[].name | string | Yes | |
files[].size | integer or null | Yes | nullable |
files[].durationMs | integer or null | Yes | nullable |
error | string or null | Yes | nullable |
startedAt | string or null | Yes | nullable |
endedAt | string or null | Yes | nullable |
expiresAt | string or null | Yes | nullable |
createdAt | string | Yes |
Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 409 Invalid request · 429 Rate limit or quota exceeded. Error bodies follow the error format.
GET /v1/recordings/{id}
Authentication: Service key with scope calls:write (Authorization: Bearer lynk_…), from your backend only.
Path parameters
| Field | Type | Required | Notes |
|---|---|---|---|
id | string (uuid) | Yes |
Response 200 OK
| Field | Type | Required | Notes |
|---|---|---|---|
id | string (uuid) | Yes | |
callId | string (uuid) | Yes | |
kind | "room_composite", "participant", "audio_only" | Yes | |
outputs | string[] | Yes | |
status | "starting", "active", "ending", "complete", "failed", "aborted", "deleted" | Yes | |
files | object[] | Yes | |
files[].name | string | Yes | |
files[].size | integer or null | Yes | nullable |
files[].durationMs | integer or null | Yes | nullable |
error | string or null | Yes | nullable |
startedAt | string or null | Yes | nullable |
endedAt | string or null | Yes | nullable |
expiresAt | string or null | Yes | nullable |
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.
DELETE /v1/recordings/{id}
Delete a finished recording and every stored file.
Authentication: Service key with scope calls:write (Authorization: Bearer lynk_…), from your backend only.
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.
POST /v1/recordings/{id}/stop
Authentication: Service key with scope calls:write (Authorization: Bearer lynk_…), from your backend only.
Path parameters
| Field | Type | Required | Notes |
|---|---|---|---|
id | string (uuid) | Yes |
Response 200 OK
| Field | Type | Required | Notes |
|---|---|---|---|
id | string (uuid) | Yes | |
callId | string (uuid) | Yes | |
kind | "room_composite", "participant", "audio_only" | Yes | |
outputs | string[] | Yes | |
status | "starting", "active", "ending", "complete", "failed", "aborted", "deleted" | Yes | |
files | object[] | Yes | |
files[].name | string | Yes | |
files[].size | integer or null | Yes | nullable |
files[].durationMs | integer or null | Yes | nullable |
error | string or null | Yes | nullable |
startedAt | string or null | Yes | nullable |
endedAt | string or null | Yes | nullable |
expiresAt | string or null | Yes | nullable |
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/recordings/{id}/download
A 5-minute presigned URL for one output file of a completed recording.
Authentication: Service key with scope calls:write (Authorization: Bearer lynk_…), from your backend only.
Path parameters
| Field | Type | Required | Notes |
|---|---|---|---|
id | string (uuid) | Yes |
Query parameters
| Field | Type | Required | Notes |
|---|---|---|---|
file | string | Yes | min length 1; max length 300 |
Response 200 OK
| Field | Type | Required | Notes |
|---|---|---|---|
url | string | Yes | |
expiresAt | 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.
Push notifications
Device registration, notification preferences and sending notifications. Generated from the OpenAPI specification.
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.