Returns
Returns a WebRTC Connection object for the given parameters, orNone if an error occurs.
Example
Parameters
string
required
ID of the product this connection belongs to.
string
required
Name of the WebRTC connection. Must be unique per product.
string
required
The Pipecat Cloud public API key (
pk_...) Galtea uses to reach your agent, the credential its runtime /start call needs. This is not the pcc_pat_ Personal Access Token used to deploy the agent. This is a secret. Galtea stores it encrypted and the API never returns it. A fetched connection exposes only a has_api_key boolean, never the key itself.string
required
The name of your deployed Pipecat Cloud agent (for example, the
agent_name you deployed with). It must match that agent’s name exactly. Galtea passes it to Pipecat Cloud’s /start call to launch the session; if no deployed agent has this name, the call fails.boolean
Whether the voice agent opens the conversation once the session connects. Defaults to
False (the simulated caller speaks first). Pass True for interviewer-style agents that greet the caller first.The simulated caller’s spoken language is taken from each test case’s language, not the WebRTC connection, so one connection can serve test cases in different languages. See WebRTC Connection.