Create Captions
curl --request POST \
--url https://public.reap.video/api/v1/automation/create-captions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"sourceUrl": "<string>",
"uploadId": "<string>",
"captionsPreset": "<string>",
"language": "<string>",
"translationLanguage": "<string>",
"transcriptionScript": "native",
"enableEmojis": false,
"enableHighlights": false,
"resolution": 1080,
"selectedStart": 1,
"selectedEnd": 1
}
'import requests
url = "https://public.reap.video/api/v1/automation/create-captions"
payload = {
"sourceUrl": "<string>",
"uploadId": "<string>",
"captionsPreset": "<string>",
"language": "<string>",
"translationLanguage": "<string>",
"transcriptionScript": "native",
"enableEmojis": False,
"enableHighlights": False,
"resolution": 1080,
"selectedStart": 1,
"selectedEnd": 1
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
sourceUrl: '<string>',
uploadId: '<string>',
captionsPreset: '<string>',
language: '<string>',
translationLanguage: '<string>',
transcriptionScript: 'native',
enableEmojis: false,
enableHighlights: false,
resolution: 1080,
selectedStart: 1,
selectedEnd: 1
})
};
fetch('https://public.reap.video/api/v1/automation/create-captions', 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://public.reap.video/api/v1/automation/create-captions",
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([
'sourceUrl' => '<string>',
'uploadId' => '<string>',
'captionsPreset' => '<string>',
'language' => '<string>',
'translationLanguage' => '<string>',
'transcriptionScript' => 'native',
'enableEmojis' => false,
'enableHighlights' => false,
'resolution' => 1080,
'selectedStart' => 1,
'selectedEnd' => 1
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://public.reap.video/api/v1/automation/create-captions"
payload := strings.NewReader("{\n \"sourceUrl\": \"<string>\",\n \"uploadId\": \"<string>\",\n \"captionsPreset\": \"<string>\",\n \"language\": \"<string>\",\n \"translationLanguage\": \"<string>\",\n \"transcriptionScript\": \"native\",\n \"enableEmojis\": false,\n \"enableHighlights\": false,\n \"resolution\": 1080,\n \"selectedStart\": 1,\n \"selectedEnd\": 1\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://public.reap.video/api/v1/automation/create-captions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"sourceUrl\": \"<string>\",\n \"uploadId\": \"<string>\",\n \"captionsPreset\": \"<string>\",\n \"language\": \"<string>\",\n \"translationLanguage\": \"<string>\",\n \"transcriptionScript\": \"native\",\n \"enableEmojis\": false,\n \"enableHighlights\": false,\n \"resolution\": 1080,\n \"selectedStart\": 1,\n \"selectedEnd\": 1\n}")
.asString();{
"id": "<string>",
"title": "<string>",
"thumbnail": "<string>",
"billedDuration": 123,
"status": "queued",
"projectType": "clipping",
"source": "Upload",
"genre": "talking",
"topics": [
"<string>"
],
"clipDurations": [
[
123
]
],
"selectedStart": 1,
"selectedEnd": 1,
"exportResolution": 123,
"exportOrientation": "landscape",
"captionsPreset": "<string>",
"enableCaptions": true,
"enableEmojis": true,
"enableHighlights": true,
"language": "<string>",
"dubbingLanguage": "<string>",
"translateTranscription": true,
"translationLanguages": [
"<string>"
],
"transcriptionScript": "native",
"metadata": {
"width": 123,
"height": 123,
"aspectRatio": "<string>",
"size": 123,
"bitrate": 123,
"fps": 123,
"duration": 123,
"rotation": 123,
"resolution": 123,
"codec": "<string>",
"codecFullName": "<string>",
"codecTag": "<string>",
"format": "<string>",
"formatFullName": "<string>"
},
"urls": {
"videoFile": "<string>",
"audioFile": "<string>",
"transcription": "<string>",
"transcription_srt": "<string>",
"transcription_vtt": "<string>",
"transcription_csv": "<string>",
"transcription_txt": "<string>"
},
"createdAt": 123,
"updatedAt": 123
}Create Projects
Create Captions
Add AI-generated captions to your videos with customizable styling
POST
/
automation
/
create-captions
Create Captions
curl --request POST \
--url https://public.reap.video/api/v1/automation/create-captions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"sourceUrl": "<string>",
"uploadId": "<string>",
"captionsPreset": "<string>",
"language": "<string>",
"translationLanguage": "<string>",
"transcriptionScript": "native",
"enableEmojis": false,
"enableHighlights": false,
"resolution": 1080,
"selectedStart": 1,
"selectedEnd": 1
}
'import requests
url = "https://public.reap.video/api/v1/automation/create-captions"
payload = {
"sourceUrl": "<string>",
"uploadId": "<string>",
"captionsPreset": "<string>",
"language": "<string>",
"translationLanguage": "<string>",
"transcriptionScript": "native",
"enableEmojis": False,
"enableHighlights": False,
"resolution": 1080,
"selectedStart": 1,
"selectedEnd": 1
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
sourceUrl: '<string>',
uploadId: '<string>',
captionsPreset: '<string>',
language: '<string>',
translationLanguage: '<string>',
transcriptionScript: 'native',
enableEmojis: false,
enableHighlights: false,
resolution: 1080,
selectedStart: 1,
selectedEnd: 1
})
};
fetch('https://public.reap.video/api/v1/automation/create-captions', 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://public.reap.video/api/v1/automation/create-captions",
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([
'sourceUrl' => '<string>',
'uploadId' => '<string>',
'captionsPreset' => '<string>',
'language' => '<string>',
'translationLanguage' => '<string>',
'transcriptionScript' => 'native',
'enableEmojis' => false,
'enableHighlights' => false,
'resolution' => 1080,
'selectedStart' => 1,
'selectedEnd' => 1
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://public.reap.video/api/v1/automation/create-captions"
payload := strings.NewReader("{\n \"sourceUrl\": \"<string>\",\n \"uploadId\": \"<string>\",\n \"captionsPreset\": \"<string>\",\n \"language\": \"<string>\",\n \"translationLanguage\": \"<string>\",\n \"transcriptionScript\": \"native\",\n \"enableEmojis\": false,\n \"enableHighlights\": false,\n \"resolution\": 1080,\n \"selectedStart\": 1,\n \"selectedEnd\": 1\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://public.reap.video/api/v1/automation/create-captions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"sourceUrl\": \"<string>\",\n \"uploadId\": \"<string>\",\n \"captionsPreset\": \"<string>\",\n \"language\": \"<string>\",\n \"translationLanguage\": \"<string>\",\n \"transcriptionScript\": \"native\",\n \"enableEmojis\": false,\n \"enableHighlights\": false,\n \"resolution\": 1080,\n \"selectedStart\": 1,\n \"selectedEnd\": 1\n}")
.asString();{
"id": "<string>",
"title": "<string>",
"thumbnail": "<string>",
"billedDuration": 123,
"status": "queued",
"projectType": "clipping",
"source": "Upload",
"genre": "talking",
"topics": [
"<string>"
],
"clipDurations": [
[
123
]
],
"selectedStart": 1,
"selectedEnd": 1,
"exportResolution": 123,
"exportOrientation": "landscape",
"captionsPreset": "<string>",
"enableCaptions": true,
"enableEmojis": true,
"enableHighlights": true,
"language": "<string>",
"dubbingLanguage": "<string>",
"translateTranscription": true,
"translationLanguages": [
"<string>"
],
"transcriptionScript": "native",
"metadata": {
"width": 123,
"height": 123,
"aspectRatio": "<string>",
"size": 123,
"bitrate": 123,
"fps": 123,
"duration": 123,
"rotation": 123,
"resolution": 123,
"codec": "<string>",
"codecFullName": "<string>",
"codecTag": "<string>",
"format": "<string>",
"formatFullName": "<string>"
},
"urls": {
"videoFile": "<string>",
"audioFile": "<string>",
"transcription": "<string>",
"transcription_srt": "<string>",
"transcription_vtt": "<string>",
"transcription_csv": "<string>",
"transcription_txt": "<string>"
},
"createdAt": 123,
"updatedAt": 123
}
For AI agents: a documentation index is at /llms.txt. Every page is also available as markdown, just append .md to the URL.
Overview
Add professional captions to your videos using AI-powered transcription. This endpoint generates accurate captions with various styling options, emoji support, and keyword highlighting. Perfect for making content accessible and engaging on social media platforms.Rate Limiting
This endpoint allows 10 requests per minute per API key. Each endpoint has its own budget, so this allowance is not shared with the rest of the API — see Rate limiting.You must provide either
sourceUrl or uploadId, but not both. Use selectedStart / selectedEnd to caption just a part of a longer video. Only the selected part is billed.Video Requirements
Duration
Minimum: 3 seconds
Maximum: 15 minutes, or 30 minutes on a monthly or yearly Studio plan
On paid plans the source video itself can be longer. Select the part to caption with
Maximum: 15 minutes, or 30 minutes on a monthly or yearly Studio plan
On paid plans the source video itself can be longer. Select the part to caption with
selectedStart / selectedEnd. On the Free plan the whole source must be within the maximum.File Size
Maximum: 2 GB, or 5 GB on a monthly or yearly Studio plan
Format
MP4 or MOV with valid video and audio streams
Audio Quality
Clear speech produces best transcription results
Plan Limits
| Plan | Max Resolution | Concurrent Projects |
|---|---|---|
| Creator | 1080p | 3 |
| Studio | 4K (2160p) | 10 |
The Automation API requires an active subscription. View pricing to compare plans.
Response
Minutes billed to your account: the captioned part, rounded to the nearest minute (at least 1)
Current processing status
processing- Video is being transcribed and captions are being generatedcompleted- Captions have been generated successfullyfailed- Processing failed due to an error
Example Request
curl -X POST "https://public.reap.video/api/v1/automation/create-captions" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"uploadId": "65f1a2b3c4d5e6f7a8b9c0d1",
"captionsPreset": "system_beasty",
"language": "en",
"enableEmojis": true,
"enableHighlights": true
}'
curl -X POST "https://public.reap.video/api/v1/automation/create-captions" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"sourceUrl": "https://example.com/video.mp4",
"captionsPreset": "system_minimal",
"resolution": 1080
}'
const response = await fetch('https://public.reap.video/api/v1/automation/create-captions', {
method: 'POST',
headers: {
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json'
},
body: JSON.stringify({
uploadId: '65f1a2b3c4d5e6f7a8b9c0d1',
captionsPreset: 'system_beasty',
language: 'en',
enableEmojis: true,
enableHighlights: true
})
});
const project = await response.json();
console.log('Caption project created:', project.id);
import requests
headers = {
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json'
}
data = {
'uploadId': '65f1a2b3c4d5e6f7a8b9c0d1',
'captionsPreset': 'system_beasty',
'language': 'en',
'enableEmojis': True,
'enableHighlights': True
}
response = requests.post(
'https://public.reap.video/api/v1/automation/create-captions',
headers=headers,
json=data
)
project = response.json()
print(f'Caption project created: {project["id"]}')
<?php
$data = [
'uploadId' => '65f1a2b3c4d5e6f7a8b9c0d1',
'captionsPreset' => 'system_beasty',
'language' => 'en',
'enableEmojis' => true,
'enableHighlights' => true
];
$ch = curl_init('https://public.reap.video/api/v1/automation/create-captions');
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer YOUR_API_KEY',
'Content-Type: application/json'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
$project = json_decode($response, true);
echo 'Caption project created: ' . $project['id'] . "\n";
?>
package main
import (
"bytes"
"encoding/json"
"fmt"
"io/ioutil"
"net/http"
)
func main() {
url := "https://public.reap.video/api/v1/automation/create-captions"
data := map[string]interface{}{
"uploadId": "65f1a2b3c4d5e6f7a8b9c0d1",
"captionsPreset": "system_beasty",
"language": "en",
"enableEmojis": true,
"enableHighlights": true,
}
payload, _ := json.Marshal(data)
req, _ := http.NewRequest("POST", url, bytes.NewBuffer(payload))
req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
req.Header.Set("Content-Type", "application/json")
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()
body, _ := ioutil.ReadAll(resp.Body)
fmt.Println(string(body))
}
import java.io.*;
import java.net.HttpURLConnection;
import java.net.URL;
public class CreateCaptionsExample {
public static void main(String[] args) throws Exception {
URL url = new URL("https://public.reap.video/api/v1/automation/create-captions");
HttpURLConnection conn = (HttpURLConnection) url.openConnection();
conn.setRequestMethod("POST");
conn.setRequestProperty("Authorization", "Bearer YOUR_API_KEY");
conn.setRequestProperty("Content-Type", "application/json");
conn.setDoOutput(true);
String jsonInputString = "{" +
"\"uploadId\": \"65f1a2b3c4d5e6f7a8b9c0d1\"," +
"\"captionsPreset\": \"system_beasty\"," +
"\"language\": \"en\"," +
"\"enableEmojis\": true," +
"\"enableHighlights\": true}";
try(OutputStream os = conn.getOutputStream()) {
byte[] input = jsonInputString.getBytes("utf-8");
os.write(input, 0, input.length);
}
BufferedReader br = new BufferedReader(new InputStreamReader(conn.getInputStream(), "utf-8"));
StringBuilder response = new StringBuilder();
String responseLine;
while ((responseLine = br.readLine()) != null) {
response.append(responseLine.trim());
}
System.out.println("Caption project: " + response.toString());
}
}
Example Response
Processing Workflow
- Audio Extraction - Audio is extracted from the video file
- Transcription - AI transcribes the speech with precise timing
- Caption Generation - Captions are formatted with your chosen style
- Enhancement - Emojis and highlights are added if enabled
- Rendering - Final video is rendered with embedded captions
Caption Features
AI Transcription
Accurate speech-to-text with word-level timing
Style Presets
Multiple caption styles for different content types
Emoji Support
Contextual emojis added automatically
Keyword Highlights
Important words highlighted for emphasis
Best Practices
- Audio Quality: Clear audio produces more accurate transcriptions
- Language Selection: Specify the language for better accuracy
- Style Matching: Choose presets that match your brand and content type
- Translation: Use translation for multilingual audiences
Use Cases
Video Platforms
Auto-generate captions for all uploaded content at scale
Accessibility Compliance
Meet accessibility requirements with accurate, styled captions
Social Media Tools
Add caption generation to your social media management platform
Learning Management
Caption educational content for better comprehension and searchability
Next Steps
After creating a caption project:- Monitor progress with Get Project Status
- Retrieve the captioned video with Get Project Clips
- Download and distribute your captioned content
Authorizations
Body
application/json
End time in seconds of the part to caption (defaults to the end of the video). The selected part must be 3 seconds to 15 minutes long, or up to 30 minutes on a monthly or yearly Studio plan; only the selected part is billed. On the Free plan the whole source must be within 15 minutes.
Required range:
x >= 0Response
200 - application/json
Successful response
Was this page helpful?