Issues a short-lived credential for connecting a voice session to an agent in your organization. Send agent_id and optional transport: websocket (default when omitted) for the platform WebSocket flow, or webrtc for a WebRTC media room. Optional version_id pins a published agent version (UUID). Optional prompt and first_message override session parameters and are embedded in WebRTC tokens as participant attributes when using webrtc.
Send your organization API key as Authorization: Bearer <key>.
UUID of the agent that will run this voice session.
Optional published version UUID. When omitted, the server uses the agent's resolved active version.
websocket: platform WebSocket session (default when omitted). webrtc: WebRTC media room; response adds room, identity, and url.
websocket, webrtc Optional opening line override for this session (WebSocket session token and WebRTC JWT participant attributes when applicable).
Optional system prompt override for this session (WebSocket session parameters and WebRTC JWT participant attributes when applicable).
Credential payload. Always includes token. For webrtc transport, the server also returns room, identity, and url.
With websocket transport, only token is set. With webrtc, token is the media-room access JWT (microphone subscribe and publish; participant attributes include agent_id and, when provided, version_id, prompt, and first_message), and room, identity, and url are server-assigned.
Token for the WebSocket or WebRTC client flow.
Media room name assigned by the server. Present only when transport was webrtc.
Participant identity assigned by the server for the WebRTC session. Present only when transport was webrtc.
WebSocket URL of the media server. Present only when transport was webrtc.