cURL
curl --request POST \
--url https://api.transcribetube.com/api/transcribeFile \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '
{
"name": "<string>",
"fileUrl": "<string>",
"videoLength": 123,
"language": "<string>",
"webhookUrl": "<string>"
}
'import requests
url = "https://api.transcribetube.com/api/transcribeFile"
payload = {
"name": "<string>",
"fileUrl": "<string>",
"videoLength": 123,
"language": "<string>",
"webhookUrl": "<string>"
}
headers = {
"api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
fileUrl: '<string>',
videoLength: 123,
language: '<string>',
webhookUrl: '<string>'
})
};
fetch('https://api.transcribetube.com/api/transcribeFile', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.transcribetube.com/api/transcribeFile",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'fileUrl' => '<string>',
'videoLength' => 123,
'language' => '<string>',
'webhookUrl' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.transcribetube.com/api/transcribeFile"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"fileUrl\": \"<string>\",\n \"videoLength\": 123,\n \"language\": \"<string>\",\n \"webhookUrl\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.transcribetube.com/api/transcribeFile")
.header("api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"fileUrl\": \"<string>\",\n \"videoLength\": 123,\n \"language\": \"<string>\",\n \"webhookUrl\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.transcribetube.com/api/transcribeFile")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"fileUrl\": \"<string>\",\n \"videoLength\": 123,\n \"language\": \"<string>\",\n \"webhookUrl\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"state": "upload",
"message": "Transcription is in progress",
"videoLength": 123,
"createdAt": "2023-11-07T05:31:56Z"
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}Transcription
Transcribe File
Step 2 of 2 for transcribing your own file. Registers the object uploaded via /api/upload-url as a project and starts processing. Poll /api/detail/ or pass a webhookUrl.
POST
/
api
/
transcribeFile
cURL
curl --request POST \
--url https://api.transcribetube.com/api/transcribeFile \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '
{
"name": "<string>",
"fileUrl": "<string>",
"videoLength": 123,
"language": "<string>",
"webhookUrl": "<string>"
}
'import requests
url = "https://api.transcribetube.com/api/transcribeFile"
payload = {
"name": "<string>",
"fileUrl": "<string>",
"videoLength": 123,
"language": "<string>",
"webhookUrl": "<string>"
}
headers = {
"api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
fileUrl: '<string>',
videoLength: 123,
language: '<string>',
webhookUrl: '<string>'
})
};
fetch('https://api.transcribetube.com/api/transcribeFile', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.transcribetube.com/api/transcribeFile",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'fileUrl' => '<string>',
'videoLength' => 123,
'language' => '<string>',
'webhookUrl' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.transcribetube.com/api/transcribeFile"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"fileUrl\": \"<string>\",\n \"videoLength\": 123,\n \"language\": \"<string>\",\n \"webhookUrl\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.transcribetube.com/api/transcribeFile")
.header("api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"fileUrl\": \"<string>\",\n \"videoLength\": 123,\n \"language\": \"<string>\",\n \"webhookUrl\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.transcribetube.com/api/transcribeFile")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"fileUrl\": \"<string>\",\n \"videoLength\": 123,\n \"language\": \"<string>\",\n \"webhookUrl\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"state": "upload",
"message": "Transcription is in progress",
"videoLength": 123,
"createdAt": "2023-11-07T05:31:56Z"
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}Step 2 of 2 for transcribing your own file. Registers the object you uploaded via Get Upload URL as a project and starts processing. The response returns immediately; poll Get Project or use a webhook — see Lifecycle & Polling.
Send
Request
| Field | Type | Required | Description |
|---|---|---|---|
name | string | yes | Display name for the project. |
fileUrl | string | yes | https://videoven-data.s3.amazonaws.com/{key}::{key} — the key from step 1, in both halves, separated by ::. |
videoLength | integer | yes | Duration in seconds. Used to reserve credit (1 credit per minute, minimum 1). |
language | string | no | BCP-47 language code (en, tr, de, …). Defaults to auto-detect. |
webhookUrl | string | no | HTTP(S) URL we POST to when transcription completes. |
x-tt-source: <your-app> if you want the project attributed to your integration in analytics; it defaults to web.
Response
The created project. Itsstate starts at upload and advances to transcription, then done.
{
"id": "f3c1e7a0-2b48-4a91-8a30-9b1c2d3e4f50",
"state": "upload",
"type": "FILEUPLOAD"
}
Example
cURL
curl -X POST https://api.transcribetube.com/api/transcribeFile \
-H "api-key: $TRANSCRIBETUBE_API_KEY" \
-H "Content-Type: application/json" \
-H "x-tt-source: my-app" \
-d "{
\"name\": \"Weekly sync\",
\"fileUrl\": \"https://videoven-data.s3.amazonaws.com/$KEY::$KEY\",
\"videoLength\": 1830,
\"language\": \"en\"
}"
Body
application/json
https://videoven-data.s3.amazonaws.com/{key}::{key}, using the key from /api/upload-url in both halves

