Skip to content

Transcription API

4 confirmed endpoints — 2 respond with data, 2 require valid input.

Endpoints with Response Data

GET /config/api/v1/config/transcriptionLanguageSettings

Get transcription language settings for the tenant

✅ Live — responds with data

Sample Response:

{
  "total": 9,
  "_embedded": {
    "collection": [
      {
        "languageCode": "ru-RU",
        "transcriptionService": "trintSpeechToText",
        "label": "Russian"
      },
      {
        "languageCode": "ar-AR",
        "transcriptionService": "trintSpeechToText",
        "label": "Arabic (Modern Standard)"
      },
      {
        "languageCode": "en-US",
        "transcriptionService": "trintSpeechToText",
        "label": "English (United States)"
      },
      {
        "languageCode": "en-UK",
        "transcriptionService": "trintSpeechToText",
        "label": "English (United Kingdom)"
      },
      {
        "languageCode": "zh-CN",
        "transcriptionService": "trintSpeechToText",
        "label": "Chinese, Mandarin (Simplified, China)"
      },
      {
        "languageCode": "ms-MY",
        "transcriptionService": "trintSpeechToText",
        "label": "Malay (Malaysia)"
      },
      {
        "languageCode": "es-ES",
        "transcriptionService": "trintSpeechToText",
        "label": "Spanish (Spain)"
      },
      {
        "languageCode": "fr-FR",
        "transcriptionService": "trintSpeechToText",
        "label": "French (France)"
      },
      {
        "languageCode": "ko-KR",
        "transcriptionService": "trintSpeechToText",
        "label": "Korean (South Korea)"
      }
    ]
  }
}

Response Schema:

Field Type Required
_embedded object Yes
total integer Yes

GET /config/api/v1/systemConfig/transcriptionLanguageSettings

Get All Transcription Language Settings for the system

✅ Live — responds with data

Response keys: total, _embedded

Response Schema:

Field Type Required
_embedded object No
total number No

Endpoints Requiring Valid Input

These endpoints are confirmed live but need proper request bodies.

PUT /api/v1/items/{id}/transcript

Update transcript for a item

⚠️ Live — requires valid request body

Sample Response:

{
  "error": {
    "statusCode": 400,
    "message": "The server could not understand the request due to invalid syntax."
  }
}

Response Schema:

Field Type Required
error object Yes

Note

mimir-client.ts — upload timed transcript


POST /config/api/v1/config/transcriptionLanguageSettings

Create transcription language settings for the tenant

⚠️ Live — requires valid request body

Sample Response:

{
  "error": {
    "statusCode": 400,
    "message": "Malformed transcription language settings: {\"total\":0,\"_embedded\":{}}"
  }
}

Response Schema:

Field Type Required
error object Yes

Note

[400] {'statusCode': 400, 'message': 'Malformed transcription language settings: {"total":0,"_embedded":{}}'}


Not Found

Method Path Code
GET /api/v1/transcription 404
GET /api/v1/transcription/languages 404
GET /api/v1/transcription/services 404