Transcript LOL API
GET
/spaces/{spaceId}/recordings/{recordingId}/transcript

Get transcript content

This will return the contents of the transcript. Can be called only after transcription job is completed successfully.

/spaces/{spaceId}/recordings/{recordingId}/transcript

The Authorization access token

Authorization

x-api-key<token>

In: header

Path Parameters

spaceId
Required
string

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

recordingId
Required
string

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

Query Parameters

formatstring

Format of the transcript content. Can be one of:

  • json
  • text
  • csv
  • pdf
  • word
  • srt
  • vtt

Defaults to json

jsonContentTypestring

Response format type of JSON contents

Can be one of

  • words
  • paragraphs
  • segments

Details on each format:

  • Words: Gives an array of words with timings.
  • Paragraphs: Gives an array of paragraphs - constructed using our own carefully calibrated heuristics.
  • Segments: Gives an array of segments as given by Whisper model.

Defaults to paragraphs

subMaxCharactersPerLineinteger

Maximum characters per line of subtitle. Lines cannot be shorter than a single word.

Only relavent for subtitle formats

subMaxSecondsPerLineinteger

Maximum duration in seconds per subtitle block. Subtitle blocks cannot be shorter than a single word.

Only relevant for subtitle formats

subMaxLinesPerSubtitleinteger

Maximum number of lines per subtitle block. Controls how many lines can appear simultaneously on screen.

Only relevant for subtitle formats. Defaults to 1

docIncludeSpeakersboolean

If set, document formats will include speaker information for each paragraphs.

Only relavent for text, csv, word formats. Defaults to true

docIncludeTimestampsboolean

If set, document formats will include time information for each paragraphs.

Only relavent for text, csv, word formats. Defaults to true

docIncludeTlolBrandingstring

If set, document formats will include limited transcript branding.

Only relavent for text, pdf, word formats. Defaults to true

curl -X GET "https://transcript.lol/api/v1/spaces/string/recordings/string/transcript?format=string&jsonContentType=string&subMaxCharactersPerLine=0&subMaxSecondsPerLine=0&subMaxLinesPerSubtitle=0&docIncludeSpeakers=true&docIncludeTimestamps=true&docIncludeTlolBranding=string" \
  -H "Authorization: <token>"

Transcript content in requested format

{
  "words": [
    {
      "word": "string",
      "start": 0,
      "end": 0,
      "confidence": 0,
      "speaker": 0
    }
  ],
  "paragraphs": [
    {
      "text": "string",
      "start": 0,
      "end": 0,
      "speaker": 0
    }
  ],
  "segments": [
    {
      "text": "string",
      "start": 0,
      "end": 0,
      "speaker": 0
    }
  ]
}

Previous

Update recording metadatapatch

Next

Translation