POST
/
generate
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": {
      "displayMode": "ALL",
      "displayWords": "PUNCTUATION",
      "spokenMode": "LINE",
      "effectType": "DISABLED",
      "effectMode": "LINE",
      "displayEmojis": "WORD"
    },
    "sizes": {
      "fontSize": 123,
      "strokeSize": 123,
      "blurSize": 123,
      "emojiSize": 123,
      "backgroundRadius": 123
    },
    "linesCount": 123,
    "wordsPerLineCount": 123,
    "wordHasBackground": true,
    "wordHasPunctuation": true,
    "wordHasShadow": true,
    "wordHasCustomShadowColor": true,
    "emojiAnimated": true,
    "capitalizationType": "UPPERCASE"
  }
}'
{
  "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.