Skip to main content
POST
/
generate
Generate Video
curl --request POST \
  --url https://api.autocaption.io/v1/generate \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "input": "<string>",
  "words": [
    {
      "start": 123,
      "end": 123,
      "word": "<string>",
      "punctuated_word": "<string>"
    }
  ],
  "config": {
    "colors": {
      "defaultColor": {
        "colors": [
          {
            "r": 127,
            "g": 127,
            "b": 127
          }
        ]
      },
      "spokenColor": {
        "colors": [
          {
            "r": 127,
            "g": 127,
            "b": 127
          }
        ]
      },
      "hilightColor": {
        "colors": [
          {
            "r": 127,
            "g": 127,
            "b": 127
          }
        ]
      },
      "strokeColor": {
        "colors": [
          {
            "r": 127,
            "g": 127,
            "b": 127
          }
        ]
      },
      "backgroundColor": {
        "colors": [
          {
            "r": 127,
            "g": 127,
            "b": 127
          }
        ]
      },
      "shadowColor": {
        "colors": [
          {
            "r": 127,
            "g": 127,
            "b": 127
          }
        ]
      }
    },
    "modes": {},
    "linesCount": 123,
    "wordsPerLineCount": 123,
    "wordHasBackground": true,
    "wordHasPunctuation": true,
    "wordHasShadow": true,
    "wordHasCustomShadowColor": true,
    "emojiAnimated": true
  }
}
'
import requests

url = "https://api.autocaption.io/v1/generate"

payload = {
"input": "<string>",
"words": [
{
"start": 123,
"end": 123,
"word": "<string>",
"punctuated_word": "<string>"
}
],
"config": {
"colors": {
"defaultColor": { "colors": [
{
"r": 127,
"g": 127,
"b": 127
}
] },
"spokenColor": { "colors": [
{
"r": 127,
"g": 127,
"b": 127
}
] },
"hilightColor": { "colors": [
{
"r": 127,
"g": 127,
"b": 127
}
] },
"strokeColor": { "colors": [
{
"r": 127,
"g": 127,
"b": 127
}
] },
"backgroundColor": { "colors": [
{
"r": 127,
"g": 127,
"b": 127
}
] },
"shadowColor": { "colors": [
{
"r": 127,
"g": 127,
"b": 127
}
] }
},
"modes": {},
"linesCount": 123,
"wordsPerLineCount": 123,
"wordHasBackground": True,
"wordHasPunctuation": True,
"wordHasShadow": True,
"wordHasCustomShadowColor": True,
"emojiAnimated": True
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
input: '<string>',
words: [{start: 123, end: 123, word: '<string>', punctuated_word: '<string>'}],
config: {
colors: {
defaultColor: {colors: [{r: 127, g: 127, b: 127}]},
spokenColor: {colors: [{r: 127, g: 127, b: 127}]},
hilightColor: {colors: [{r: 127, g: 127, b: 127}]},
strokeColor: {colors: [{r: 127, g: 127, b: 127}]},
backgroundColor: {colors: [{r: 127, g: 127, b: 127}]},
shadowColor: {colors: [{r: 127, g: 127, b: 127}]}
},
modes: {},
linesCount: 123,
wordsPerLineCount: 123,
wordHasBackground: true,
wordHasPunctuation: true,
wordHasShadow: true,
wordHasCustomShadowColor: true,
emojiAnimated: true
}
})
};

