rocketkind
Communication

LiveKit

LiveKit is real-time audio and video infrastructure — rooms that browsers, phones, SIP callers and AI agents join over WebRTC.

Authentication

  • API key and secret

Actions

Generic API request. Call any LiveKit server method on this connection, for the case where no shipped action covers it yet — an Egress or Ingress method, for instance. The connection supplies the host, the signing key and the egress route; you supply the Twirp method path, the request message, and the grants the method needs, because…

  • Cancel an agent dispatchDestructiveCancel a dispatch so its agent stops running in the room.
  • Create roomCreate a LiveKit room up front with the settings you want, instead of letting it be created implicitly when the first participant joins.
  • Delete roomDestructiveEnd a room and disconnect everyone still in it.
  • Dispatch an agent to a roomAsk LiveKit to start one of your registered agent workers in a room.
  • Get participantRead one participant's current record — state, display name, metadata, attributes, permissions and published tracks.
  • List agent dispatchesList the agent dispatches that exist for one room, with the jobs each of them started.
  • List participantsList everyone currently in a room, with their identity, state, permissions and published tracks.
  • List roomsList the rooms currently active on the LiveKit project, with their participant counts and metadata.
  • Mute or unmute a trackDestructiveMute or unmute one track a participant has published, server-side.
  • Remove participantDestructiveDisconnect one participant from a room.
  • Send a data messagePush a message over the room's data channel to every participant, or to named ones.
  • Update participantDestructiveChange a participant's display name, metadata, attributes or permissions while they are connected, and broadcast the change to the room.
  • Update room metadataDestructiveReplace a room's metadata string and broadcast the change to everyone currently in it.

Product names, logos and brands are the property of their respective owners and are used here for identification only. Their use does not imply endorsement by, or affiliation with, those owners.