Skip to Content
LYNKORIADocs
HTTP API reference

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

FieldTypeRequiredNotes
idstring (uuid)Yes

Response 200 OK

FieldTypeRequiredNotes
recordingsobject[]Yes
recordings[].idstring (uuid)Yes
recordings[].callIdstring (uuid)Yes
recordings[].kind"room_composite", "participant", "audio_only"Yes
recordings[].outputsstring[]Yes
recordings[].status"starting", "active", "ending", "complete", "failed", "aborted", "deleted"Yes
recordings[].filesobject[]Yes
recordings[].files[].namestringYes
recordings[].files[].sizeinteger or nullYesnullable
recordings[].files[].durationMsinteger or nullYesnullable
recordings[].errorstring or nullYesnullable
recordings[].startedAtstring or nullYesnullable
recordings[].endedAtstring or nullYesnullable
recordings[].expiresAtstring or nullYesnullable
recordings[].createdAtstringYes

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

FieldTypeRequiredNotes
idstring (uuid)Yes

Request body (application/json, required)

FieldTypeRequiredNotes
kind"room_composite", "participant", "audio_only"Nodefault "room_composite"
participantIdentitystringNomin length 1; max length 400
outputs"mp4", "ogg", "hls"[]Noat least 1 items; at most 2 items; default ["mp4"]
rtmpUrlsstring (uri)[]Noat most 3 items; default []
layout"grid", "speaker", "single-speaker"Nodefault "grid"

Response 201 Started

FieldTypeRequiredNotes
idstring (uuid)Yes
callIdstring (uuid)Yes
kind"room_composite", "participant", "audio_only"Yes
outputsstring[]Yes
status"starting", "active", "ending", "complete", "failed", "aborted", "deleted"Yes
filesobject[]Yes
files[].namestringYes
files[].sizeinteger or nullYesnullable
files[].durationMsinteger or nullYesnullable
errorstring or nullYesnullable
startedAtstring or nullYesnullable
endedAtstring or nullYesnullable
expiresAtstring or nullYesnullable
createdAtstringYes

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

FieldTypeRequiredNotes
idstring (uuid)Yes

Response 200 OK

FieldTypeRequiredNotes
idstring (uuid)Yes
callIdstring (uuid)Yes
kind"room_composite", "participant", "audio_only"Yes
outputsstring[]Yes
status"starting", "active", "ending", "complete", "failed", "aborted", "deleted"Yes
filesobject[]Yes
files[].namestringYes
files[].sizeinteger or nullYesnullable
files[].durationMsinteger or nullYesnullable
errorstring or nullYesnullable
startedAtstring or nullYesnullable
endedAtstring or nullYesnullable
expiresAtstring or nullYesnullable
createdAtstringYes

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

FieldTypeRequiredNotes
idstring (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

FieldTypeRequiredNotes
idstring (uuid)Yes

Response 200 OK

FieldTypeRequiredNotes
idstring (uuid)Yes
callIdstring (uuid)Yes
kind"room_composite", "participant", "audio_only"Yes
outputsstring[]Yes
status"starting", "active", "ending", "complete", "failed", "aborted", "deleted"Yes
filesobject[]Yes
files[].namestringYes
files[].sizeinteger or nullYesnullable
files[].durationMsinteger or nullYesnullable
errorstring or nullYesnullable
startedAtstring or nullYesnullable
endedAtstring or nullYesnullable
expiresAtstring or nullYesnullable
createdAtstringYes

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

FieldTypeRequiredNotes
idstring (uuid)Yes

Query parameters

FieldTypeRequiredNotes
filestringYesmin length 1; max length 300

Response 200 OK

FieldTypeRequiredNotes
urlstringYes
expiresAtstringYes

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.

On this page