Create Editor Project
curl --request POST \
--url https://public.reap.video/api/v1/automation/create-editor \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"sourceUrl": "<string>",
"uploadId": "<string>",
"language": "<string>",
"resolution": 1080,
"selectedStart": 1,
"selectedEnd": 1
}
'import requests
url = "https://public.reap.video/api/v1/automation/create-editor"
payload = {
"sourceUrl": "<string>",
"uploadId": "<string>",
"language": "<string>",
"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>',
language: '<string>',
resolution: 1080,
selectedStart: 1,
selectedEnd: 1
})
};
fetch('https://public.reap.video/api/v1/automation/create-editor', 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-editor",
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>',
'language' => '<string>',
'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-editor"
payload := strings.NewReader("{\n \"sourceUrl\": \"<string>\",\n \"uploadId\": \"<string>\",\n \"language\": \"<string>\",\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-editor")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"sourceUrl\": \"<string>\",\n \"uploadId\": \"<string>\",\n \"language\": \"<string>\",\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 Editor Project
Open one video in the Reap editor as a new project, ready to edit
POST
/
automation
/
create-editor
Create Editor Project
curl --request POST \
--url https://public.reap.video/api/v1/automation/create-editor \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"sourceUrl": "<string>",
"uploadId": "<string>",
"language": "<string>",
"resolution": 1080,
"selectedStart": 1,
"selectedEnd": 1
}
'import requests
url = "https://public.reap.video/api/v1/automation/create-editor"
payload = {
"sourceUrl": "<string>",
"uploadId": "<string>",
"language": "<string>",
"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>',
language: '<string>',
resolution: 1080,
selectedStart: 1,
selectedEnd: 1
})
};
fetch('https://public.reap.video/api/v1/automation/create-editor', 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-editor",
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>',
'language' => '<string>',
'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-editor"
payload := strings.NewReader("{\n \"sourceUrl\": \"<string>\",\n \"uploadId\": \"<string>\",\n \"language\": \"<string>\",\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-editor")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"sourceUrl\": \"<string>\",\n \"uploadId\": \"<string>\",\n \"language\": \"<string>\",\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
Create an editor project: one video opened in the Reap editor, with no clipping, captions, or reframing applied first. Use it when you want to edit a video by hand, or have your AI agent edit it, without going through the Reap app to set the project up. When the project status becomescompleted, the project is ready to edit. It holds one clip in draft. That clip has no rendered file yet, so its clipUrl is empty until the clip is exported from the editor.
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. Use selectedStart / selectedEnd to edit 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
The source video itself can be longer. Select the part to edit with
Maximum: 15 minutes, or 30 minutes on a monthly or yearly Studio plan
The source video itself can be longer. Select the part to edit with
selectedStart / selectedEnd; the limits apply to that part.File Size
Maximum: 2 GB, or 5 GB on a monthly or yearly Studio plan
Plan Limits
| Plan | Max Resolution | Concurrent Projects |
|---|---|---|
| Creator | 1080p | 3 |
| Studio | 4K (2160p) | 10 |
Editor projects need a paid plan. On the Free plan the request is refused. View pricing to compare plans.
Credits
An editor project costs 2 media credits per minute of video, or of the selected part when you sendselectedStart / selectedEnd. The length is rounded to the nearest minute, with a minimum of 1 minute. The credits are charged when the project is created. Check your balance with Get Plan Usage.
Response
The response is the same project object that Create Captions returns.Current processing status
processing- The video is being prepared for the editorcompleted- The project is ready to edit. Nothing has been rendered yetinvalid- The video could not be processed. The project cannot be editedcancelled- The project was cancelled before it was ready
Resolution of the project. It starts as the
resolution you sent, or 1080. Once the video is prepared it is the resolution of the prepared video, which is lower when the source is smallerExample Request
curl -X POST "https://public.reap.video/api/v1/automation/create-editor" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"uploadId": "65f1a2b3c4d5e6f7a8b9c0d1",
"language": "en",
"resolution": 1080
}'
curl -X POST "https://public.reap.video/api/v1/automation/create-editor" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"sourceUrl": "https://example.com/video.mp4"
}'
const response = await fetch('https://public.reap.video/api/v1/automation/create-editor', {
method: 'POST',
headers: {
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json'
},
body: JSON.stringify({
uploadId: '65f1a2b3c4d5e6f7a8b9c0d1',
language: 'en',
resolution: 1080
})
});
const project = await response.json();
console.log('Editor project created:', project.id);
import requests
headers = {
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json'
}
data = {
'uploadId': '65f1a2b3c4d5e6f7a8b9c0d1',
'language': 'en',
'resolution': 1080
}
response = requests.post(
'https://public.reap.video/api/v1/automation/create-editor',
headers=headers,
json=data
)
project = response.json()
print(f'Editor project created: {project["id"]}')
Example Response
Errors
| Status | When |
|---|---|
400 | Your workspace is on the Free plan: “Please upgrade your plan to use the editor.” |
400 | Neither sourceUrl nor uploadId was sent |
400 | language is not a supported source language |
400 | The video is shorter than 3 seconds, or over your plan’s maximum length or file size |
403 | resolution is above 1080 on a Creator plan |
429 | Your plan’s concurrent project limit is reached. Wait for a project to finish, then try again |
Next Steps
After creating an editor project:- Monitor progress with Get Project Status, or wait for the webhook. For an editor project,
completedmeans ready to edit, not rendered. - Open the project in the Reap editor and edit it, or have your AI agent do it. See Open The Editor From Your AI Agent.
- After the clip is exported from the editor, retrieve it with Get Project Clips.
Authorizations
Body
application/json
Response
200 - application/json
Successful response
Was this page helpful?