LiveKit

App · 20 actions

LiveKit room, participant, ingress and agent dispatch Twirp APIs.

Actions

ActionWhat it does
Create agent dispatchCreate agent dispatch.
Create ingressCreate ingress.
Create roomCreate room.
Delete agent dispatchDelete agent dispatch.
Delete ingressDelete ingress.
Delete roomDelete room.
Forward participantForward participant.
Get participantGet participant.
List agent dispatchesList agent dispatches.
List ingressList ingress.
List participantsList participants.
List roomsList rooms.
Move participantMove participant.
Mute trackMute track.
Remove participantRemove participant.
Send dataSend data.
Update ingressUpdate ingress.
Update participantUpdate participant.
Update room metadataUpdate room metadata.
Update subscriptionsUpdate subscriptions.

Create agent dispatch

Create agent dispatch.

Inputs

RoomroomtextRequired
Room.
Agent nameagent_nametextRequired
Agent name.
Metadatametadatatext
Metadata.

Outputs

dataobject
Api result.
Example output
{
  "data": {
    "agent_name": "example",
    "id": "example",
    "metadata": "example",
    "room": "example"
  }
}

Create ingress

Create ingress.

Inputs

Input typeinput_typenumberRequired
Input type.One of: 0 (RTMP), 1 (WHIP), 2 (URL).
NamenametextRequired
Name.
Room nameroom_nametextRequired
Room name.
Participant identityparticipant_identitytextRequired
Participant identity.
Participant nameparticipant_nametext
Participant name.
Urlurltext
Url.
Enable transcodingenable_transcodingtrue/false
Enable transcoding.

Outputs

dataobject
Api result.
Example output
{
  "data": {
    "ingress_id": "example",
    "name": "example",
    "participant_identity": "example",
    "room_name": "example",
    "state": {},
    "stream_key": "example",
    "url": "example"
  }
}

Create room

Create room.

Inputs

NamenametextRequired
Name.
Empty timeoutempty_timeoutnumber
Empty timeout.At least 0.
Departure timeoutdeparture_timeoutnumber
Departure timeout.At least 0.
Max participantsmax_participantsnumber
Max participants.At least 0.
Metadatametadatatext
Metadata.

Outputs

dataobject
Api result.
Example output
{
  "data": {
    "creation_time": "example",
    "metadata": "example",
    "name": "example",
    "num_participants": 1,
    "sid": "example"
  }
}

Delete agent dispatch

Delete agent dispatch.

Inputs

RoomroomtextRequired
Room.
Dispatch iddispatch_idtextRequired
Dispatch id.

Outputs

dataobject
Api result.
Example output
{
  "data": {
    "agent_name": "example",
    "id": "example",
    "metadata": "example",
    "room": "example"
  }
}

Delete ingress

Delete ingress.

Inputs

Ingress idingress_idtextRequired
Ingress id.

Outputs

dataobject
Api result.
Example output
{
  "data": {
    "ingress_id": "example",
    "name": "example",
    "participant_identity": "example",
    "room_name": "example",
    "state": {},
    "stream_key": "example",
    "url": "example"
  }
}

Delete room

Delete room.

Inputs

RoomroomtextRequired
Room.

Outputs

dataobject
Api result.
Example output
{
  "data": {}
}

Forward participant

Forward participant.

Inputs

RoomroomtextRequired
Room.
ParticipantidentitytextRequired
Identity.
Destination roomdestination_roomtextRequired
Destination room.

Outputs

dataobject
Api result.
Example output
{
  "data": {}
}

Get participant

Get participant.

Inputs

RoomroomtextRequired
Room.
ParticipantidentitytextRequired
Identity.

Outputs

dataobject
Api result.
Example output
{
  "data": {
    "identity": "example",
    "metadata": "example",
    "name": "example",
    "sid": "example",
    "state": "example",
    "tracks": []
  }
}

List agent dispatches

List agent dispatches.

Inputs

RoomroomtextRequired
Room.

Outputs

dataobject
Api result.
Example output
{
  "data": {
    "agent_dispatches": []
  }
}

List ingress

List ingress.

Inputs

Room nameroom_nametext
Room name.

Outputs

dataobject
Api result.
Example output
{
  "data": {
    "items": []
  }
}

List participants

List participants.

Inputs

RoomroomtextRequired
Room.

Outputs

dataobject
Api result.
Example output
{
  "data": {
    "participants": []
  }
}

List rooms

List rooms.

Inputs

Namesnameslist
Names.

Outputs

dataobject
Api result.
Example output
{
  "data": {
    "rooms": []
  }
}

Move participant

Move participant.

Inputs

RoomroomtextRequired
Room.
ParticipantidentitytextRequired
Identity.
Destination roomdestination_roomtextRequired
Destination room.

Outputs

dataobject
Api result.
Example output
{
  "data": {}
}

Mute track

Mute track.

Inputs

RoomroomtextRequired
Room.
ParticipantidentitytextRequired
Identity.
Tracktrack_sidtextRequired
Track sid.
Mutedmutedtrue/falseRequired
Muted.

Outputs

dataobject
Api result.
Example output
{
  "data": {
    "track": {}
  }
}

Remove participant

Remove participant.

Inputs

RoomroomtextRequired
Room.
ParticipantidentitytextRequired
Identity.

Outputs

dataobject
Api result.
Example output
{
  "data": {}
}

Send data

Send data.

Inputs

RoomroomtextRequired
Room.
TexttexttextRequired
Text.
Delivery modedelivery_modenumberRequired
Kind.One of: 0 (Reliable), 1 (Lossy).
Destination identitiesdestination_identitieslist
Destination identities.
Topictopictext
Topic.

Outputs

dataobject
Api result.
Example output
{
  "data": {}
}

Update ingress

Update ingress.

Inputs

Ingress idingress_idtextRequired
Ingress id.
Namenametext
Name.
Room nameroom_nametext
Room name.
Participant identityparticipant_identitytext
Participant identity.
Participant nameparticipant_nametext
Participant name.

Outputs

dataobject
Api result.
Example output
{
  "data": {
    "ingress_id": "example",
    "name": "example",
    "participant_identity": "example",
    "room_name": "example",
    "state": {},
    "stream_key": "example",
    "url": "example"
  }
}

Update participant

Update participant.

Inputs

RoomroomtextRequired
Room.
ParticipantidentitytextRequired
Identity.
Namenametext
Name.
Metadatametadatatext
Metadata.
Attributesattributesobject
Attributes.
Permissionpermissionobject
Permission.

Outputs

dataobject
Api result.
Example output
{
  "data": {
    "identity": "example",
    "metadata": "example",
    "name": "example",
    "sid": "example",
    "state": "example",
    "tracks": []
  }
}

Update room metadata

Update room metadata.

Inputs

RoomroomtextRequired
Room.
MetadatametadatatextRequired
Metadata.

Outputs

dataobject
Api result.
Example output
{
  "data": {
    "creation_time": "example",
    "metadata": "example",
    "name": "example",
    "num_participants": 1,
    "sid": "example"
  }
}

Update subscriptions

Update subscriptions.

Inputs

RoomroomtextRequired
Room.
ParticipantidentitytextRequired
Identity.
Track sidstrack_sidslistRequired
Track sids.
Subscribesubscribetrue/falseRequired
Subscribe.

Outputs

dataobject
Api result.
Example output
{
  "data": {}
}

On this page