View as Markdown
LiveKit icon

LiveKit ACTION

Create Room

Create a new room in LiveKit. See the documentation.
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's LiveKit account once, then configure and run Create Room from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "livekit-create-room",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    livekit: { authProvisionId: "apn_xxxxxxx" },
    name: "Room Name",
    emptyTimeout: 10,
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Create Room inputs
Property Type Description
name Room Name string
The name of the room
Required
emptyTimeout Empty Timeout integer
Number of seconds to keep the room open before any participant joins
Optional
departureTimeout Departure Timeout integer
Number of seconds to keep the room open after the last participant leaves
Optional
maxParticipants Max Participants integer
Limit to the number of participants in a room at a time
Optional
metadata Metadata string
Initial room metadata
Optional
minPlayoutDelay Min Playout Delay integer
Minimum playout delay in milliseconds
Optional
maxPlayoutDelay Max Playout Delay integer
Maximum playout delay in milliseconds
Optional
syncStreams Sync Streams boolean
Improves A/V sync when min_playout_delay set to a value larger than 200ms. It will disables transceiver re-use -- this option is not recommended for rooms with frequent subscription changes
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
livekit-create-room
Version
0.0.3
App
LiveKit
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes