Skip to main content
POST
/
rtstream
/
{stream_id}
/
transcription
/
Start or stop RTStream transcription
curl --request POST \
  --url https://api.videodb.io/rtstream/{stream_id}/transcription/ \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "action": "start",
  "engine": "default",
  "ws_connection_id": "conn-123"
}
'
{
  "success": true,
  "data": {
    "status": "running",
    "engine": "default",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}
Start or stop the transcription service on a real-time stream.
  • action must be start or stop
  • Use engine to select the transcription engine (default: default)
  • Use ws_connection_id to receive real-time transcription updates via WebSocket

Get Transcription

Retrieve transcription data

Transcription Status

Check transcription status

Authorizations

​
x-access-token
string
header
required

API key for authentication (sk-xxx format)

Path Parameters

​
stream_id
string
required
Example:

"rts-12345"

Body

application/json
​
action
enum<string>
required
Available options:
start,
stop
Example:

"start"

​
engine
string
default:default
Example:

"default"

​
ws_connection_id
string
Example:

"conn-123"

Response

200 - application/json

Transcription status updated

​
success
boolean
Example:

true

​
data
object