fetch('https://api.autocaption.io/v1/generate', 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.autocaption.io/v1/generate",
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([
'input' => '<string>',
'words' => [
[
'start' => 123,
'end' => 123,
'word' => '<string>',
'punctuated_word' => '<string>'
]
],
'config' => [
'colors' => [
'defaultColor' => [
'colors' => [
[
'r' => 127,
'g' => 127,
'b' => 127
]
]
],
'spokenColor' => [
'colors' => [
[
'r' => 127,
'g' => 127,
'b' => 127
]
]
],
'hilightColor' => [
'colors' => [
[
'r' => 127,
'g' => 127,
'b' => 127
]
]
],
'strokeColor' => [
'colors' => [
[
'r' => 127,
'g' => 127,
'b' => 127
]
]
],
'backgroundColor' => [
'colors' => [
[
'r' => 127,
'g' => 127,
'b' => 127
]
]
],
'shadowColor' => [
'colors' => [
[
'r' => 127,
'g' => 127,
'b' => 127
]
]
]
],
'modes' => [

],
'linesCount' => 123,
'wordsPerLineCount' => 123,
'wordHasBackground' => true,
'wordHasPunctuation' => true,
'wordHasShadow' => true,
'wordHasCustomShadowColor' => true,
'emojiAnimated' => true
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-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.autocaption.io/v1/generate"

payload := strings.NewReader("{\n \"input\": \"<string>\",\n \"words\": [\n {\n \"start\": 123,\n \"end\": 123,\n \"word\": \"<string>\",\n \"punctuated_word\": \"<string>\"\n }\n ],\n \"config\": {\n \"colors\": {\n \"defaultColor\": {\n \"colors\": [\n {\n \"r\": 127,\n \"g\": 127,\n \"b\": 127\n }\n ]\n },\n \"spokenColor\": {\n \"colors\": [\n {\n \"r\": 127,\n \"g\": 127,\n \"b\": 127\n }\n ]\n },\n \"hilightColor\": {\n \"colors\": [\n {\n \"r\": 127,\n \"g\": 127,\n \"b\": 127\n }\n ]\n },\n \"strokeColor\": {\n \"colors\": [\n {\n \"r\": 127,\n \"g\": 127,\n \"b\": 127\n }\n ]\n },\n \"backgroundColor\": {\n \"colors\": [\n {\n \"r\": 127,\n \"g\": 127,\n \"b\": 127\n }\n ]\n },\n \"shadowColor\": {\n \"colors\": [\n {\n \"r\": 127,\n \"g\": 127,\n \"b\": 127\n }\n ]\n }\n },\n \"modes\": {},\n \"linesCount\": 123,\n \"wordsPerLineCount\": 123,\n \"wordHasBackground\": true,\n \"wordHasPunctuation\": true,\n \"wordHasShadow\": true,\n \"wordHasCustomShadowColor\": true,\n \"emojiAnimated\": true\n }\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("x-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.autocaption.io/v1/generate")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"input\": \"<string>\",\n \"words\": [\n {\n \"start\": 123,\n \"end\": 123,\n \"word\": \"<string>\",\n \"punctuated_word\": \"<string>\"\n }\n ],\n \"config\": {\n \"colors\": {\n \"defaultColor\": {\n \"colors\": [\n {\n \"r\": 127,\n \"g\": 127,\n \"b\": 127\n }\n ]\n },\n \"spokenColor\": {\n \"colors\": [\n {\n \"r\": 127,\n \"g\": 127,\n \"b\": 127\n }\n ]\n },\n \"hilightColor\": {\n \"colors\": [\n {\n \"r\": 127,\n \"g\": 127,\n \"b\": 127\n }\n ]\n },\n \"strokeColor\": {\n \"colors\": [\n {\n \"r\": 127,\n \"g\": 127,\n \"b\": 127\n }\n ]\n },\n \"backgroundColor\": {\n \"colors\": [\n {\n \"r\": 127,\n \"g\": 127,\n \"b\": 127\n }\n ]\n },\n \"shadowColor\": {\n \"colors\": [\n {\n \"r\": 127,\n \"g\": 127,\n \"b\": 127\n }\n ]\n }\n },\n \"modes\": {},\n \"linesCount\": 123,\n \"wordsPerLineCount\": 123,\n \"wordHasBackground\": true,\n \"wordHasPunctuation\": true,\n \"wordHasShadow\": true,\n \"wordHasCustomShadowColor\": true,\n \"emojiAnimated\": true\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.autocaption.io/v1/generate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"input\": \"<string>\",\n \"words\": [\n {\n \"start\": 123,\n \"end\": 123,\n \"word\": \"<string>\",\n \"punctuated_word\": \"<string>\"\n }\n ],\n \"config\": {\n \"colors\": {\n \"defaultColor\": {\n \"colors\": [\n {\n \"r\": 127,\n \"g\": 127,\n \"b\": 127\n }\n ]\n },\n \"spokenColor\": {\n \"colors\": [\n {\n \"r\": 127,\n \"g\": 127,\n \"b\": 127\n }\n ]\n },\n \"hilightColor\": {\n \"colors\": [\n {\n \"r\": 127,\n \"g\": 127,\n \"b\": 127\n }\n ]\n },\n \"strokeColor\": {\n \"colors\": [\n {\n \"r\": 127,\n \"g\": 127,\n \"b\": 127\n }\n ]\n },\n \"backgroundColor\": {\n \"colors\": [\n {\n \"r\": 127,\n \"g\": 127,\n \"b\": 127\n }\n ]\n },\n \"shadowColor\": {\n \"colors\": [\n {\n \"r\": 127,\n \"g\": 127,\n \"b\": 127\n }\n ]\n }\n },\n \"modes\": {},\n \"linesCount\": 123,\n \"wordsPerLineCount\": 123,\n \"wordHasBackground\": true,\n \"wordHasPunctuation\": true,\n \"wordHasShadow\": true,\n \"wordHasCustomShadowColor\": true,\n \"emojiAnimated\": true\n }\n}"

response = http.request(request)
puts response.read_body
{
  "download_url": "<string>"
}

Authorizations

x-api-key
string
header
required

Body

application/json
input
string
required

Identifier of the input file for generation.

words
object[]
required

Array of words to be included in the generated file.

config
object
required

Response

200 - application/json

URL to download the generated file.

download_url
string

Direct URL to download the generated file.