Authorization

x-api-key

x-api-key<token>

In: header

Path Parameters

spaceId*string

ID of the workspace. You can find from the url in dashboard when you open the workspace or using the list workspaces endpoint.

Request Body

application/json

Recording options

TypeScript Definitions

Use the request body type in TypeScript.

title*string

language*unknown

Language of the audio/video content. This will be used for transcription.

Value in

"bg" | "ca" | "zh" | "zh-CN" | "zh-Hans" | "zh-TW" | "zh-Hant" | "cs" | "da" | "da-DK" | "nl" | "en" | "en-US" | "en-AU" | "en-GB" | "en-NZ" | "en-IN" | "et" | "fi" | "nl-BE" | "fr" | "fr-CA" | "de" | "de-CH" | "el" | "hi" | "hu" | "id" | "it" | "ja" | "ko" | "lv" | "lt" | "ms" | "multi" | "no" | "pl" | "pt" | "pt-BR" | "ro" | "ru" | "sk" | "es" | "es-419" | "sv" | "th" | "tr" | "uk" | "vi"

translationLanguages?array<>

Optional. List of language codes to automatically create translations for this recording. Translations will be queued after transcription completes.

mediaType*unknown

Value in"AUDIO" | "VIDEO"

source*string

Please set this based on how your media content (audio/video) is being imported to Transcript:

FILE_UPLOAD: If you are going to upload a file
UNKNOWN: If none of the other values are suitable

sourceUrl?string

Only public urls to audio / video files are acceptable.

autoDeletePolicy?

Auto deletion policy to apply to this recording. Useful if you prefer your data to be deleted automatically. If not set, no auto deletion occurs.

speakerDiarization?boolean

Set this to true to enable speaker diarization - detection of speakers for each part of the transcript

speakerCount?number

Relavent only when speakerDiarization is enabled.

If you know the number of speakers in the audio, pass it here to improve diarization accuracy.

NOTE:

Speaker diarization is not perfect. But passing this value can help to some extent.
Further, our speaker diarization model is not good at overlaping conversations - where multiple speakers are speaking at the same time.

recordingFolderId?string

Optional. ID of the folder to place this recording in. Use the List Folders endpoint to get available folder IDs. If not set, the recording will be placed in the root of the workspace.

externalId?string

This id also acts an as idempotency key.

This could be a unique id you maintain in your system for this recording or file or url.

**Idempotency Key Behaviour: **

This is relavent only when you set a value for externalId
When set, this id must be unique across all recordings in this workspace
A new recording will be created only if there is no existing recording in this workspace with the same external id
If there is an existing recording in this workspace with the same externalId, we will respond with the existing recording

Response Body

`application/json`

curl -X POST "https://transcript.lol/api/v1/spaces/string/recordings" \  -H "Content-Type: application/json" \  -d '{    "title": "My Audio",    "language": "en",    "mediaType": "AUDIO",    "source": "UNKNOWN"  }'

{
  "id": "string",
  "createdAt": "string",
  "updatedAt": "string",
  "workspaceId": "string",
  "title": "string",
  "sourceUrl": "string",
  "mediaType": "AUDIO",
  "source": "string",
  "duration": 0,
  "status": "MEDIA_IMPORT_UPLOADING",
  "recordingFolderId": "string",
  "isMediaDeleted": true,
  "createdById": "string",
  "autoDeleteMediaAfter": "string"
}

{
  "error": "string",
  "errorDetails": {}
}

{
  "error": "string",
  "errorDetails": {}
}

{
  "error": "string",
  "errorDetails": {}
}

{
  "error": "string",
  "errorDetails": {}
}

{
  "error": "string",
  "errorDetails": {}
}

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

402application/json

403application/json

404application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`