​
Overview

Agent Stream is a WebSocket endpoint that lets a telephony provider point its media stream at a single URL and drive a VR3 AI agent run. The agent UUID in the URL selects the agent; provider-specific identifiers in the query string (for Cloudonix: Domain) tell VR3 AI which stored telephony configuration to use for that call. The bearer token and other credentials are never passed in the URL — they live in the stored configuration and are used by VR3 AI to validate the session and to issue provider API calls (hangup, transfer) during the call. This is useful when:
  • You’re integrating VR3 AI into a SIP gateway or in-house dialer that already speaks a supported provider’s streaming protocol
  • You want one stable endpoint per agent rather than wiring up an inbound webhook per phone number
Agent Stream currently supports the Cloudonix provider only. Other providers return NotImplementedError until a per-provider implementation lands. If you need Twilio, Plivo, Telnyx, Vonage, ARI, or another provider, please open a request on GitHub Discussions with your use case.

​
Endpoint

wss://vr3ai.tapcloud.org/api/v1/agent-stream/{agent_uuid}
{agent_uuid} is the agent’s stable UUID (see Get the Agent UUID below). On self-hosted deployments, replace vr3ai.tapcloud.org with your backend host.

​
Prerequisites

  • A VR3 AI agent (workflow) — published or in draft is fine
  • A Cloudonix telephony configuration in your VR3 AI organization whose domain_id matches the Domain you pass on the URL. VR3 AI uses the bearer token from this configuration to validate the call session and to issue provider API calls (hangup, transfer).

​
Get the Agent UUID

The Agent UUID is the workflow’s stable identifier — it doesn’t change when versions are published. To find and copy it in the UI, see Agent UUID.

​
Connect to the WebSocket

​
URL parameters

ParamRequiredDescription
providerYesProvider name. Currently only cloudonix is supported.
DomainYes (cloudonix)Cloudonix domain ID. VR3 AI uses this to look up the matching stored telephony configuration and retrieve the bearer token used for provider API calls.
callId / CallSidNoCall identifier from your side; persisted on the workflow run’s gathered_context as call_id. The Cloudonix call SID used for streaming is taken from the start event payload, not this param.
fromNoCaller phone number, persisted on the workflow run as caller_number.
toNoCalled phone number, persisted on the workflow run as called_number.

​
Cloudonix example

wss://vr3ai.tapcloud.org/api/v1/agent-stream/{agent_uuid}
  ?provider=cloudonix
  &Domain={CLOUDONIX_DOMAIN_ID}
  &callId={CALL_ID}
  &from=+15555550100
  &to=+15555550199
Use this URL inside the CXML <Stream> your Cloudonix Voice Application returns when the call needs to be bridged to the VR3 AI agent: 
<?xml version="1.0" encoding="UTF-8"?>
<Response>
  <Connect>
    <Stream url="wss://vr3ai.tapcloud.org/api/v1/agent-stream/{agent_uuid}?provider=cloudonix&Domain=...&callId=...&from=...&to=..."/>
  </Connect>
  <Pause length="40"/>
</Response>
The first two messages on the socket should be Cloudonix’s standard connected and start events (Twilio-compatible framing). VR3 AI extracts streamSid and callSid from the start event payload, validates the session against Cloudonix using the bearer token from the stored telephony configuration matched by Domain, and then begins streaming audio.

​
Workflow run lifecycle

When the WebSocket is accepted, VR3 AI:
  1. Looks up the workflow by agent_uuid
  2. Runs a quota check against the workflow’s owning user
  3. Creates a new WorkflowRun (call_type=inbound, mode=cloudonix, name WR-AGS-XXXXXXXX) with the from/to numbers stamped on initial_context, the callId/CallSid stored as call_id on gathered_context, and Domain recorded under the run’s inbound_webhook log
  4. Transitions the run to running and starts the agent pipeline
The run is visible under the agent’s Runs tab as soon as it’s minted, just like an inbound or outbound call.

​
Close codes

CodeReason
1008Routing failure — unknown provider, workflow not found, or quota exceeded
1011Server-side failure or unsupported provider for Agent Stream
4400Provider-level handshake error — for cloudonix, missing Domain, no matching telephony configuration, missing bearer token on the configuration, malformed connected/start events, or session validation failed against Cloudonix

​
Security notes

  • Treat the URL as a secret — the agent UUID itself authorizes the connection. Store and transmit it only over TLS, and avoid logging the raw URL in places where access is broader than your operations team.
  • No bearer tokens or provider secrets are passed in the URL. Provider credentials live in the stored telephony configuration (matched by Domain for Cloudonix) and are used server-side by VR3 AI to validate the session and issue provider API calls.