Approve a video's script
curl --request POST \
--url https://api.lumisreach.com/api/v1/videos/{id}/approve \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"script": "<string>",
"sections": [
"<string>"
],
"on_screen_caption": "<string>",
"scenes": [
{
"id": "<string>",
"voiceover": "<string>",
"caption": "<string>",
"prompt": "<string>",
"duration_seconds": 7
}
],
"slides": [
{
"id": "<string>",
"headline": "<string>",
"body": "<string>",
"prompt": "<string>"
}
],
"interview_turns": [
{
"id": "<string>",
"text": "<string>"
}
],
"max_price_cents": 4503599627370495
}
'import requests
url = "https://api.lumisreach.com/api/v1/videos/{id}/approve"
payload = {
"script": "<string>",
"sections": ["<string>"],
"on_screen_caption": "<string>",
"scenes": [
{
"id": "<string>",
"voiceover": "<string>",
"caption": "<string>",
"prompt": "<string>",
"duration_seconds": 7
}
],
"slides": [
{
"id": "<string>",
"headline": "<string>",
"body": "<string>",
"prompt": "<string>"
}
],
"interview_turns": [
{
"id": "<string>",
"text": "<string>"
}
],
"max_price_cents": 4503599627370495
}
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({
script: '<string>',
sections: ['<string>'],
on_screen_caption: '<string>',
scenes: [
{
id: '<string>',
voiceover: '<string>',
caption: '<string>',
prompt: '<string>',
duration_seconds: 7
}
],
slides: [
{
id: '<string>',
headline: '<string>',
body: JSON.stringify('<string>'),
prompt: '<string>'
}
],
interview_turns: [{id: '<string>', text: '<string>'}],
max_price_cents: 4503599627370495
})
};
fetch('https://api.lumisreach.com/api/v1/videos/{id}/approve', 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.lumisreach.com/api/v1/videos/{id}/approve",
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([
'script' => '<string>',
'sections' => [
'<string>'
],
'on_screen_caption' => '<string>',
'scenes' => [
[
'id' => '<string>',
'voiceover' => '<string>',
'caption' => '<string>',
'prompt' => '<string>',
'duration_seconds' => 7
]
],
'slides' => [
[
'id' => '<string>',
'headline' => '<string>',
'body' => '<string>',
'prompt' => '<string>'
]
],
'interview_turns' => [
[
'id' => '<string>',
'text' => '<string>'
]
],
'max_price_cents' => 4503599627370495
]),
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://api.lumisreach.com/api/v1/videos/{id}/approve"
payload := strings.NewReader("{\n \"script\": \"<string>\",\n \"sections\": [\n \"<string>\"\n ],\n \"on_screen_caption\": \"<string>\",\n \"scenes\": [\n {\n \"id\": \"<string>\",\n \"voiceover\": \"<string>\",\n \"caption\": \"<string>\",\n \"prompt\": \"<string>\",\n \"duration_seconds\": 7\n }\n ],\n \"slides\": [\n {\n \"id\": \"<string>\",\n \"headline\": \"<string>\",\n \"body\": \"<string>\",\n \"prompt\": \"<string>\"\n }\n ],\n \"interview_turns\": [\n {\n \"id\": \"<string>\",\n \"text\": \"<string>\"\n }\n ],\n \"max_price_cents\": 4503599627370495\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://api.lumisreach.com/api/v1/videos/{id}/approve")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"script\": \"<string>\",\n \"sections\": [\n \"<string>\"\n ],\n \"on_screen_caption\": \"<string>\",\n \"scenes\": [\n {\n \"id\": \"<string>\",\n \"voiceover\": \"<string>\",\n \"caption\": \"<string>\",\n \"prompt\": \"<string>\",\n \"duration_seconds\": 7\n }\n ],\n \"slides\": [\n {\n \"id\": \"<string>\",\n \"headline\": \"<string>\",\n \"body\": \"<string>\",\n \"prompt\": \"<string>\"\n }\n ],\n \"interview_turns\": [\n {\n \"id\": \"<string>\",\n \"text\": \"<string>\"\n }\n ],\n \"max_price_cents\": 4503599627370495\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.lumisreach.com/api/v1/videos/{id}/approve")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"script\": \"<string>\",\n \"sections\": [\n \"<string>\"\n ],\n \"on_screen_caption\": \"<string>\",\n \"scenes\": [\n {\n \"id\": \"<string>\",\n \"voiceover\": \"<string>\",\n \"caption\": \"<string>\",\n \"prompt\": \"<string>\",\n \"duration_seconds\": 7\n }\n ],\n \"slides\": [\n {\n \"id\": \"<string>\",\n \"headline\": \"<string>\",\n \"body\": \"<string>\",\n \"prompt\": \"<string>\"\n }\n ],\n \"interview_turns\": [\n {\n \"id\": \"<string>\",\n \"text\": \"<string>\"\n }\n ],\n \"max_price_cents\": 4503599627370495\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"status": "unsubmitted",
"template": "talking_avatar",
"preset": "<string>",
"format": "vertical",
"duration_seconds": 123,
"video_url": "<string>",
"thumbnail_url": "<string>",
"billed_cents": 0,
"error": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"posts": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"provider": "tiktok",
"status": "scheduled",
"media_type": "video",
"permalink": "<string>",
"scheduled_for": "2023-11-07T05:31:56Z",
"published_at": "2023-11-07T05:31:56Z",
"error": "<string>"
}
],
"price_cents": 0,
"price_estimated": true,
"script_approved": true,
"user_script": true,
"script": "<string>",
"script_sections": [
{
"label": "<string>",
"text": "<string>"
}
],
"scenes": [
{
"id": "<string>",
"label": "<string>",
"duration_seconds": 123,
"voiceover": "<string>",
"caption": "<string>",
"prompt": "<string>"
}
],
"slides": [
{
"id": "<string>",
"role": "<string>",
"headline": "<string>",
"body": "<string>",
"position": "<string>",
"prompt": "<string>",
"image_url": "<string>"
}
],
"interview": {
"speakers": [
{
"id": "<string>",
"role": "<string>",
"face_name": "<string>"
}
],
"turns": [
{
"id": "<string>",
"speaker_id": "<string>",
"text": "<string>"
}
]
},
"caption": "<string>",
"hashtags": [
"<string>"
],
"post_caption": "<string>",
"music": {
"library": "lumisreach",
"track_id": "<string>",
"title": "<string>",
"volume": 0,
"status": "pending"
},
"source_url": "<string>",
"target_duration_seconds": 0,
"avatar_provider": "heygen",
"avatar_layout": "center",
"background_mode": "static",
"subtitle_style": "none",
"video_model": "<string>",
"dashboard_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"fields": {},
"doc_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"fields": {},
"doc_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"fields": {},
"doc_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"fields": {},
"doc_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"fields": {},
"doc_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"fields": {},
"doc_url": "<string>"
}
}Videos
Approve a video's script
Approve the script of a video in script_review, with any edits, and release it to render. Send {} to approve it as written. Approving is what charges the video, at the price of the approved script: the video’s price_cents when approved as written. Set max_price_cents to refuse the approval, with 400, if your edits would take it above that. A workspace that cannot pay for it (included video credits, then the prepaid balance) gets 400 and the video stays in review.
POST
/
v1
/
videos
/
{id}
/
approve
Approve a video's script
curl --request POST \
--url https://api.lumisreach.com/api/v1/videos/{id}/approve \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"script": "<string>",
"sections": [
"<string>"
],
"on_screen_caption": "<string>",
"scenes": [
{
"id": "<string>",
"voiceover": "<string>",
"caption": "<string>",
"prompt": "<string>",
"duration_seconds": 7
}
],
"slides": [
{
"id": "<string>",
"headline": "<string>",
"body": "<string>",
"prompt": "<string>"
}
],
"interview_turns": [
{
"id": "<string>",
"text": "<string>"
}
],
"max_price_cents": 4503599627370495
}
'import requests
url = "https://api.lumisreach.com/api/v1/videos/{id}/approve"
payload = {
"script": "<string>",
"sections": ["<string>"],
"on_screen_caption": "<string>",
"scenes": [
{
"id": "<string>",
"voiceover": "<string>",
"caption": "<string>",
"prompt": "<string>",
"duration_seconds": 7
}
],
"slides": [
{
"id": "<string>",
"headline": "<string>",
"body": "<string>",
"prompt": "<string>"
}
],
"interview_turns": [
{
"id": "<string>",
"text": "<string>"
}
],
"max_price_cents": 4503599627370495
}
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({
script: '<string>',
sections: ['<string>'],
on_screen_caption: '<string>',
scenes: [
{
id: '<string>',
voiceover: '<string>',
caption: '<string>',
prompt: '<string>',
duration_seconds: 7
}
],
slides: [
{
id: '<string>',
headline: '<string>',
body: JSON.stringify('<string>'),
prompt: '<string>'
}
],
interview_turns: [{id: '<string>', text: '<string>'}],
max_price_cents: 4503599627370495
})
};
fetch('https://api.lumisreach.com/api/v1/videos/{id}/approve', 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.lumisreach.com/api/v1/videos/{id}/approve",
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([
'script' => '<string>',
'sections' => [
'<string>'
],
'on_screen_caption' => '<string>',
'scenes' => [
[
'id' => '<string>',
'voiceover' => '<string>',
'caption' => '<string>',
'prompt' => '<string>',
'duration_seconds' => 7
]
],
'slides' => [
[
'id' => '<string>',
'headline' => '<string>',
'body' => '<string>',
'prompt' => '<string>'
]
],
'interview_turns' => [
[
'id' => '<string>',
'text' => '<string>'
]
],
'max_price_cents' => 4503599627370495
]),
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://api.lumisreach.com/api/v1/videos/{id}/approve"
payload := strings.NewReader("{\n \"script\": \"<string>\",\n \"sections\": [\n \"<string>\"\n ],\n \"on_screen_caption\": \"<string>\",\n \"scenes\": [\n {\n \"id\": \"<string>\",\n \"voiceover\": \"<string>\",\n \"caption\": \"<string>\",\n \"prompt\": \"<string>\",\n \"duration_seconds\": 7\n }\n ],\n \"slides\": [\n {\n \"id\": \"<string>\",\n \"headline\": \"<string>\",\n \"body\": \"<string>\",\n \"prompt\": \"<string>\"\n }\n ],\n \"interview_turns\": [\n {\n \"id\": \"<string>\",\n \"text\": \"<string>\"\n }\n ],\n \"max_price_cents\": 4503599627370495\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://api.lumisreach.com/api/v1/videos/{id}/approve")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"script\": \"<string>\",\n \"sections\": [\n \"<string>\"\n ],\n \"on_screen_caption\": \"<string>\",\n \"scenes\": [\n {\n \"id\": \"<string>\",\n \"voiceover\": \"<string>\",\n \"caption\": \"<string>\",\n \"prompt\": \"<string>\",\n \"duration_seconds\": 7\n }\n ],\n \"slides\": [\n {\n \"id\": \"<string>\",\n \"headline\": \"<string>\",\n \"body\": \"<string>\",\n \"prompt\": \"<string>\"\n }\n ],\n \"interview_turns\": [\n {\n \"id\": \"<string>\",\n \"text\": \"<string>\"\n }\n ],\n \"max_price_cents\": 4503599627370495\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.lumisreach.com/api/v1/videos/{id}/approve")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"script\": \"<string>\",\n \"sections\": [\n \"<string>\"\n ],\n \"on_screen_caption\": \"<string>\",\n \"scenes\": [\n {\n \"id\": \"<string>\",\n \"voiceover\": \"<string>\",\n \"caption\": \"<string>\",\n \"prompt\": \"<string>\",\n \"duration_seconds\": 7\n }\n ],\n \"slides\": [\n {\n \"id\": \"<string>\",\n \"headline\": \"<string>\",\n \"body\": \"<string>\",\n \"prompt\": \"<string>\"\n }\n ],\n \"interview_turns\": [\n {\n \"id\": \"<string>\",\n \"text\": \"<string>\"\n }\n ],\n \"max_price_cents\": 4503599627370495\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"status": "unsubmitted",
"template": "talking_avatar",
"preset": "<string>",
"format": "vertical",
"duration_seconds": 123,
"video_url": "<string>",
"thumbnail_url": "<string>",
"billed_cents": 0,
"error": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"posts": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"provider": "tiktok",
"status": "scheduled",
"media_type": "video",
"permalink": "<string>",
"scheduled_for": "2023-11-07T05:31:56Z",
"published_at": "2023-11-07T05:31:56Z",
"error": "<string>"
}
],
"price_cents": 0,
"price_estimated": true,
"script_approved": true,
"user_script": true,
"script": "<string>",
"script_sections": [
{
"label": "<string>",
"text": "<string>"
}
],
"scenes": [
{
"id": "<string>",
"label": "<string>",
"duration_seconds": 123,
"voiceover": "<string>",
"caption": "<string>",
"prompt": "<string>"
}
],
"slides": [
{
"id": "<string>",
"role": "<string>",
"headline": "<string>",
"body": "<string>",
"position": "<string>",
"prompt": "<string>",
"image_url": "<string>"
}
],
"interview": {
"speakers": [
{
"id": "<string>",
"role": "<string>",
"face_name": "<string>"
}
],
"turns": [
{
"id": "<string>",
"speaker_id": "<string>",
"text": "<string>"
}
]
},
"caption": "<string>",
"hashtags": [
"<string>"
],
"post_caption": "<string>",
"music": {
"library": "lumisreach",
"track_id": "<string>",
"title": "<string>",
"volume": 0,
"status": "pending"
},
"source_url": "<string>",
"target_duration_seconds": 0,
"avatar_provider": "heygen",
"avatar_layout": "center",
"background_mode": "static",
"subtitle_style": "none",
"video_model": "<string>",
"dashboard_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"fields": {},
"doc_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"fields": {},
"doc_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"fields": {},
"doc_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"fields": {},
"doc_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"fields": {},
"doc_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"fields": {},
"doc_url": "<string>"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
A UUID. When present, deduplicates repeat submissions. See /api-reference/idempotency.
Path Parameters
Body
application/json
The edited script, for a script-based video. Omit to approve it as written.
Maximum string length:
6000A scrolling background: one text per section, in order
Required array length:
1 - 10 elementsMaximum string length:
1500real_footage: the caption over the clip
Required string length:
1 - 150Scene templates: edits by scene id. Scenes you leave out keep what was planned.
Required array length:
1 - 10 elementsShow child attributes
Show child attributes
slideshow: edits by slide id
Required array length:
1 - 10 elementsShow child attributes
Show child attributes
interview: line edits by turn id
Maximum array length:
16Show child attributes
Show child attributes
A spending cap: above it the script is not approved and the request fails with 400
Required range:
0 <= x <= 9007199254740991Response
Success
Show child attributes
Show child attributes