Skip to Content
LYNKORIADocs
HTTP API reference

Calls

Create calls and livestreams, issue join tokens, end calls and manage participants. Generated from the OpenAPI specification.

Create calls and livestreams, issue join tokens, end calls and manage participants.

POST /v1/calls

Create a call and its LiveKit room (idempotent on productCallId).

Authentication: Service key with scope calls:write (Authorization: Bearer lynk_…), from your backend only.

Request body (application/json, required)

FieldTypeRequiredNotes
productCallIdstringYespattern ^[A-Za-z0-9._@-]{1,128}$
tenantIdstringNopattern ^[A-Za-z0-9._@-]{1,128}$; default "default"
type"one_to_one", "group", "livestream"Nodefault "group"
maxParticipantsintegerNo≥ 2; ≤ 1000
emptyTimeoutSecintegerNo≥ 10; ≤ 3600; default 300
departureTimeoutSecintegerNo≥ 0; ≤ 3600; default 20
e2eebooleanNodefault false

Response 200 Existing active call

FieldTypeRequiredNotes
idstring (uuid)Yes
productCallIdstringYes
tenantIdstringYes
type"one_to_one", "group", "livestream"Yes
roomNamestringYes
status"active", "ended"Yes
maxParticipantsintegerYes
e2eebooleanYes
createdAtstringYes
endedAtstring or nullYesnullable

Response 201 Created

Same body as 200.

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/calls/{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
productCallIdstringYes
tenantIdstringYes
type"one_to_one", "group", "livestream"Yes
roomNamestringYes
status"active", "ended"Yes
maxParticipantsintegerYes
e2eebooleanYes
createdAtstringYes
endedAtstring or nullYesnullable

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}/join-token

Issue a 5-minute, device-scoped LiveKit token for a user the product has authorized.

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
userIdstringYespattern ^[A-Za-z0-9._@-]{1,128}$
deviceIdstringYespattern ^[A-Za-z0-9._@-]{1,128}$
displayNamestringYesmin length 1; max length 128
role"host", "speaker", "viewer", "participant"Nodefault "participant"

Response 200 OK

FieldTypeRequiredNotes
urlstringYes
tokenstringYes
identitystringYes
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.

POST /v1/calls/{id}/end

Stop token issuance and delete the room.

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
productCallIdstringYes
tenantIdstringYes
type"one_to_one", "group", "livestream"Yes
roomNamestringYes
status"active", "ended"Yes
maxParticipantsintegerYes
e2eebooleanYes
createdAtstringYes
endedAtstring or nullYesnullable

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}/participants/{pid}/remove

Remove a participant (by identity) and invalidate its earlier tokens.

Authentication: Service key with scope calls:write (Authorization: Bearer lynk_…), from your backend only.

Path parameters

FieldTypeRequiredNotes
idstring (uuid)Yes
pidstringYesmin length 1; 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.

POST /v1/calls/{id}/participants/{pid}/permissions

Change a livestream participant role (e.g. promote a viewer to speaker).

Authentication: Service key with scope calls:write (Authorization: Bearer lynk_…), from your backend only.

Path parameters

FieldTypeRequiredNotes
idstring (uuid)Yes
pidstringYesmin length 1; max length 400

Request body (application/json, required)

FieldTypeRequiredNotes
role"host", "speaker", "viewer", "participant"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/calls/{id}/signal

Send an incoming-call signal (call:invited, call:ringing, ...) to users' foreground sockets.

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
type"invited", "ringing", "accepted", "declined", "ended"Yes
toUserIdsstring[]Yesat least 1 items; at most 1000 items
fromUserIdstringNopattern ^[A-Za-z0-9._@-]{1,128}$
datamapNo

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.

On this page