Real_Time_Transcription_curl.md

Real-Time Transcription (RTT) API

This document provides curl examples for testing the backend's Real-Time Transcription API endpoints.

Start RTT

Starts a real-time transcription session.

POST /rtt/start

(simple)

curl -X POST http://localhost:8080/rtt/start \
  -H "Content-Type: application/json" \
  -d '{
    "channelName": "test_channel",
    "languages": ["en-US"],
    "subscribeAudioUids": ["410431250", "802976399"],
    "maxIdleTime": 300,
    "enableStorage": false
  }'

(full)

curl -X POST http://localhost:8080/rtt/start \
  -H "Content-Type: application/json" \
  -d '{
    "channelName": "test_channel",
    "languages": ["en-US"],
    "subscribeAudioUIDs": ["1234", "5678"],
    "maxIdleTime": 300,
    "translateConfig": {
      "forceTranslateInterval": 60,
      "languages": [
        {
          "source": "en-US",
          "target": ["es-ES", "fr-FR"]
        }
      ]
    },
    "enableStorage": false,
    "enableNTPtimestamp": true
  }'

Stop RTT

Stops an ongoing real-time transcription session.

DELETE /rtt/stop/:taskId

curl -X DELETE http://localhost:8080/rtt/stop/your-task-id \
  -H "Content-Type: application/json" \
  -d '{
    "builderToken": "your-builder-token"
  }'

Get RTT Status

Retrieves the status of a real-time transcription session.

GET /rtt/status/:taskId

curl -X GET "http://localhost:8080/rtt/status/your-task-id?builderToken=your-builder-token"

Replace localhost:8080 with your server's address if different.

Note: All responses include a timestamp field for auditing purposes.