Skip to main content
POST
/
transcribes
Create transcribe
curl --request POST \
  --url https://api.vidbeo.com/v2/transcribes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "video_id": "abcdee12345abcde12345a",
  "language": "en-US",
  "label": "English",
  "kind": "subtitles"
}
'
{
  "success": true,
  "result": {
    "id": "abcde12345abcde12345a",
    "video_id": "abcdee12345abcde12345a",
    "language": "en-US",
    "label": "English",
    "kind": "subtitles",
    "created_by": "abcde12345abcde12345a",
    "created_time": "2024-01-01T00:00:00.000Z",
    "updated_by": "abcde12345abcde12345a",
    "updated_time": "2024-01-01T00:00:00.000Z"
  },
  "links": {},
  "errors": []
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
video_id
string
Required string length: 21
Example:

"abcdee12345abcde12345a"

​
language
enum<string>
Available options:
de-DE,
en-AU,
en-GB,
en-US,
es-ES,
fr-FR,
it-IT
Example:

"en-US"

​
label
string
Required string length: 1 - 20
Example:

"English"

​
kind
enum<string>
Available options:
subtitles,
captions
Example:

"subtitles"

Response

Transcribe

​
success
boolean
required
Example:

true

​
result
object
required
​
links
object
required
Example:
{}
​
errors
object[]
required
Example:
[]