POST
/
createTranscript
curl --request POST \
  --url https://v1.transcript.lol/api/createTranscript \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "sourceUrl": "https://www.youtube.com/watch?v=0EqSXDwTq6U",
  "transcriptLangCode": "es"
}'
{
  "transcriptId": "<string>",
  "sourceUrl": "<string>",
  "platform": "<string>",
  "title": "<string>",
  "description": "<string>",
  "thumbnailUrl": "<string>",
  "duration": 123,
  "currentStatus": "<string>",
  "failureReason": "<string>",
  "uploaderId": "<string>",
  "uploaderName": "<string>",
  "uploadedAt": "<string>"
}

Authorizations

​
X-API-KEY
string
header
required

Body

application/json
​
sourceUrl
string

A public url from which we can download the audio or video content

​
transcriptLangCode
string

Default: en

Can be one of en, zh, de, es, ru, ko, fr, ja, pt, tr, pl, ca, nl, ar, sv, it, id, hi, fi, vi, he, uk, el, ms, cs, ro, da, hu, ta, no, th, ur, hr, bg, lt, la, mi, ml, cy, sk, te, fa, lv, bn, sr, az, sl, kn, et, mk, br, eu, is, hy, ne, mn, bs, kk, sq, sw, gl, mr, pa, si, km, sn, yo, so, af, oc, ka, be, tg, sd, gu, am, yi, lo, uz, fo, ht, ps, tk, nn, mt, sa, lb, my, bo, tl, mg, as, tt, haw, ln, ha, ba, jw, su

​
uploadId
string

If you are transcribing a file upload.

One of sourceUrl or uploadId must be set.

​
callbackUrl
string

The url on which we will notify when the transcript is ready. We send a post request to this url with the same body as our getTranscript endpoint

​
privacy
enum<string>

Privacy of your transcript.

Available options:
PUBLIC,
UNLISTED,
PRIVATE
​
title
string

Title to use for the transcript - if nothing is specified, we try to deduce it from the source file or url

​
userPickedId
string

Your own id for the transcript. Helpful to identify callbacks with your internal ids.

​
aiFeatures
enum<string>[]

List of AI features to generate.

Available options:
AI_TRANSCRIPT_SUMMARY,
AI_TRANSCRIPT_TOPICS,
AI_TRANSCRIPT_CHAPTERS,
AI_TRANSCRIPT_TITLES,
AI_TRANSCRIPT_QUIZZES,
AI_TRANSCRIPT_LINKEDIN_POSTS,
AI_TRANSCRIPT_TWITTER_TWEETS,
AI_TRANSCRIPT_BLOG_POST,
AI_TRANSCRIPT_NEWSLETTER,
AI_TRANSCRIPT_QUOTES

Response

200 - application/json
OK
​
transcriptId
string
​
sourceUrl
string
​
platform
string
​
title
string
​
description
string
​
thumbnailUrl
string
​
duration
integer

Duration of the content in seconds

​
currentStatus
string
​
failureReason
string
​
uploaderId
string

For YouTube videos, id of the channel. Similar value for other platforms. Unknown if not applicable.

​
uploaderName
string

For YouTube videos, name of the channel. Similar value for other platforms. Unknown if not applicable.

​
uploadedAt
string

For YouTube videos, date the video was uploaded. Similar value for other platforms. Current data if not available.

Was this page helpful?