Returns
Returns the updated WebRTC Connection object.Example
Parameters
ID of the WebRTC connection to update.
New name for the WebRTC connection.
New Pipecat Cloud public API key (
pk_..., the runtime /start credential, not the pcc_pat_ deploy token). This is a secret. The API never returns it, so you cannot read it back. Leave this field unset to keep the stored key. Pass a value to replace it.New Pipecat Cloud agent name. It must match a deployed agent’s name exactly.
Whether the voice agent opens the conversation once the session connects (
True/False). Pass PydanticUndefined (the default) to leave the current value unchanged.All fields except
web_rtc_connection_id default to PydanticUndefined (from pydantic_core).
Omit a field (or pass PydanticUndefined) to leave it unchanged.
Pass None to explicitly clear an optional field.
Pass a value to update it.