AwesomeVideo

Save custom caption preset

save_custom_preset

Read-onlyIdempotent

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.

Input Schema

Name	Required	Description
`name`	Yes
`style`	No	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.
`overrides`	No	Style fields to change on top of basePreset (or of style).
`basePreset`	No	Start from this preset (id, slug, name, or custom:cp_...) instead of a full style.
`description`	No

Schema Changelog

Changes observed during successful MCP inspections.

First observedOct 31, 2026

TDQS

A3.9/5.0

Behavior1/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

The description unambiguously describes a persistent write ('save your own full caption preset', 50-preset / 20 KB quotas, private-until-submitted state), but the annotations declare readOnlyHint=true and carry a title copied from another tool ('Prepare client burn'). An agent trusting the annotation would treat this as a non-mutating read, which is the opposite of the described behavior.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with cost ('Free.') and the core action, then packed with actionable detail; almost every sentence carries a constraint or routing hint. It is dense and run-on rather than wasteful, so only lightly penalized for readability.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Covers return value (id custom:cp_... and where to pass it), error behavior, quotas, privacy state, and a validation workflow — strong for a 5-param tool with no output schema. Gaps remain around the required `name` field and the `description` field's purpose.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Adds real meaning beyond the schema: overrides are deep-merged and 'null removes a field', basePreset accepts id/slug/name/custom:cp_ forms, and invalid styles return 422 invalid_style with [{path, message}]. The required `name` and the optional `description` parameters are never explained, keeping it from a 5.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Design and save your own full caption preset') and scopes it to 'this key (or the account when the key is claimed)'. It is distinguishable from sibling mutations like update_custom_preset, save_brand_preset and submit_custom_preset without opening any schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly describes the two calling modes (pass a full `style`, or `basePreset` plus `overrides`), names the lifecycle step ('Private until you call submit_custom_preset'), and routes the agent to prerequisites: get_style_reference, validate_preset_style, and preview before a paid burn.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

All AwesomeVideo tools Inspect

Try in Browser

One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources

Need Help?