Servers Playground How we check Add a server Log in

AwesomeVideo

Working Security A

com.awesomevideoeditor/awesomevideov0.2.0 Domain verified

Video for AI agents: captions in 28 styles, transcription, translation, dubbing, shorts. REST+MCP.

Design & Creative

Watch Website Registry entry

Maintain this server? Claim it

Try it

Call this server's tools from your browser. Nothing to install.

Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.

Tool list from our last check. Connect live to refresh it.

abort_upload Destructive

Free. Cancel an unfinished multipart upload and drop its parts.

fileIdstring, required

The server marks this tool as destructive. Running it may delete or overwrite data on the server or in any account you connected with your headers.

I understand, run it anyway

AwesomeVideo MCP server | mcptry

Tools (51)

abort_upload

Free. Cancel an unfinished multipart upload and drop its parts.

destructive

Argument	Type	Description
fileId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "fileId"
  ],
  "properties": {
    "fileId": {
      "type": "string"
    }
  }
}

batch

Quote and run up to 10 transcribe or burn items. dryRun returns the quote and does not debit. Otherwise the call refuses with 402 before any item starts when the balance cannot cover the total.

Argument	Type	Description
items*	array
dryRun	boolean
preset	string
operation*	string
maxCredits	number

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "operation",
    "items"
  ],
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "fileId": {
            "type": "string"
          },
          "format": {
            "enum": [
              "srt",
              "vtt",
              "json"
            ],
            "type": "string"
          },
          "preset": {
            "type": "string"
          },
          "combined": {
            "type": "boolean"
          },
          "glossary": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "language": {
            "type": "string"
          },
          "mediaUrl": {
            "type": "string"
          },
          "faceAvoid": {
            "type": "boolean",
            "description": "true = move captions off faces (samples faces at 2 fps, same price; result.faceAvoid.faceLayout). Shortcut for styleOverrides.faceAvoid."
          },
          "subtitles": {
            "type": "string"
          },
          "highlightColor": {
            "type": "string",
            "description": "#RRGGBB for highlightWords. Default #FACC15."
          },
          "highlightWords": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "maxItems": 200,
            "description": "Shortcut: words or phrases to color in every caption (accent/case-insensitive), e.g. [\"AwesomeVideo\", \"gratis\"]. Maps to styleOverrides.wordHighlights rule {id:\"custom\", words, color}. Same price."
          },
          "styleOverrides": {
            "type": "object",
            "description": "Per-call style changes deep-merged onto the preset (same fields as list_presets style; null removes a field), validated with the renderer schema and bundled fonts. Example {\"fontSize\":72,\"maxWordsPerCaption\":2,\"wordEntrance\":\"bounce\"}. Same price. No need to save_custom_preset. Every field with examples: get_style_reference.",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {}
          },
          "durationSeconds": {
            "type": "number",
            "exclusiveMinimum": 0
          },
          "transcriptionJobId": {
            "type": "string"
          }
        }
      },
      "maxItems": 10,
      "minItems": 1
    },
    "dryRun": {
      "type": "boolean"
    },
    "preset": {
      "type": "string"
    },
    "operation": {
      "enum": [
        "transcribe",
        "burn"
      ],
      "type": "string"
    },
    "maxCredits": {
      "type": "number",
      "minimum": 0
    }
  }
}

burn_captions

Burn captions into video with native ffmpeg and an ASS script generated from an AwesomeVideo preset. This is the paid server path and costs more per audio minute than transcription. The container uses a fast x264 preset, scales to a moderate resolution, copies the original audio, and scales to zero after the job. Pass subtitles (SRT, VTT, or JSON) or a transcription job id, plus a preset id or name. A key that cannot pay gets 402 insufficient_balance with requiredCents and howToBuy. For a render that costs AwesomeVideo nothing, call prepare_client_burn instead and burn in the browser or a future WebMCP client. Pass platform (tiktok, instagram_reels, youtube_shorts, youtube, ...) when the user names where the video goes, e.g. "subtítulos para TikTok" → platform=tiktok: captions move inside that app's safe zone (style unchanged, same price) and the result includes safe_zone {platform, margins}, plus a warning if the video shape does not match (e.g. 16:9 for TikTok; use shorts to crop to 9:16).

Argument	Type	Description
fileId	string
preset	string	Preset id or name, or custom:cp_... for your own saved preset. Use presetId or presetName too.
autoFit	boolean	Default true: caption size, words per caption (4 on 9:16, 5 on 1:1, 7 on 16:9), and a default safe zone follow the video shape, so text reads the same at 720p and 1080p and stays clear of app UI. Pass false only when the user wants the preset's exact fixed pixel sizes. Same price.
combined	boolean	Also return SRT, VTT, and transcript JSON. Same burn price.
mediaUrl	string

buy_credits

Free. Returns a checkout URL that buys 500 credits for $5 for this exact key (works on self-serve keys, no sign-in). Show the URL to your human; credits arrive after payment, then retry. For bigger packs or plans use create_checkout after the key is claimed.

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

caption_video

PREFER THIS for 'add/burn subtitles to this video'. One call runs transcribe -> optional translate -> burn and returns the finished MP4 link plus SRT, VTT, JSON transcript, and credits charged. Source: sourceUrl (public https link: direct file, chat attachment URL, Google Drive or Dropbox share link; YouTube is refused) or fileId (from create_upload / import_url / upload_base64). Price is exactly the sum of the steps, no surcharge: transcribe 1 + burn 4 credits per audio minute (+2 with translateTo); 1 credit = 1 cent; call quote with operation caption first if unsure. Over-limit input (2048 MB fileId, 80 MB sourceUrl, 3 h) fails with 422 limit_exceeded and charged:false; failed jobs refund automatically. wait (default true) blocks up to waitSeconds (default 45, max 50) and returns the finished result; if it is still running you get status queued/running, the job id, step, progress (0-100), eta_seconds and pollAfterSeconds: poll get_job after pollAfterSeconds, or pass webhookUrl / notifyEmail. If it fails after transcribing, resume_job reuses the transcript and charges only the rest. Use platform (tiktok, instagram_reels, youtube_shorts, youtube, ...; see list_platforms) so captions stay clear of the app UI. Person wants to check the text first? Pass review:true: it transcribes now and returns reviewUrl; the burn is charged only on approval. To fix the text yourself, use transcribe -> edit_transcript -> burn_captions.

Argument	Type	Description
wait	boolean	Block until done, up to waitSeconds. Default true.
fileId	string	Id from create_upload, import_url, or upload_base64.
preset	string	Caption style preset id or name (list_presets), or your own saved preset as custom:cp_... (save_custom_preset). Default Clarity.
review	boolean

complete_upload

Free. After every part is PUT, assemble the file. Idempotent. Missing parts return 409 upload_incomplete with missingParts. Then pass fileId to any tool.

Argument	Type	Description
fileId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "fileId"
  ],
  "properties": {
    "fileId": {
      "type": "string"
    }
  }
}

create_checkout

Free. Checkout URL for a pack or plan: pack_5 $5=500, pack_20 $20=2,200, pack_50 $50=6,000 credits; creator $9/mo=1,200, pro $29/mo=4,500, scale $99/mo=18,000 credits/month (interval year = 10x monthly). Needs the key to be claimed by an account at https://awesomevideoeditor.com/account; otherwise returns account_required. For an unclaimed key use buy_credits.

Argument	Type	Description
product*	string
interval	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "product"
  ],
  "properties": {
    "product": {
      "enum": [
        "pack_5",
        "pack_20",
        "pack_50",
        "creator",
        "pro",
        "scale"
      ],
      "type": "string"
    },
    "interval": {
      "enum": [
        "month",
        "year"
      ],
      "type": "string"
    }
  }
}

create_clips

PREFER THIS for 'turn this long video/podcast/stream into shorts/clips/highlights'. One call: transcribes the video (or reuses transcriptionJobId/subtitles), an LLM reads the word-timed transcript and picks the count (default 3, max 10) best self-contained moments of minSeconds-maxSeconds (default 15-60, range 5-90), cuts start on a sentence start and end on a sentence or word end, then renders each as MP4: reframe face (default: 720x1280 9:16 crop that follows the speaker, falls back to center), center (plain center crop), or none (keep the source shape). captions (default true) burns captions with any preset (list_presets or custom:cp_...); platform keeps them inside the app's safe zone. Returns clips [{name, rank, start, end, seconds, title, hook, reason, score 0-100, text, url}] sorted by time (rank 1 = best) plus the transcript files. Source: sourceUrl (public https link, Drive, Dropbox; YouTube, TikTok and Instagram links are refused with 422) or fileId. Price (1 credit = 1 cent): transcribe 1/source min (0 with a transcript) + highlights 1 per started 10 source min + render 3 per output min, reserved for count x maxSeconds and the unused part refunded when the clips are shorter; e.g. a 30-min video, 3 clips up to 60 s: 42 credits reserved. quoteOnly:true with durationSeconds returns the price without a key-charge or media. Failed jobs refund automatically. wait (default true) blocks up to waitSeconds (max 50); long videos keep running: poll get_job or pass webhookUrl / notifyEmail.

Argument	Type	Description
wait	boolean	Block until done, up to waitSeconds. Default true.
count	integer	Clips to return, 1-10. Default 3. Out of range: 422 limit_exceeded before any charge.
fileId	string	Id from create_upload, import_url, or upload_base64.
preset	string

create_key

Free. Create a new AwesomeVideo API key with 0 credits, no sign-in. Works without a key. Returns the token once; store it and send it as Authorization: Bearer <token> on the MCP connection or REST calls. Paid tools then return 402 with a checkoutUrl ($5 = 500 credits, 1 credit = 1 cent). Limited to a few keys per network per day.

Argument	Type	Description
name	string	Optional label, e.g. the agent's name.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 80,
      "description": "Optional label, e.g. the agent's name."
    }
  }
}

create_multipart_upload

Free. For files over 80 MB (up to 2048 MB / 3 h), or any upload on a flaky connection. Returns fileId, partSizeBytes (default 64 MB, 5-95 MB), and parts[] with partNumber, offset, length, and a PUT url each (no API key needed, valid 24 hours). PUT bytes [offset, offset+length) of the file to each url, e.g. dd if=big.mp4 bs=1M skip=$((offset/1048576)) count=$((length/1048576)) | curl -X PUT --data-binary @- -H "Content-Length: <length>" "<url>" (tail -c +$((offset+1)) big.mp4 | head -c length works for any part size). Parts can go in any order or in parallel; re-sending a part replaces it. If the upload stops, call get_upload_status for missingParts and send only those, then complete_upload. Then pass fileId to caption_video, transcribe, burn_captions, shorts, trim, or preview like any upload. Up to 30 per hour.

Argument	Type	Description
filename*	string	File name, e.g. talk.mp4.
sizeBytes*	integer	Exact file size in bytes.
contentType*	string	video/* or audio/*, e.g. video/mp4.
partSizeBytes	integer	Bytes per part, 5242880-99614720. Default 67108864 (64 MB).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "filename",
    "contentType",
    "sizeBytes"
  ],
  "properties": {
    "filename": {
      "type": "string",
      "maxLength": 200,
      "description": "File name, e.g. talk.mp4."
    },
    "sizeBytes": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Exact file size in bytes.",
      "exclusiveMinimum": 0
    },
    "contentType": {
      "type": "string",
      "description": "video/* or audio/*, e.g. video/mp4."
    },
    "partSizeBytes": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Bytes per part, 5242880-99614720. Default 67108864 (64 MB).",
      "exclusiveMinimum": 0
    }
  }
}

create_upload

Free. Get a fileId and a single-use PUT URL (valid 15 minutes, tied to this key or account) for a local video or audio file, e.g. one the user attached in chat. Checks size first: one PUT takes up to 80 MB; bigger files (up to 2048 MB) return 422 use_multipart_upload: call create_multipart_upload instead. Then PUT the raw bytes (not multipart) with the returned headers, e.g. curl -X PUT --data-binary @clip.mp4 -H "Content-Type: video/mp4" "<uploadUrl>", and pass fileId to plan, quote, transcribe, burn_captions, shorts, trim, dub, or preview. No API key is needed for the PUT itself. Up to 30 per hour.

Argument	Type	Description
filename*	string	File name, e.g. clip.mp4.
sizeBytes*	integer	Exact file size in bytes (the PUT must match).
contentType*	string	video/* or audio/*, e.g. video/mp4.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "filename",
    "contentType",
    "sizeBytes"
  ],
  "properties": {
    "filename": {
      "type": "string",
      "maxLength": 200,
      "description": "File name, e.g. clip.mp4."
    },
    "sizeBytes": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Exact file size in bytes (the PUT must match).",
      "exclusiveMinimum": 0
    },
    "contentType": {
      "type": "string",
      "description": "video/* or audio/*, e.g. video/mp4."
    }
  }
}

delete_brand_preset

Delete a saved brand preset for this key or account. Free.

destructive

Argument	Type	Description
id*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

delete_custom_preset

Free. Delete one of your saved custom presets. A community copy that was already approved stays in the gallery.

destructive

Argument	Type	Description
id*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

delete_glossary

Free. Remove saved glossary terms by term, or all: true to clear it.

destructive

Argument	Type	Description
all	boolean
terms	array

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "all": {
      "type": "boolean"
    },
    "terms": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}

dub

Paid, per target language: voice 5 credits per source minute (voiceTier basic: en, es, fr, zh, ja, ko via Workers AI MeloTTS, hi, ar, bn, pt, ru, ur, id, de, tr, it, vi via Google WaveNet) or 12 (standard: en, es via Deepgram Aura-2, hi, ar, bn, pt, ru, ur, id, de, tr, it, vi via Google Chirp 3 HD), plus transcription 1/min and translation 2/min when you do not pass them. Transcribes, translates, voices each line, fits it to the original timing (speeds up to 1.25x, rewrites a line shorter once if needed, pads with silence), mixes over the original audio ducked to -18 dB (keepOriginalAudio duck, default) or muted, and returns an MP4 plus target-language SRT/VTT/JSON (audioTrack:true adds an M4A). Reuse work with transcriptionJobId or subtitles (source language) and translationJobId or translatedSubtitles (target language). Unsupported languages or tiers return 422 limit_exceeded before any charge; call plan first. Refunded if the job fails. No voice cloning or lip sync.

Argument	Type	Description
voice	string	Voice id from list_voices (listen to sampleUrl first). Omit for the default voice of the language and tier.
fileId	string
mediaUrl	string
subtitles	string	Source-language SRT, VTT, or JSON.
voiceTier	string	Defaults to the voice's tier, else basic.
audioTrack	boolean	Also return the dubbed audio as M4A.
maxCredits

edit_transcript

Replace the cues on a finished transcription without running Whisper again. Cost is zero. A later burn_captions that passes this transcriptionJobId pays only the burn price. Pass cues or SRT, VTT, or JSON subtitles.

Argument	Type	Description
cues	array
jobId*	string
subtitles	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "jobId"
  ],
  "properties": {
    "cues": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "start",
          "end",
          "text"
        ],
        "properties": {
          "end": {
            "type": "number"
          },
          "text": {
            "type": "string"
          },
          "start": {
            "type": "number"
          }
        }
      }
    },
    "jobId": {
      "type": "string"
    },
    "subtitles": {
      "type": "string"
    }
  }
}

generate_metadata

Paid: 1 credit per platform when a transcript exists (no re-transcription); with only a video, transcription (1 credit/min) is added. Writes publishing metadata from what is said in the video: several title options, a description, hashtags, and YouTube chapters with timestamps (youtube only, videos of 60 s or more; first chapter at 0:00, 3+ chapters at least 10 s apart, snapped to speech). Pass transcriptionJobId (any finished transcribe, caption_video, remove_silences/trim, or translate job; for a trimmed video use its job so chapter times match the cut) or subtitles; otherwise fileId or mediaUrl. platforms: youtube (default), shorts, tiktok, instagram (one result per platform, each following that platform's lengths and hashtag norms; shorts always gets #shorts). Written in the video's language unless language (e.g. 'es', 'en') is set. titleCount 1-10 (default 5). context: optional creator notes (audience, product names). Waits up to ~40 s for the result; otherwise poll get_job. Result: platforms.<platform>.{titles, description, hashtags, chapters[{start, timestamp, title}], descriptionWithChapters}.

Argument	Type	Description
fileId	string
context	string
language	string	Output language. Default: the video's language.
mediaUrl	string
platforms	array
quoteOnly	boolean	Free: return the price without starting a job or charging. With media only (no transcript) pass durationSeconds.

get_balance

Read the prepaid balance for this API key in cents and in transcription-equivalent audio seconds. Server burns spend the burn price, which is higher than transcription. The client render path does not spend balance.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

get_custom_preset

Free. One saved custom preset by id (cp_... or custom:cp_...), with its full style JSON.

read-only

Argument	Type	Description
id*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

get_glossary

Free. The saved glossary of this account (or key): preferred spellings, brand names, slang fixes (aliases) and do-not-translate terms. It is applied to every transcribe and translate automatically.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

get_job

Read any job. Includes status, step (queued, transcribe, translate, burn, finalize, done, failed), progress (0-100, burn uses real ffmpeg progress), eta_seconds and estimatedCompletionAt (from media length x rolling per-step averages), pollAfterSeconds (wait that long before the next poll), cost, and an expiring result URL when the job succeeded. A failed caption job with resumable:true can be restarted with resume_job.

read-only

Argument	Type	Description
jobId*	string	Job id returned by transcribe or burn_captions.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "jobId"
  ],
  "properties": {
    "jobId": {
      "type": "string",
      "description": "Job id returned by transcribe or burn_captions."
    }
  }
}

get_review

Free. Status of a review from request_review: awaiting_review, approved (burnJobId and burnJob with the video URL when done), rejected (note says why; nothing charged), or expired.

read-only

Argument	Type	Description
reviewId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "reviewId"
  ],
  "properties": {
    "reviewId": {
      "type": "string"
    }
  }
}

get_style_reference

Free, no key. Every caption style field (font, colors, stroke, background, shadow, position, animation, motion, reveal mode, wordStateStyles, wordHighlights rules, smartEmphasis, segmentColorCycle, caption forms, faceAvoid) with type, allowed values or range, a description and JSON examples. Use it before styleOverrides, highlightWords, save_custom_preset or validate_preset_style. To see styles on the actual video for free, call style_preview.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

get_upload_status

Free. For a multipart upload: state (uploading, completed, aborted), completedParts, missingParts, bytesReceived. Use it to resume an interrupted upload: PUT only the missing parts (same urls as create_multipart_upload), then complete_upload.

read-only

Argument	Type	Description
fileId*	string	fileId from create_multipart_upload.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "fileId"
  ],
  "properties": {
    "fileId": {
      "type": "string",
      "description": "fileId from create_multipart_upload."
    }
  }
}

get_usage

30-day credit usage for this key, or for the whole account when the key has been claimed. Splits transcription and server burn. from and to are unix milliseconds.

read-only

Argument	Type	Description
to	number
from	number

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "to": {
      "type": "number"
    },
    "from": {
      "type": "number"
    }
  }
}

import_url

Free. Download a public video or audio link into AwesomeVideo and get a fileId (same as create_upload), without downloading it yourself. Accepts direct https/http file links (chat attachment URLs, CDNs, S3 presigned URLs), Google Drive share links (large-file confirm page handled), Dropbox share links, and OneDrive links. Up to 2048 MB when the host sends Content-Length (streamed to storage), 80 MB otherwise (422 limit_exceeded, charged:false). YouTube, TikTok, and Instagram links are refused with 422: upload the file instead. Private, local, and non-standard-port addresses are blocked. Up to 30 per hour. caption_video accepts sourceUrl directly, so you only need this to reuse one file across several tools.

Argument	Type	Description
url*	string	Public link to the file.
filename	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "url"
  ],
  "properties": {
    "url": {
      "type": "string",
      "description": "Public link to the file."
    },
    "filename": {
      "type": "string",
      "maxLength": 200
    }
  }
}

list_brand_presets

Font, color, position, and optional logo saved for this key, or for the account when the key is claimed. Free.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

list_custom_presets

Free. Your saved custom caption presets (full style JSON) with their community review status if submitted (pending, approved, rejected).

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

list_jobs

Recent transcription and burn jobs for this key, or for every key on the account when this key is claimed. Includes a download URL while the result is still available.

read-only

Argument	Type	Description
limit	integer
cursor	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "limit": {
      "type": "integer",
      "maximum": 100,
      "exclusiveMinimum": 0
    },
    "cursor": {
      "type": "string"
    }
  }
}

list_platforms

Free, works without a key. Platforms you can pass as platform to burn_captions, shorts, preview, prepare_client_burn, and plan: id, name, aliases, expected aspect, and safe-zone margins (fractions of the frame covered by the app's UI) with the source. Use it to map what the user said ("para Reels", "for YouTube Shorts") to an id.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

list_presets

Free. List built-in AwesomeVideo caption presets, community presets that have been approved, and (with a key) your own saved custom presets (source custom, id custom:cp_...). Preset style JSON is the same document the web editor stores; copy one as a starting point for save_custom_preset. Also returns fonts: the bundled font families allowed in custom and brand presets.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

list_voices

Free, works without a key. The dub voice catalog: id, language, tier (basic 5 credits/min, standard 12), provider, gender, default, creditsPerMinute, and sampleUrl (a short MP3 to listen to before choosing). Filter by language (ISO 639-1) and tier. Pass an id as voice to dub or plan; omit voice for the default.

read-only

Argument	Type	Description
tier	string
language	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "tier": {
      "enum": [
        "basic",
        "standard"
      ],
      "type": "string"
    },
    "language": {
      "type": "string"
    }
  }
}

plan

Free, works without a key, never charges. Price a whole pipeline before running it and check it against the limits. steps: ordered ops (caption = the one-call caption_video, with optional translateTo; transcribe, translate, burn with renderer server|client, shorts with count/minSeconds/maxSeconds/reframe (face|center, same price), trim with keepSeconds, preview, dub with targetLanguage/voiceTier/sourceLanguage). A transcribe step is added automatically when a later step needs a transcript (set hasTranscript if you already have one), and a translate step before dub (set hasTranslation if you have the target-language lines). An unsupported dub language or voice tier shows up in limitViolations. source: durationSeconds, bytes, via (upload|url), transcriptCues, or mediaUrl (only a HEAD request reads its size; nothing is downloaded). Returns steps with credits, totalCredits, totalUsd, freeAlternatives (client burn is free), feasible, and limitViolations [{code, limit, actual, unit, message, hint}]. With a key it also returns your balance and whether it is enough. Paid tools return limit_exceeded with the same violations before charging.

read-only

Argument	Type	Description
steps*	array
source	object
hasTranscript	boolean
hasTranslation	boolean

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "steps"
  ],
  "properties": {
    "steps": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "op"
        ],
        "properties": {
          "op": {
            "enum": [
              "caption",
              "transcribe",
              "translate",
              "burn",
              "shorts",
              "trim",
              "preview",
              "dub",
              "style_preview"
            ],
            "type": "string"
          },
          "count": {
            "type": "integer",
            "maximum": 9007199254740991,
            "minimum": -9007199254740991
          },
          "voice": {
            "type": "string"
          },
          "reframe": {
            "enum": [
              "face",
              "center"
            ],
            "type": "string"
          },
          "platform": {
            "type": "string",
            "description": "burn, preview, shorts: platform id or alias. Validated, same price."
          },
          "renderer": {
            "enum": [
              "server",
              "client"
            ],
            "type": "string"
          },
          "voiceTier": {
            "enum": [
              "basic",
              "standard"
            ],
            "type": "string"
          },
          "maxSeconds": {
            "type": "number"
          },
          "minSeconds": {
            "type": "number"
          },
          "keepSeconds": {
            "type": "number"
          },
          "translateTo": {
            "type": "string",
            "description": "caption only."
          },
          "sourceLanguage": {
            "type": "string"
          },
          "targetLanguage": {
            "type": "string"
          }
        }
      },
      "maxItems": 10,
      "minItems": 1
    },
    "source": {
      "type": "object",
      "properties": {
        "via": {
          "enum": [
            "upload",
            "url"
          ],
          "type": "string"
        },
        "bytes": {
          "type": "number",
          "minimum": 0
        },
        "mediaUrl": {
          "type": "string"
        },
        "transcriptCues": {
          "type": "integer",
          "maximum": 9007199254740991,
          "minimum": 0
        },
        "durationSeconds": {
          "type": "number",
          "exclusiveMinimum": 0
        }
      }
    },
    "hasTranscript": {
      "type": "boolean"
    },
    "hasTranslation": {
      "type": "boolean"
    }
  }
}

prepare_client_burn

Build an ASS subtitle script from an AwesomeVideo preset without starting ffmpeg. Cost is zero and nothing is debited. This is the seam for a future client-side or WebMCP renderer that burns captions in the user's browser. Pass subtitles or a transcription job id and a preset id or name. Optional width and height set PlayRes; the default is 1280x720.

read-only

Argument	Type	Description
width	integer
height	integer
preset	string
autoFit	boolean	Default true: caption size, words per caption (4 on 9:16, 5 on 1:1, 7 on 16:9), and a default safe zone follow the video shape, so text reads the same at 720p and 1080p and stays clear of app UI. Pass false only when the user wants the preset's exact fixed pixel sizes. Same price.
platform	string	Where the video will be posted: tiktok, instagram_reels, youtube_shorts, facebook_reels, snapchat_spotlight, linkedin, youtube, x (aliases like reels, instagram, shorts, snap, twitter; case-insensitive). Keeps captions out of that app's buttons and text. If the user says "para TikTok" / "for Reels", pass it; if they did not say and it matters, ask. Same price. Unknown values return 422 invalid_platform before any charge. See list_platforms.
presetId	string

preview

A still PNG or a clip of at most 5 seconds with the chosen preset. Flat price, at most 1 credit by default. Does not bill the full media duration.

Argument	Type	Description
mode	string
fileId	string
preset	string
autoFit	boolean	Default true: caption size, words per caption (4 on 9:16, 5 on 1:1, 7 on 16:9), and a default safe zone follow the video shape, so text reads the same at 720p and 1080p and stays clear of app UI. Pass false only when the user wants the preset's exact fixed pixel sizes. Same price.
mediaUrl	string
platform	string	Where the video will be posted: tiktok, instagram_reels, youtube_shorts, facebook_reels, snapchat_spotlight, linkedin, youtube, x (aliases like reels, instagram, shorts, snap, twitter; case-insensitive). Keeps captions out of that app's buttons and text. If the user says "para TikTok" / "for Reels", pass it; if they did not say and it matters, ask. Same price. Unknown values return 422 invalid_platform before any charge. See list_platforms.
presetId	string
atSeconds	number	Second of the video for the frame (or clip start). Default 0.

quote

Free. Cents (credits) a job would cost, without charging. Works without a key when you pass operation and durationSeconds. With a key you can pass fileId or mediaUrl instead and the duration is probed. Operations: caption (caption_video: transcribe+burn 5/min, +2/min with translateTo), transcribe 1/min, burn 4/min, preview 1 flat, translate 2/min, shorts 6 per source min, trim 3 per kept min (a media quote for trim is an upper bound), dub 5/min basic or 12/min standard voice per target language (the quote adds transcription and translation and shows a breakdown).

read-only

Argument	Type	Description
fileId	string
mediaUrl	string
operation*	string
voiceTier	string	dub only.
translateTo	string	caption only: include translation in the price.
targetLanguage	string	dub only. Checked against the supported voices.
durationSeconds	number

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "operation"
  ],
  "properties": {
    "fileId": {
      "type": "string"
    },
    "mediaUrl": {
      "type": "string"
    },
    "operation": {
      "enum": [
        "caption",
        "transcribe",
        "burn",
        "preview",
        "translate",
        "shorts",
        "trim",
        "dub",
        "style_preview"
      ],
      "type": "string"
    },
    "voiceTier": {
      "enum": [
        "basic",
        "standard"
      ],
      "type": "string",
      "description": "dub only."
    },
    "translateTo": {
      "type": "string",
      "description": "caption only: include translation in the price."
    },
    "targetLanguage": {
      "type": "string",
      "description": "dub only. Checked against the supported voices."
    },
    "durationSeconds": {
      "type": "number",
      "exclusiveMinimum": 0
    }
  }
}

remove_silences

Paid: 3 credits per kept minute, plus 4 per kept minute with burnCaptions (same as burn_captions). Removes silences and filler words from a talking video and returns the cut MP4, retimed SRT/VTT/JSON captions, and stats (sourceSeconds, keptSeconds, removedSeconds, cuts, fillersRemoved). Needs a transcript: pass transcriptionJobId (from transcribe or caption_video) or subtitles. Silences: gaps between words over silenceGapSeconds (default 0.5 s) are cut, keeping paddingSeconds (default 0.08 s) on each side; ffmpeg silencedetect (silenceNoiseDb, default -35) also cuts long pauses inside word timings (detectSilences:false to skip). Fillers (default fillerMode 'clear'): uh, um, er, ah, eh, ehm, em, hmm, mm, and Spanish 'este' only when said on its own. fillerMode 'aggressive' also cuts like, you know, I mean, basically, kind of, sort of, o sea, bueno, pues, digamos, tipo, como que, a ver, only when they stand alone (comma or pause). fillers adds words or phrases; keepFillers keeps some; removeFillers:false keeps all. Every cut gets a short audio fade so joins do not click. burnCaptions:true burns the retimed captions in the same job with preset/brandPresetId/platform/autoFit (same renderer as burn_captions). Billed on the kept duration.

Argument	Type	Description
fileId	string
preset	string	With burnCaptions: preset id or name (or custom:cp_...). Default Clarity.
autoFit	boolean
fillers	array	Extra fillers to always cut, words or phrases.
mediaUrl	string
platform

request_review

Free. Use when the person wants to check the captions before they are burned (e.g. 'quiero revisarlo antes', 'déjame revisar los subtítulos', 'let me check it first', names, slang or brand words that must be right). Pass a finished transcriptionJobId (from transcribe) and the preset or brandPresetId for the burn. Returns reviewUrl: a private link to the AwesomeVideo web editor, valid up to 7 days, no login, scoped to this one video. Send the link to the person. They fix text and timing, preview, and press Approve (or Reject with a note). Only on Approve does burn_captions run and charge (4 credits/min, the same as burn_captions); the review itself and the waiting are free. Poll get_review (status awaiting_review -> approved -> burnJob.status succeeded) or pass webhookUrl / notifyEmail: you then get signed events review.approved (burnJobId), review.rejected (note) and review.expired, once each, and the usual job.succeeded when the burned video is ready. Reviewers can add terms to the saved glossary from the editor.

Argument	Type	Description
preset	string	Preset id or name for the burn after approval.
autoFit	boolean	Default true: caption size, words per caption (4 on 9:16, 5 on 1:1, 7 on 16:9), and a default safe zone follow the video shape, so text reads the same at 720p and 1080p and stays clear of app UI. Pass false only when the user wants the preset's exact fixed pixel sizes. Same price.
combined	boolean	Also return SRT/VTT with the burned MP4.
platform	string	Target platform (tiktok, reels, shorts, ...) for safe-zone placement, when supported by burn_captions.
faceAvoid	boolean

resume_job

Restart a failed job (caption_video, transcribe, create_clips, dub_video, trim/remove_silences, generate_metadata) from where it stopped. Long transcriptions are saved chunk by chunk (30 s pieces), so the resumed job transcribes only the missing chunks and you pay the original price minus the transcription minutes already done (1 credit/min). For caption_video a finished transcript (and translation) is reused, so usually only the burn is charged (4 credits/min). The failed job stays fully refunded. Idempotent: calling again returns the same resumed job, never a second charge. Returns a new job id; poll get_job. Example: resume_job {"jobId":"<failed id>"}. 422 resume_not_supported / resume_media_expired (charged:false): call the original tool again. 409 job_not_resumable with reason no_speech (charged:false): no speech was detected, so a resume would give the same result (transcribe jobs with no speech finish as succeeded with result.noSpeech:true and cost 0; caption/clips/metadata fail with error no_speech and resumable:false).

Argument	Type	Description
jobId*	string	Id of the failed caption_video job.
maxCredits	number	Refuse if resuming would cost more than this.
webhookUrl	string
notifyEmail	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "jobId"
  ],
  "properties": {
    "jobId": {
      "type": "string",
      "description": "Id of the failed caption_video job."
    },
    "maxCredits": {
      "type": "number",
      "minimum": 0,
      "description": "Refuse if resuming would cost more than this."
    },
    "webhookUrl": {
      "type": "string"
    },
    "notifyEmail": {
      "type": "string"
    }
  }
}

save_brand_preset

Save a font (one of the bundled fonts: Inter, Poppins, Oswald, Roboto, Anton, Bebas Neue, Playfair Display, Caveat, IBM Plex Mono), #RRGGBB color, position (top, center, bottom), and optional logoBase64 PNG, JPEG, or WebP. Free. Pass brandPresetId to burn_captions or preview.

read-only

Argument	Type	Description
name*	string
color	string
position	string
fontFamily*	string
logoBase64	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "name",
    "fontFamily"
  ],
  "properties": {
    "name": {
      "type": "string"
    },
    "color": {
      "type": "string"
    },
    "position": {
      "enum": [
        "top",
        "center",
        "bottom"
      ],
      "type": "string"
    },
    "fontFamily": {
      "type": "string"
    },
    "logoBase64": {
      "type": "string"
    }
  }
}

save_custom_preset

Free. Design and save your own full caption preset for this key (or the account when the key is claimed). Either pass style (the full document) or basePreset (e.g. 'hormozi-style', 'Clarity', or custom:cp_...) plus overrides (deep-merged; null removes a field). The style is validated with the same schema the renderer uses; invalid styles return 422 invalid_style with errors [{path, message}]. Returns id custom:cp_...: pass it as preset to burn_captions, caption_video, preview, shorts, prepare_client_burn, review or plan; server and browser renders are identical. Up to 50 presets, 20 KB each. Private until you call submit_custom_preset. Tip: get_style_reference lists every field with examples (wordHighlights rules, smartEmphasis, wordStateStyles); validate_preset_style and preview (one still) before a paid burn.

read-only

Argument	Type	Description
name*	string
style	object	Full caption style JSON, the same document list_presets returns in style and the web editor stores: fontFamily, fontWeight, fontSize (px at 720p), color, strokeWidth/strokeColor, backgroundEnabled/backgroundColor/backgroundOpacity/paddingX/paddingY/borderRadius, shadow, position (top\|center\|bottom), margin, subtitleWidth, textTransform, letterSpacing, revealMode (none\|full\|progressive\|word-by-word), animationEnabled + animation (Fade\|Zoom In\|Zoom Out\|Slide Up\|Slide Down), motion, wordStateStyles {active\|past\|upcoming\|future: partial style}, wordHighlights {rules,customLists}, smartEmphasis, segmentColorCycle. Unknown fields are rejected. fontFamily (also inside wordStateStyles) must be a bundled font: Inter, Poppins, Oswald, Roboto, Anton, Bebas Neue, Playfair Display, Caveat, IBM Plex Mono (list_presets returns fonts). Caption forms: maxWordsPerCaption 1-8 (1 = one big word at a time; wins over the autoFit words cap). activeWordReflow true = a scaled active word pushes neighbours aside. wordEntrance bounce\|slide-up\|fade (+ wordEntranceDuration seconds) animates each word when spoken. positionMode cycle\|keyword (+ positionCycle [top\|center\|bottom], positionKeywords [words], keywordPosition) moves captions, always inside the safe zone. captionLayout stacked = poster, one word per line with a bigger hero word (posterHeroScale 1-3). faceAvoid true = burns detect faces and move captions off them; the result returns faceAvoid.faceLayout, store it as style.faceLayout to reuse.

save_glossary

Free. Save brand names, product names, people, slang and dialect spellings so future transcriptions get them right. Each entry: term (the correct spelling), aliases (what speech-to-text writes instead, replaced word-for-word, e.g. term 'AwesomeVideo' aliases ['awesome video','ausom video']; term 'po' aliases ['pues'] only if you really want that), doNotTranslate (keep it as is when translating). Merges by term unless mode is replace. Up to 200 terms, 10 aliases each.

Argument	Type	Description
mode	string
entries*	array

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "entries"
  ],
  "properties": {
    "mode": {
      "enum": [
        "merge",
        "replace"
      ],
      "type": "string"
    },
    "entries": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "term"
        ],
        "properties": {
          "note": {
            "type": "string",
            "maxLength": 200
          },
          "term": {
            "type": "string",
            "maxLength": 80
          },
          "aliases": {
            "type": "array",
            "items": {
              "type": "string",
              "maxLength": 80
            },
            "maxItems": 10
          },
          "doNotTranslate": {
            "type": "boolean"
          }
        }
      }
    }
  }
}

shorts

Paid: 6 credits per source minute. Pick 1-5 non-overlapping moments from a transcript, reframe each to 720x1280 (9:16), and burn captions. reframe=face (default) follows the main speaker with a smoothed crop and falls back to center when no face is found; reframe=center forces a center crop. Same price either way. platform (tiktok, instagram_reels, youtube_shorts, ...) keeps captions inside that app's safe zone at the same price; say "shorts para Reels" → platform=instagram_reels. Clip length is minSeconds (5-60, default 15) to maxSeconds (up to 60); out-of-range values return 422 limit_exceeded before any charge. Long transcripts are read in windows of 400 cues (up to 4000). 402 insufficient_balance with checkoutUrl when the balance is short.

Argument	Type	Description
count	integer	1-5 clips. Out of range returns limit_exceeded before any charge.
fileId	string
preset	string
autoFit	boolean	Default true: caption size, words per caption (4 on 9:16, 5 on 1:1, 7 on 16:9), and a default safe zone follow the video shape, so text reads the same at 720p and 1080p and stays clear of app UI. Pass false only when the user wants the preset's exact fixed pixel sizes. Same price.
reframe	string	face (default): track the main speaker. center: plain center crop. Same price.
mediaUrl	string
platform

style_preview

FREE, never charges, no transcription. Use BEFORE caption_video whenever the person wants to see or choose how captions will look ('qué estilos hay', 'muéstrame cómo queda', 'which captions look best'). Takes the SAME look fields as caption_video (sourceUrl/fileId, preset or presets, language, translateTo, brandPresetId, styleOverrides, faceAvoid, highlightWords, highlightColor, platform, autoFit) and renders each preset with the burn's engine at the burn's output size, safe zone and words-per-caption, on the real frame at atSeconds (one second or up to 3 -> one sheet row each; default a frame with a face, else the middle). Captions are text (sample phrase, max 80 chars; default a short phrase in translateTo/language) with the active word highlighted; if text is longer than one caption the frame shows the chunk on screen at that second, like the burn (truncated:true; fullText:true shows every line but no longer matches a burn). Already have a transcript? Pass transcriptionJobId or subtitles to see the real caption at that second. Returns sheetUrl (labeled contact sheet), per-preset frames[] urls and captionVideoArgs: pass that object unchanged to caption_video (or POST /v1/captions) to get what you saw. Limits: 30 sheets/hour, 200/day per key (429 rate_limited + retryAfterSeconds); identical repeats come from cache and do not count.

read-only

Argument	Type	Description
text	string	Preview only: sample phrase.
fileId	string
preset	string	One preset (same as caption_video).
autoFit	boolean
presets

submit_custom_preset

Free. Propose one of your custom presets for the public AwesomeVideo community gallery. It becomes pending and a human moderator reviews it; it appears in list_presets for everyone only after approval (never automatic). Max 5 submissions per day. Check status with get_custom_preset (community.status).

Argument	Type	Description
id*	string
tags	array
author	string	Public credit, e.g. the agent or person name. Default 'AI agent'.
description	string
previewText	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 24
      },
      "maxItems": 8
    },
    "author": {
      "type": "string",
      "maxLength": 80,
      "description": "Public credit, e.g. the agent or person name. Default 'AI agent'."
    },
    "description": {
      "type": "string",
      "maxLength": 500
    },
    "previewText": {
      "type": "string",
      "maxLength": 140
    }
  }
}

transcribe

Transcribe speech with Workers AI Whisper (@cf/openai/whisper-large-v3-turbo). Audio is extracted and downsampled to 16 kHz mono before the model runs; video frames are not decoded. Pass a media URL or an uploaded file id. Language defaults to auto. format is srt, vtt, or json with word timestamps. This is prepaid. A key with too little balance gets a 402 insufficient_balance payload (requiredCents, balanceCents, checkoutUrl, howToBuy) and no job starts. Cache hits are scoped to the API key and include language, format, and duration hint. A different key cannot read another key's result.

Argument	Type	Description
fileId	string	Id from create_upload, upload_base64, or POST /v1/uploads.
format	string	Default json, including word timestamps.
glossary	array	Names and terms. Used as the Whisper prompt and to fix close spellings. Included in the transcription price.
language	string	BCP-47 language, or omit for auto.
mediaUrl	string	HTTPS URL of the audio or video file.
maxCredits	number	Refuse the job when the debit would exceed this many cents.
webhookUrl	string	Public https URL. POSTed an HMAC-signed JSON body when the job finishes. Three tries.

translate

Paid: 2 credits per minute. Translate captions (transcriptionJobId or subtitles) with Workers AI m2m100 and keep cue timing; returns SRT, VTT, and JSON. Word-level highlight is not kept. burn:true also burns the translation (adds 4 credits per minute) and needs media plus a preset.

Argument	Type	Description
burn	boolean
fileId	string
preset	string
mediaUrl	string
faceAvoid	boolean	true = move captions off faces (samples faces at 2 fps, same price; result.faceAvoid.faceLayout). Shortcut for styleOverrides.faceAvoid.
subtitles	string
maxCredits	number
highlightColor	string	#RRGGBB for highlightWords. Default #FACC15.
highlightWords	array	Shortcut: words or phrases to color in every caption (accent/case-insensitive), e.g. ["AwesomeVideo", "gratis"]. Maps to styleOverrides.wordHighlights rule {id:"custom", words, color}. Same price.

trim

Same as remove_silences. Paid: 3 credits per kept minute, plus 4 per kept minute with burnCaptions (same as burn_captions). Removes silences and filler words from a talking video and returns the cut MP4, retimed SRT/VTT/JSON captions, and stats (sourceSeconds, keptSeconds, removedSeconds, cuts, fillersRemoved). Needs a transcript: pass transcriptionJobId (from transcribe or caption_video) or subtitles. Silences: gaps between words over silenceGapSeconds (default 0.5 s) are cut, keeping paddingSeconds (default 0.08 s) on each side; ffmpeg silencedetect (silenceNoiseDb, default -35) also cuts long pauses inside word timings (detectSilences:false to skip). Fillers (default fillerMode 'clear'): uh, um, er, ah, eh, ehm, em, hmm, mm, and Spanish 'este' only when said on its own. fillerMode 'aggressive' also cuts like, you know, I mean, basically, kind of, sort of, o sea, bueno, pues, digamos, tipo, como que, a ver, only when they stand alone (comma or pause). fillers adds words or phrases; keepFillers keeps some; removeFillers:false keeps all. Every cut gets a short audio fade so joins do not click. burnCaptions:true burns the retimed captions in the same job with preset/brandPresetId/platform/autoFit (same renderer as burn_captions). Billed on the kept duration.

Argument	Type	Description
fileId	string
preset	string	With burnCaptions: preset id or name (or custom:cp_...). Default Clarity.
autoFit	boolean
fillers	array	Extra fillers to always cut, words or phrases.
mediaUrl	string
platform

update_custom_preset

Free. Rename, re-describe, or restyle a saved custom preset. style replaces the whole document; overrides deep-merge onto the current style (or onto basePreset when given). Validated like save_custom_preset. An already submitted community copy is a snapshot and does not change.

read-only

Argument	Type	Description
id*	string
name	string
style	object
overrides	object
basePreset	string
description	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string",
      "maxLength": 80
    },
    "style": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    },
    "overrides": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    },
    "basePreset": {
      "type": "string"
    },
    "description": {
      "type": "string",
      "maxLength": 500
    }
  }
}

upload_base64

Free. Upload a short clip of up to 10 MB inline as base64 and get a fileId. For anything larger, or when you can run curl, use create_upload. Over the limit returns 422 limit_exceeded with charged:false. Up to 30 per hour.

Argument	Type	Description
data*	string	File bytes as base64 (a data: URL prefix is accepted).
filename*	string
contentType*	string	video/* or audio/*.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "filename",
    "contentType",
    "data"
  ],
  "properties": {
    "data": {
      "type": "string",
      "description": "File bytes as base64 (a data: URL prefix is accepted)."
    },
    "filename": {
      "type": "string",
      "maxLength": 200
    },
    "contentType": {
      "type": "string",
      "description": "video/* or audio/*."
    }
  }
}

validate_preset_style

Free, no key needed (except for custom:cp_... bases). Check a caption style document (or basePreset + overrides) against the renderer schema without saving. Returns valid and the normalized style, or errors [{path, message}].

read-only

Argument	Type	Description
style	object
overrides	object
basePreset	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "style": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    },
    "overrides": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    },
    "basePreset": {
      "type": "string"
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "fileId": {
      "type": "string"
    },
    "preset": {
      "type": "string",
      "description": "Preset id or name, or custom:cp_... for your own saved preset. Use presetId or presetName too."
    },
    "autoFit": {
      "type": "boolean",
      "description": "Default true: caption size, words per caption (4 on 9:16, 5 on 1:1, 7 on 16:9), and a default safe zone follow the video shape, so text reads the same at 720p and 1080p and stays clear of app UI. Pass false only when the user wants the preset's exact fixed pixel sizes. Same price."
    },
    "combined": {
      "type": "boolean",
      "description": "Also return SRT, VTT, and transcript JSON. Same burn price."
    },
    "mediaUrl": {
      "type": "string",
      "format": "uri"
    },
    "platform": {
      "type": "string",
      "description": "Where the video will be posted: tiktok, instagram_reels, youtube_shorts, facebook_reels, snapchat_spotlight, linkedin, youtube, x (aliases like reels, instagram, shorts, snap, twitter; case-insensitive). Keeps captions out of that app's buttons and text. If the user says \"para TikTok\" / \"for Reels\", pass it; if they did not say and it matters, ask. Same price. Unknown values return 422 invalid_platform before any charge. See list_platforms."
    },
    "presetId": {
      "type": "string"
    },
    "faceAvoid": {
      "type": "boolean",
      "description": "true = move captions off faces (samples faces at 2 fps, same price; result.faceAvoid.faceLayout). Shortcut for styleOverrides.faceAvoid."
    },
    "subtitles": {
      "type": "string",
      "description": "SRT, VTT, or JSON cues."
    },
    "maxCredits": {
      "type": "number",
      "minimum": 0
    },
    "presetName": {
      "type": "string"
    },
    "webhookUrl": {
      "type": "string"
    },
    "notifyEmail": {
      "type": "string"
    },
    "brandPresetId": {
      "type": "string",
      "description": "Saved font, color, position, and optional logo."
    },
    "highlightColor": {
      "type": "string",
      "description": "#RRGGBB for highlightWords. Default #FACC15."
    },
    "highlightWords": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxItems": 200,
      "description": "Shortcut: words or phrases to color in every caption (accent/case-insensitive), e.g. [\"AwesomeVideo\", \"gratis\"]. Maps to styleOverrides.wordHighlights rule {id:\"custom\", words, color}. Same price."
    },
    "styleOverrides": {
      "type": "object",
      "description": "Per-call style changes deep-merged onto the preset (same fields as list_presets style; null removes a field), validated with the renderer schema and bundled fonts. Example {\"fontSize\":72,\"maxWordsPerCaption\":2,\"wordEntrance\":\"bounce\"}. Same price. No need to save_custom_preset. Every field with examples: get_style_reference.",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    },
    "durationSeconds": {
      "type": "number",
      "exclusiveMinimum": 0
    },
    "transcriptionJobId": {
      "type": "string"
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "wait": {
      "type": "boolean",
      "description": "Block until done, up to waitSeconds. Default true."
    },
    "fileId": {
      "type": "string",
      "description": "Id from create_upload, import_url, or upload_base64."
    },
    "preset": {
      "type": "string",
      "description": "Caption style preset id or name (list_presets), or your own saved preset as custom:cp_... (save_custom_preset). Default Clarity."
    },
    "review": {
      "type": "boolean",
      "description": "Human review first: transcribes now, returns reviewUrl for the person; the burn runs and is charged only when they approve. Not with translateTo."
    },
    "autoFit": {
      "type": "boolean",
      "description": "Default true: caption size, words per caption (4 on 9:16, 5 on 1:1, 7 on 16:9), and a default safe zone follow the video shape, so text reads the same at 720p and 1080p and stays clear of app UI. Pass false only when the user wants the preset's exact fixed pixel sizes. Same price."
    },
    "glossary": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Names and brand terms to spell correctly, e.g. ['AwesomeVideo']."
    },
    "language": {
      "type": "string",
      "description": "Spoken language (BCP-47, e.g. es, en). Omit for auto-detect."
    },
    "platform": {
      "type": "string",
      "description": "Target platform: tiktok, instagram_reels, youtube_shorts, youtube, ... (aliases reels, shorts). Keeps captions clear of the app UI. Same price."
    },
    "faceAvoid": {
      "type": "boolean",
      "description": "true = move captions off faces (samples faces at 2 fps, same price; result.faceAvoid.faceLayout). Shortcut for styleOverrides.faceAvoid."
    },
    "sourceUrl": {
      "type": "string",
      "description": "Public link to the video/audio. Direct https file, chat attachment URL, Google Drive or Dropbox share link. Not YouTube."
    },
    "maxCredits": {
      "type": "number",
      "minimum": 0,
      "description": "Refuse the job if it would cost more than this many credits."
    },
    "webhookUrl": {
      "type": "string",
      "description": "Public https URL, POSTed a signed JSON body when the job finishes."
    },
    "notifyEmail": {
      "type": "string",
      "description": "Email when the job finishes. Free."
    },
    "translateTo": {
      "type": "string",
      "description": "Burn subtitles translated to this language (ISO 639-1, e.g. en). Adds 2 credits/min."
    },
    "waitSeconds": {
      "type": "integer",
      "maximum": 50,
      "minimum": 0,
      "description": "Default 45, max 50."
    },
    "instructions": {
      "type": "string",
      "maxLength": 500,
      "description": "review only: note shown to the reviewer."
    },
    "brandPresetId": {
      "type": "string",
      "description": "Saved brand preset (font, colors, position, logo)."
    },
    "highlightColor": {
      "type": "string",
      "description": "#RRGGBB for highlightWords. Default #FACC15."
    },
    "highlightWords": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxItems": 200,
      "description": "Shortcut: words or phrases to color in every caption (accent/case-insensitive), e.g. [\"AwesomeVideo\", \"gratis\"]. Maps to styleOverrides.wordHighlights rule {id:\"custom\", words, color}. Same price."
    },
    "idempotencyKey": {
      "type": "string",
      "maxLength": 200,
      "description": "Same key returns the same job instead of charging twice."
    },
    "styleOverrides": {
      "type": "object",
      "description": "Per-call style changes deep-merged onto the preset (same fields as list_presets style; null removes a field), validated with the renderer schema and bundled fonts. Example {\"fontSize\":72,\"maxWordsPerCaption\":2,\"wordEntrance\":\"bounce\"}. Same price. No need to save_custom_preset. Every field with examples: get_style_reference.",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    },
    "durationSeconds": {
      "type": "number",
      "exclusiveMinimum": 0
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "wait": {
      "type": "boolean",
      "description": "Block until done, up to waitSeconds. Default true."
    },
    "count": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": -9007199254740991,
      "description": "Clips to return, 1-10. Default 3. Out of range: 422 limit_exceeded before any charge."
    },
    "fileId": {
      "type": "string",
      "description": "Id from create_upload, import_url, or upload_base64."
    },
    "preset": {
      "type": "string",
      "description": "Caption preset id or name, or custom:cp_.... Default Clarity."
    },
    "autoFit": {
      "type": "boolean",
      "description": "Default true. Same rule as caption_video."
    },
    "reframe": {
      "enum": [
        "center",
        "face",
        "none"
      ],
      "type": "string",
      "description": "face (default): 9:16 crop that follows the speaker, center fallback. center: plain center crop. none: keep the source aspect. Same price."
    },
    "captions": {
      "type": "boolean",
      "description": "Burn captions into each clip. Default true. Same price."
    },
    "glossary": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "language": {
      "type": "string",
      "description": "Spoken language (BCP-47). Omit for auto-detect."
    },
    "platform": {
      "type": "string",
      "description": "tiktok, instagram_reels, youtube_shorts, ... (see list_platforms). Keeps captions clear of the app UI. Same price."
    },
    "faceAvoid": {
      "type": "boolean",
      "description": "true = move captions off faces (samples faces at 2 fps, same price; result.faceAvoid.faceLayout). Shortcut for styleOverrides.faceAvoid."
    },
    "quoteOnly": {
      "type": "boolean",
      "description": "Return the price for durationSeconds (and count/maxSeconds) without starting a job."
    },
    "sourceUrl": {
      "type": "string",
      "description": "Public link to the video. Not YouTube, TikTok or Instagram."
    },
    "subtitles": {
      "type": "string",
      "description": "Reuse an SRT, VTT, or JSON transcript (JSON keeps word timing for tighter cuts)."
    },
    "maxCredits": {
      "type": "number",
      "minimum": 0,
      "description": "Refuse the job if it would cost more than this many credits."
    },
    "maxSeconds": {
      "type": "number",
      "description": "Longest clip, minSeconds-90 s. Default 60."
    },
    "minSeconds": {
      "type": "number",
      "description": "Shortest clip, 5-90 s. Default 15."
    },
    "webhookUrl": {
      "type": "string"
    },
    "notifyEmail": {
      "type": "string"
    },
    "waitSeconds": {
      "type": "integer",
      "maximum": 50,
      "minimum": 0,
      "description": "Default 45, max 50."
    },
    "brandPresetId": {
      "type": "string"
    },
    "highlightColor": {
      "type": "string",
      "description": "#RRGGBB for highlightWords. Default #FACC15."
    },
    "highlightWords": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxItems": 200,
      "description": "Shortcut: words or phrases to color in every caption (accent/case-insensitive), e.g. [\"AwesomeVideo\", \"gratis\"]. Maps to styleOverrides.wordHighlights rule {id:\"custom\", words, color}. Same price."
    },
    "idempotencyKey": {
      "type": "string",
      "maxLength": 200
    },
    "styleOverrides": {
      "type": "object",
      "description": "Per-call style changes deep-merged onto the preset (same fields as list_presets style; null removes a field), validated with the renderer schema and bundled fonts. Example {\"fontSize\":72,\"maxWordsPerCaption\":2,\"wordEntrance\":\"bounce\"}. Same price. No need to save_custom_preset. Every field with examples: get_style_reference.",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    },
    "durationSeconds": {
      "type": "number",
      "exclusiveMinimum": 0
    },
    "transcriptionJobId": {
      "type": "string",
      "description": "Reuse a finished transcription: no transcription charge."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "width": {
      "type": "integer",
      "maximum": 9007199254740991,
      "exclusiveMinimum": 0
    },
    "height": {
      "type": "integer",
      "maximum": 9007199254740991,
      "exclusiveMinimum": 0
    },
    "preset": {
      "type": "string"
    },
    "autoFit": {
      "type": "boolean",
      "description": "Default true: caption size, words per caption (4 on 9:16, 5 on 1:1, 7 on 16:9), and a default safe zone follow the video shape, so text reads the same at 720p and 1080p and stays clear of app UI. Pass false only when the user wants the preset's exact fixed pixel sizes. Same price."
    },
    "platform": {
      "type": "string",
      "description": "Where the video will be posted: tiktok, instagram_reels, youtube_shorts, facebook_reels, snapchat_spotlight, linkedin, youtube, x (aliases like reels, instagram, shorts, snap, twitter; case-insensitive). Keeps captions out of that app's buttons and text. If the user says \"para TikTok\" / \"for Reels\", pass it; if they did not say and it matters, ask. Same price. Unknown values return 422 invalid_platform before any charge. See list_platforms."
    },
    "presetId": {
      "type": "string"
    },
    "faceAvoid": {
      "type": "boolean",
      "description": "true = move captions off faces (samples faces at 2 fps, same price; result.faceAvoid.faceLayout). Shortcut for styleOverrides.faceAvoid."
    },
    "subtitles": {
      "type": "string"
    },
    "presetName": {
      "type": "string"
    },
    "highlightColor": {
      "type": "string",
      "description": "#RRGGBB for highlightWords. Default #FACC15."
    },
    "highlightWords": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxItems": 200,
      "description": "Shortcut: words or phrases to color in every caption (accent/case-insensitive), e.g. [\"AwesomeVideo\", \"gratis\"]. Maps to styleOverrides.wordHighlights rule {id:\"custom\", words, color}. Same price."
    },
    "styleOverrides": {
      "type": "object",
      "description": "Per-call style changes deep-merged onto the preset (same fields as list_presets style; null removes a field), validated with the renderer schema and bundled fonts. Example {\"fontSize\":72,\"maxWordsPerCaption\":2,\"wordEntrance\":\"bounce\"}. Same price. No need to save_custom_preset. Every field with examples: get_style_reference.",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    },
    "transcriptionJobId": {
      "type": "string"
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "mode": {
      "enum": [
        "still",
        "clip"
      ],
      "type": "string"
    },
    "fileId": {
      "type": "string"
    },
    "preset": {
      "type": "string"
    },
    "autoFit": {
      "type": "boolean",
      "description": "Default true: caption size, words per caption (4 on 9:16, 5 on 1:1, 7 on 16:9), and a default safe zone follow the video shape, so text reads the same at 720p and 1080p and stays clear of app UI. Pass false only when the user wants the preset's exact fixed pixel sizes. Same price."
    },
    "mediaUrl": {
      "type": "string"
    },
    "platform": {
      "type": "string",
      "description": "Where the video will be posted: tiktok, instagram_reels, youtube_shorts, facebook_reels, snapchat_spotlight, linkedin, youtube, x (aliases like reels, instagram, shorts, snap, twitter; case-insensitive). Keeps captions out of that app's buttons and text. If the user says \"para TikTok\" / \"for Reels\", pass it; if they did not say and it matters, ask. Same price. Unknown values return 422 invalid_platform before any charge. See list_platforms."
    },
    "presetId": {
      "type": "string"
    },
    "atSeconds": {
      "type": "number",
      "minimum": 0,
      "description": "Second of the video for the frame (or clip start). Default 0."
    },
    "faceAvoid": {
      "type": "boolean",
      "description": "true = move captions off faces (samples faces at 2 fps, same price; result.faceAvoid.faceLayout). Shortcut for styleOverrides.faceAvoid."
    },
    "subtitles": {
      "type": "string"
    },
    "maxCredits": {
      "type": "number",
      "minimum": 0
    },
    "clipSeconds": {
      "type": "number",
      "maximum": 5,
      "exclusiveMinimum": 0
    },
    "brandPresetId": {
      "type": "string"
    },
    "highlightColor": {
      "type": "string",
      "description": "#RRGGBB for highlightWords. Default #FACC15."
    },
    "highlightWords": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxItems": 200,
      "description": "Shortcut: words or phrases to color in every caption (accent/case-insensitive), e.g. [\"AwesomeVideo\", \"gratis\"]. Maps to styleOverrides.wordHighlights rule {id:\"custom\", words, color}. Same price."
    },
    "styleOverrides": {
      "type": "object",
      "description": "Per-call style changes deep-merged onto the preset (same fields as list_presets style; null removes a field), validated with the renderer schema and bundled fonts. Example {\"fontSize\":72,\"maxWordsPerCaption\":2,\"wordEntrance\":\"bounce\"}. Same price. No need to save_custom_preset. Every field with examples: get_style_reference.",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    },
    "transcriptionJobId": {
      "type": "string"
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "fileId": {
      "type": "string"
    },
    "preset": {
      "type": "string",
      "description": "With burnCaptions: preset id or name (or custom:cp_...). Default Clarity."
    },
    "autoFit": {
      "type": "boolean"
    },
    "fillers": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxItems": 50,
      "description": "Extra fillers to always cut, words or phrases."
    },
    "mediaUrl": {
      "type": "string"
    },
    "platform": {
      "type": "string",
      "description": "With burnCaptions: tiktok, reels, shorts, ... for safe zones."
    },
    "faceAvoid": {
      "type": "boolean",
      "description": "true = move captions off faces (samples faces at 2 fps, same price; result.faceAvoid.faceLayout). Shortcut for styleOverrides.faceAvoid."
    },
    "quoteOnly": {
      "type": "boolean",
      "description": "Free: return the price for durationSeconds without starting a job or charging (upper bound: every second kept)."
    },
    "subtitles": {
      "type": "string"
    },
    "fillerMode": {
      "enum": [
        "clear",
        "aggressive"
      ],
      "type": "string"
    },
    "maxCredits": {
      "type": "number",
      "minimum": 0
    },
    "keepFillers": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxItems": 50,
      "description": "Fillers to keep, e.g. ['like']."
    },
    "burnCaptions": {
      "type": "boolean",
      "description": "Burn the retimed captions in the same job."
    },
    "brandPresetId": {
      "type": "string"
    },
    "removeFillers": {
      "type": "boolean"
    },
    "detectSilences": {
      "type": "boolean",
      "description": "Default true: ffmpeg silencedetect also cuts long pauses."
    },
    "highlightColor": {
      "type": "string",
      "description": "#RRGGBB for highlightWords. Default #FACC15."
    },
    "highlightWords": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxItems": 200,
      "description": "Shortcut: words or phrases to color in every caption (accent/case-insensitive), e.g. [\"AwesomeVideo\", \"gratis\"]. Maps to styleOverrides.wordHighlights rule {id:\"custom\", words, color}. Same price."
    },
    "paddingSeconds": {
      "type": "number",
      "maximum": 0.3,
      "minimum": 0,
      "description": "Kept on each side of a cut. Default 0.08."
    },
    "silenceNoiseDb": {
      "type": "number",
      "maximum": -10,
      "minimum": -80,
      "description": "Silence threshold in dB. Default -35."
    },
    "styleOverrides": {
      "type": "object",
      "description": "Per-call style changes deep-merged onto the preset (same fields as list_presets style; null removes a field), validated with the renderer schema and bundled fonts. Example {\"fontSize\":72,\"maxWordsPerCaption\":2,\"wordEntrance\":\"bounce\"}. Same price. No need to save_custom_preset. Every field with examples: get_style_reference.",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    },
    "durationSeconds": {
      "type": "number",
      "description": "Source length for quoteOnly.",
      "exclusiveMinimum": 0
    },
    "silenceGapSeconds": {
      "type": "number",
      "maximum": 3,
      "minimum": 0.2,
      "description": "Cut pauses longer than this. Default 0.5."
    },
    "transcriptionJobId": {
      "type": "string"
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "transcriptionJobId"
  ],
  "properties": {
    "preset": {
      "type": "string",
      "description": "Preset id or name for the burn after approval."
    },
    "autoFit": {
      "type": "boolean",
      "description": "Default true: caption size, words per caption (4 on 9:16, 5 on 1:1, 7 on 16:9), and a default safe zone follow the video shape, so text reads the same at 720p and 1080p and stays clear of app UI. Pass false only when the user wants the preset's exact fixed pixel sizes. Same price."
    },
    "combined": {
      "type": "boolean",
      "description": "Also return SRT/VTT with the burned MP4."
    },
    "platform": {
      "type": "string",
      "description": "Target platform (tiktok, reels, shorts, ...) for safe-zone placement, when supported by burn_captions."
    },
    "faceAvoid": {
      "type": "boolean",
      "description": "true = move captions off faces (samples faces at 2 fps, same price; result.faceAvoid.faceLayout). Shortcut for styleOverrides.faceAvoid."
    },
    "maxCredits": {
      "type": "number",
      "minimum": 0,
      "description": "Refuse the burn on approval if it would exceed this many cents."
    },
    "webhookUrl": {
      "type": "string",
      "description": "Gets review.approved / review.rejected / review.expired events and the burn job result when it finishes."
    },
    "notifyEmail": {
      "type": "string"
    },
    "instructions": {
      "type": "string",
      "maxLength": 500,
      "description": "Shown to the reviewer, e.g. 'Revisa nombres de productos'."
    },
    "brandPresetId": {
      "type": "string"
    },
    "expiresInDays": {
      "type": "number",
      "maximum": 7,
      "minimum": 1,
      "description": "Default 7."
    },
    "highlightColor": {
      "type": "string",
      "description": "#RRGGBB for highlightWords. Default #FACC15."
    },
    "highlightWords": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxItems": 200,
      "description": "Shortcut: words or phrases to color in every caption (accent/case-insensitive), e.g. [\"AwesomeVideo\", \"gratis\"]. Maps to styleOverrides.wordHighlights rule {id:\"custom\", words, color}. Same price."
    },
    "styleOverrides": {
      "type": "object",
      "description": "Per-call style changes deep-merged onto the preset (same fields as list_presets style; null removes a field), validated with the renderer schema and bundled fonts. Example {\"fontSize\":72,\"maxWordsPerCaption\":2,\"wordEntrance\":\"bounce\"}. Same price. No need to save_custom_preset. Every field with examples: get_style_reference.",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    },
    "transcriptionJobId": {
      "type": "string",
      "description": "Succeeded transcribe job id. Its media must still be stored (48 h)."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 80
    },
    "style": {
      "type": "object",
      "description": "Full caption style JSON, the same document list_presets returns in style and the web editor stores: fontFamily, fontWeight, fontSize (px at 720p), color, strokeWidth/strokeColor, backgroundEnabled/backgroundColor/backgroundOpacity/paddingX/paddingY/borderRadius, shadow*, position (top|center|bottom), margin, subtitleWidth, textTransform, letterSpacing, revealMode (none|full|progressive|word-by-word), animationEnabled + animation (Fade|Zoom In|Zoom Out|Slide Up|Slide Down), motion*, wordStateStyles {active|past|upcoming|future: partial style}, wordHighlights {rules,customLists}, smartEmphasis, segmentColorCycle. Unknown fields are rejected. fontFamily (also inside wordStateStyles) must be a bundled font: Inter, Poppins, Oswald, Roboto, Anton, Bebas Neue, Playfair Display, Caveat, IBM Plex Mono (list_presets returns fonts). Caption forms: maxWordsPerCaption 1-8 (1 = one big word at a time; wins over the autoFit words cap). activeWordReflow true = a scaled active word pushes neighbours aside. wordEntrance bounce|slide-up|fade (+ wordEntranceDuration seconds) animates each word when spoken. positionMode cycle|keyword (+ positionCycle [top|center|bottom], positionKeywords [words], keywordPosition) moves captions, always inside the safe zone. captionLayout stacked = poster, one word per line with a bigger hero word (posterHeroScale 1-3). faceAvoid true = burns detect faces and move captions off them; the result returns faceAvoid.faceLayout, store it as style.faceLayout to reuse.",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    },
    "overrides": {
      "type": "object",
      "description": "Style fields to change on top of basePreset (or of style).",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    },
    "basePreset": {
      "type": "string",
      "description": "Start from this preset (id, slug, name, or custom:cp_...) instead of a full style."
    },
    "description": {
      "type": "string",
      "maxLength": 500
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "count": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": -9007199254740991,
      "description": "1-5 clips. Out of range returns limit_exceeded before any charge."
    },
    "fileId": {
      "type": "string"
    },
    "preset": {
      "type": "string"
    },
    "autoFit": {
      "type": "boolean",
      "description": "Default true: caption size, words per caption (4 on 9:16, 5 on 1:1, 7 on 16:9), and a default safe zone follow the video shape, so text reads the same at 720p and 1080p and stays clear of app UI. Pass false only when the user wants the preset's exact fixed pixel sizes. Same price."
    },
    "reframe": {
      "enum": [
        "face",
        "center"
      ],
      "type": "string",
      "description": "face (default): track the main speaker. center: plain center crop. Same price."
    },
    "mediaUrl": {
      "type": "string"
    },
    "platform": {
      "type": "string",
      "description": "Where the video will be posted: tiktok, instagram_reels, youtube_shorts, facebook_reels, snapchat_spotlight, linkedin, youtube, x (aliases like reels, instagram, shorts, snap, twitter; case-insensitive). Keeps captions out of that app's buttons and text. If the user says \"para TikTok\" / \"for Reels\", pass it; if they did not say and it matters, ask. Same price. Unknown values return 422 invalid_platform before any charge. See list_platforms."
    },
    "faceAvoid": {
      "type": "boolean",
      "description": "true = move captions off faces (samples faces at 2 fps, same price; result.faceAvoid.faceLayout). Shortcut for styleOverrides.faceAvoid."
    },
    "subtitles": {
      "type": "string"
    },
    "maxCredits": {
      "type": "number",
      "minimum": 0
    },
    "maxSeconds": {
      "type": "number",
      "description": "Longest clip, minSeconds-60 seconds."
    },
    "minSeconds": {
      "type": "number",
      "description": "Shortest clip, 5-60 seconds. Default 15."
    },
    "highlightColor": {
      "type": "string",
      "description": "#RRGGBB for highlightWords. Default #FACC15."
    },
    "highlightWords": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxItems": 200,
      "description": "Shortcut: words or phrases to color in every caption (accent/case-insensitive), e.g. [\"AwesomeVideo\", \"gratis\"]. Maps to styleOverrides.wordHighlights rule {id:\"custom\", words, color}. Same price."
    },
    "styleOverrides": {
      "type": "object",
      "description": "Per-call style changes deep-merged onto the preset (same fields as list_presets style; null removes a field), validated with the renderer schema and bundled fonts. Example {\"fontSize\":72,\"maxWordsPerCaption\":2,\"wordEntrance\":\"bounce\"}. Same price. No need to save_custom_preset. Every field with examples: get_style_reference.",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    },
    "transcriptionJobId": {
      "type": "string"
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "text": {
      "type": "string",
      "maxLength": 80,
      "description": "Preview only: sample phrase."
    },
    "fileId": {
      "type": "string"
    },
    "preset": {
      "type": "string",
      "description": "One preset (same as caption_video)."
    },
    "autoFit": {
      "type": "boolean"
    },
    "presets": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxItems": 12,
      "description": "Up to 12 presets to compare; default 6 that fit the video shape."
    },
    "fullText": {
      "type": "boolean",
      "description": "Preview only: show all words in one caption (does not match a burn)."
    },
    "language": {
      "type": "string"
    },
    "mediaUrl": {
      "type": "string",
      "description": "Alias of sourceUrl."
    },
    "platform": {
      "type": "string"
    },
    "atSeconds": {
      "anyOf": [
        {
          "type": "number",
          "minimum": 0
        },
        {
          "type": "array",
          "items": {
            "type": "number",
            "minimum": 0
          },
          "maxItems": 3,
          "minItems": 1
        }
      ],
      "description": "Preview only: second(s) of the video to show; up to 3 = one sheet."
    },
    "faceAvoid": {
      "type": "boolean"
    },
    "sourceUrl": {
      "type": "string",
      "description": "Same as caption_video."
    },
    "subtitles": {
      "type": "string",
      "description": "Preview only: SRT/VTT/JSON captions to show instead of a sample phrase."
    },
    "translateTo": {
      "type": "string",
      "description": "Same as caption_video; the default sample phrase uses this language."
    },
    "brandPresetId": {
      "type": "string"
    },
    "highlightColor": {
      "type": "string"
    },
    "highlightWords": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxItems": 200
    },
    "styleOverrides": {
      "type": "object",
      "description": "Same as caption_video, applied to every preset.",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    },
    "transcriptionJobId": {
      "type": "string",
      "description": "Preview only: show real captions from this transcription (no new transcription)."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "fileId": {
      "type": "string"
    },
    "preset": {
      "type": "string",
      "description": "With burnCaptions: preset id or name (or custom:cp_...). Default Clarity."
    },
    "autoFit": {
      "type": "boolean"
    },
    "fillers": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxItems": 50,
      "description": "Extra fillers to always cut, words or phrases."
    },
    "mediaUrl": {
      "type": "string"
    },
    "platform": {
      "type": "string",
      "description": "With burnCaptions: tiktok, reels, shorts, ... for safe zones."
    },
    "faceAvoid": {
      "type": "boolean",
      "description": "true = move captions off faces (samples faces at 2 fps, same price; result.faceAvoid.faceLayout). Shortcut for styleOverrides.faceAvoid."
    },
    "quoteOnly": {
      "type": "boolean",
      "description": "Free: return the price for durationSeconds without starting a job or charging (upper bound: every second kept)."
    },
    "subtitles": {
      "type": "string"
    },
    "fillerMode": {
      "enum": [
        "clear",
        "aggressive"
      ],
      "type": "string"
    },
    "maxCredits": {
      "type": "number",
      "minimum": 0
    },
    "keepFillers": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxItems": 50,
      "description": "Fillers to keep, e.g. ['like']."
    },
    "burnCaptions": {
      "type": "boolean",
      "description": "Burn the retimed captions in the same job."
    },
    "brandPresetId": {
      "type": "string"
    },
    "removeFillers": {
      "type": "boolean"
    },
    "detectSilences": {
      "type": "boolean",
      "description": "Default true: ffmpeg silencedetect also cuts long pauses."
    },
    "highlightColor": {
      "type": "string",
      "description": "#RRGGBB for highlightWords. Default #FACC15."
    },
    "highlightWords": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxItems": 200,
      "description": "Shortcut: words or phrases to color in every caption (accent/case-insensitive), e.g. [\"AwesomeVideo\", \"gratis\"]. Maps to styleOverrides.wordHighlights rule {id:\"custom\", words, color}. Same price."
    },
    "paddingSeconds": {
      "type": "number",
      "maximum": 0.3,
      "minimum": 0,
      "description": "Kept on each side of a cut. Default 0.08."
    },
    "silenceNoiseDb": {
      "type": "number",
      "maximum": -10,
      "minimum": -80,
      "description": "Silence threshold in dB. Default -35."
    },
    "styleOverrides": {
      "type": "object",
      "description": "Per-call style changes deep-merged onto the preset (same fields as list_presets style; null removes a field), validated with the renderer schema and bundled fonts. Example {\"fontSize\":72,\"maxWordsPerCaption\":2,\"wordEntrance\":\"bounce\"}. Same price. No need to save_custom_preset. Every field with examples: get_style_reference.",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    },
    "durationSeconds": {
      "type": "number",
      "description": "Source length for quoteOnly.",
      "exclusiveMinimum": 0
    },
    "silenceGapSeconds": {
      "type": "number",
      "maximum": 3,
      "minimum": 0.2,
      "description": "Cut pauses longer than this. Default 0.5."
    },
    "transcriptionJobId": {
      "type": "string"
    }
  }
}

AwesomeVideo

Try it

abort_upload Destructive

AwesomeVideo

Try it

abort_upload Destructive

Install

Tools (51)

Security checkA100/100