View as Markdown
LiveKit icon

LiveKit ACTION

Remove Participants

Remove specific participants from a LiveKit room. See the documentation.
  • Action
  • Writes data
  • Destructive
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's LiveKit account once, then configure and run Remove Participants 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-remove-participants",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    livekit: { authProvisionId: "apn_xxxxxxx" },
    room: "Room Name",
    identities: ["Participant Identities"],
  },
})

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.

Remove Participants inputs
Property Type Description
room Room Name string
The name of the room
Required Dynamic
identities Participant Identities string[]
Identities of participants to remove from the room
Required Dynamic

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-remove-participants
Version
0.0.2
App
LiveKit
Authentication
API key
Read-only
No
Destructive
Yes
Open world
Yes