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)
| Field | Type | Required | Notes |
|---|---|---|---|
productCallId | string | Yes | pattern ^[A-Za-z0-9._@-]{1,128}$ |
tenantId | string | No | pattern ^[A-Za-z0-9._@-]{1,128}$; default "default" |
type | "one_to_one", "group", "livestream" | No | default "group" |
maxParticipants | integer | No | ≥ 2; ≤ 1000 |
emptyTimeoutSec | integer | No | ≥ 10; ≤ 3600; default 300 |
departureTimeoutSec | integer | No | ≥ 0; ≤ 3600; default 20 |
e2ee | boolean | No | default false |
Response 200 Existing active call
| Field | Type | Required | Notes |
|---|---|---|---|
id | string (uuid) | Yes | |
productCallId | string | Yes | |
tenantId | string | Yes | |
type | "one_to_one", "group", "livestream" | Yes | |
roomName | string | Yes | |
status | "active", "ended" | Yes | |
maxParticipants | integer | Yes | |
e2ee | boolean | Yes | |
createdAt | string | Yes | |
endedAt | string or null | Yes | nullable |
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
| Field | Type | Required | Notes |
|---|---|---|---|
id | string (uuid) | Yes |
Response 200 OK
| Field | Type | Required | Notes |
|---|---|---|---|
id | string (uuid) | Yes | |
productCallId | string | Yes | |
tenantId | string | Yes | |
type | "one_to_one", "group", "livestream" | Yes | |
roomName | string | Yes | |
status | "active", "ended" | Yes | |
maxParticipants | integer | Yes | |
e2ee | boolean | Yes | |
createdAt | string | Yes | |
endedAt | 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/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
| Field | Type | Required | Notes |
|---|---|---|---|
id | string (uuid) | Yes |
Request body (application/json, required)
| Field | Type | Required | Notes |
|---|---|---|---|
userId | string | Yes | pattern ^[A-Za-z0-9._@-]{1,128}$ |
deviceId | string | Yes | pattern ^[A-Za-z0-9._@-]{1,128}$ |
displayName | string | Yes | min length 1; max length 128 |
role | "host", "speaker", "viewer", "participant" | No | default "participant" |
Response 200 OK
| Field | Type | Required | Notes |
|---|---|---|---|
url | string | Yes | |
token | string | Yes | |
identity | 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.
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
| Field | Type | Required | Notes |
|---|---|---|---|
id | string (uuid) | Yes |
Response 200 OK
| Field | Type | Required | Notes |
|---|---|---|---|
id | string (uuid) | Yes | |
productCallId | string | Yes | |
tenantId | string | Yes | |
type | "one_to_one", "group", "livestream" | Yes | |
roomName | string | Yes | |
status | "active", "ended" | Yes | |
maxParticipants | integer | Yes | |
e2ee | boolean | Yes | |
createdAt | string | Yes | |
endedAt | 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/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
| Field | Type | Required | Notes |
|---|---|---|---|
id | string (uuid) | Yes | |
pid | string | Yes | min 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
| Field | Type | Required | Notes |
|---|---|---|---|
id | string (uuid) | Yes | |
pid | string | Yes | min length 1; max length 400 |
Request body (application/json, required)
| Field | Type | Required | Notes |
|---|---|---|---|
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
| Field | Type | Required | Notes |
|---|---|---|---|
id | string (uuid) | Yes |
Request body (application/json, required)
| Field | Type | Required | Notes |
|---|---|---|---|
type | "invited", "ringing", "accepted", "declined", "ended" | Yes | |
toUserIds | string[] | Yes | at least 1 items; at most 1000 items |
fromUserId | string | No | pattern ^[A-Za-z0-9._@-]{1,128}$ |
data | map | No |
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.