Create a browser ticket

Exchange the accessKey for a short-lived, single-use socket ticket.

POST /sound_clone/api/v1/stt/realtime/sessions/{sessionId}/tickets

Create a browser ticket

cURL

curl --request POST \
  --url https://api.myvocal.ai/sound_clone/api/v1/stt/realtime/sessions/{sessionId}/tickets \
  --header 'accessKey: <accesskey>'

200

{
  "code": 123,
  "message": "<string>",
  "data": {
    "ticketId": "<string>",
    "sessionId": "<string>",
    "streamUrl": "<string>",
    "expiresInSeconds": 123,
    "ticket": "<string>"
  }
}

Issues a short-lived ticket for one owned session so a browser can open the socket without exposing the long-lived key in a URL. The ticket is single-use and bound to the owner and the session; a reconnect requests a fresh one. A replayed or expired ticket is refused at the handshake.

Path

sessionId · string · required

The session to stream to.

Header

accessKey · string · required

API key for this REST request. Keep it on your backend in customer-facing applications; return only the session and ticket to the browser. Never put the API key in the socket URL.

Response

Successful REST calls return { code: 1, message, data }. The fields below are inside data; JSON downloads are the documented exception and return the transcript view directly.

code · number

1 for success.

message · string

Result message.

data · object

Hide properties

ticketId · string

The public ticket id (rtt_...).

sessionId · string

The bound session.

streamUrl · string

The socket path to connect.

expiresInSeconds · number

The ticket lifetime in seconds.

ticket · string

The plaintext ticket. It is returned exactly once; only its hash is stored.

const ticket = await rest('POST', `/sessions/${sessionId}/tickets`);
const url = new URL(apiBase + ticket.streamUrl);
url.protocol = url.protocol === 'https:' ? 'wss:' : 'ws:';
url.searchParams.set('ticket', ticket.ticket);
const socket = new WebSocket(url);