create a streaming session

POST

tts

ws-connect

curl --request POST \
  --url https://silk-api.rumik.ai/v1/tts/ws-connect \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "model": "mulberry",
  "text": "streaming in real time."
}
'

{
  "ws_url": "wss://silk-api.rumik.ai/ws/tts",
  "token": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

Authorizations

Authorization

string

header

required

your rumik api key, e.g. rk_live_.... create one in the rumik dashboard.

Body

application/json

text

string

required

text to synthesize. sent again in the websocket synthesis frame.

Maximum string length: 2000

model

enum<string>

default:muga

which model to use.

Available options:

muga,

mulberry

audio_format

enum<string>

optional output format for this one-shot session. omit the field for raw 24 khz mono signed 16-bit little-endian pcm. explicit null and unsupported values return 400 unsupported_audio_format.

Available options:

opus,

pcm,

mulaw,

alaw,

mp3

Response

a one-shot websocket session.

ws_url

string<uri>

websocket url to connect to.

Example:

"wss://silk-api.rumik.ai/ws/tts"

token

string

one-shot token. pass as ?token=<token> when connecting.

curl --request POST \
  --url https://silk-api.rumik.ai/v1/tts/ws-connect \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "model": "mulberry",
  "text": "streaming in real time."
}
'

{
  "ws_url": "wss://silk-api.rumik.ai/ws/tts",
  "token": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

documentation

sdk

integrations

cookbook

api reference

create a streaming session

Authorizations

Body

Response