Create streaming session

Creates a streaming session and returns a JWT access token together with the connection URLs.

A session runs over one of two fully independent channels — choose one; you publish audio, receive translated audio, and manage translation entirely over it:

• webrtc_url — the WebRTC Speech-to-Speech Translation API
• ws_url — the WS Speech-to-Speech Translation API

The returned token carries scoped permissions that define what the session can do.

References

• Translation management WebSocket API
• Streaming session

Request Body
data object intent Intent Possible values: [api, broadcaster, desktop, event, agora, captions, bot_conversational, bot_presentation] Intent of the session. Used for analytics and debugging purposes. aggregation_id Aggregation id A client-chosen identifier shared across multiple sessions that should appear as one group in the billing usage view. Leave unset for ungrouped sessions.

Responses
201 Session created successfully. Schema — OPTIONAL ok boolean data object Streaming session response data. Notice, address provided in the response example are placeholders and will differ in real response. publisher List of access token for publishers with RW permissions JWT used to connect to the WebRTC server and Translation management WebSocket API. subscriber string[] Deprecated. The subscriber field will be removed in the next release. webrtc_room_name Room name Room name to join WebRTC server. webrtc_url Stream URL Streaming API URL to publish a stream. ws_url Control URL WebSocket API URL to manage translation options. intent Intent Possible values: [api, broadcaster, desktop, event, agora, captions, bot_conversational, bot_presentation] Intent of the session. Used for analytics and debugging purposes. id Session ID Publisher session identifier. aggregation_id Aggregation ID — OPTIONAL Unique id per group of sessions to display aggregated billing details organization Organization Casdoor organization that owns the session.
default Default Response Schema — OPTIONAL ok Ok — OPTIONAL Indicates if the request was successful or not. errors object[] List of errors type uri Possible values: 1 ≤ length ≤ 2083 A string containing a URI reference that identifies the problem type. status Status Possible values: 399 < value < 600 A number indicating the HTTP status code. title Title Possible values: 5 ≤ length A string containing a short, human-readable summary of the problem type. detail Detail Possible values: 5 ≤ length A string containing a human-readable explanation specific to this occurrence of the problem. instance Instance Possible values: 1 ≤ length A string containing a URI reference that identifies the specific occurrence of the problem. error_code Error Code A Number that indicates the error type that occurred.