Skip to main content
Connects the platform a project’s agents run on. The body is shaped by provider; GET /v1/connections/agent/providers lists what each needs. Retell, Vapi, ElevenLabs and Bland keys are checked by listing agents first, so a refused key returns 400 and nothing is stored. Platforms that pull agents start syncing straight away. For LIVEKIT_SELF_HOSTED and the Pipecat providers, the response carries observerApiKey, shown once, for your SDK to report calls with. Most platforms connect once per project, and a second create returns 409; LiveKit Cloud may connect several accounts.
Calls POST /v1/connections/agent

Request body

This endpoint accepts one of several request shapes, so the body is supplied as JSON through --data or on standard input rather than as individual flags.
object
Requires provider, name, apiKey
object
Requires provider, name, apiKey
object
Requires provider, name, apiKey
object
Requires provider, name, apiKey
object
Requires provider, name, apiKey, agentIds
object
Requires provider, name, url, apiKey, apiSecret
object
Requires provider, name
object
Requires provider, name
object
Requires provider, name
object
Requires provider, name, apiKey, appId, envName
object
Requires provider, name, wifConfig, location, appId, deploymentId

Example

Every command also takes the global options and sets one of the exit codes.