View as Markdown
LiveKit icon

LiveKit ACTION

Create Ingress From URL

Create a new ingress from url 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 Ingress From URL 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-ingress-from-url",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    livekit: { authProvisionId: "apn_xxxxxxx" },
    roomName: "Room Name",
    url: "URL",
  },
})

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 Ingress From URL inputs
Property Type Description
roomName Room Name string
The name of the room to send media to
Required Dynamic
url URL string
URL of the media to pull for ingresses of type URL
Required
participantIdentity Participant Identity string
Unique identity of the participant
Required
participantName Participant Name string
Participant display name
Optional
participantMetadata Participant Metadata string
Metadata to attach to the participant
Optional
name Ingress Name string
The name of the ingress
Optional
bypassTranscoding Bypass Transcoding boolean
Whether to skip transcoding and forward the input media directly. Only supported by WHIP
Optional
enableTranscoding Enable Transcoding boolean
Whether to enable transcoding or forward the input media directly. Transcoding is required for all input types except WHIP. For WHIP, the default is to not transcode.
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-ingress-from-url
Version
0.0.3
App
LiveKit
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes