Shallow-merges the keys the body carries into the stored config and returns the whole merged object. Keys the body omits are left alone.
The body may be the config object itself or the same object nested
under config. Unknown keys are dropped; a known key with a value
outside its enum or range is a 400. A body that carries no known
config key at all is refused rather than saved as a no-op.
Authorization
bearerAuth An API key created under Settings > API & Webhooks. Keys start with sf_live_.
In: header
Path Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
The stored theme for one video: caption styling plus the presentation brand palette. Every key is optional, and only the keys listed here are accepted on a write. Unknown keys are dropped.
Response Body
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/videos/string/config" \ -H "Content-Type: application/json" \ -d '{ "captionsPrimaryColor": "#FFD400", "captionsFontSize": 84, "captionsVerticalPosition": 62 }'{ "data": { "captionsFontFamily": "string", "captionsFontWeight": "string", "captionsAnimation": "fadeInSlideUp", "captionsWordEffects": "", "captionsTextTransform": "none", "layoutMode": "wrap", "captionsPrimaryColor": "string", "captionsSecondaryColor": "string", "captionsAccentColor": "string", "captionsStrokeColor": "string", "captionsSecondaryStrokeColor": "string", "captionsAccentStrokeColor": "string", "captionsShadowColor": "string", "captionsFirstWordColor": "string", "captionsHighlightBackground": "string", "captionsFontSize": 20, "captionsVerticalPosition": 0, "captionsTextStroke": 0, "captionsActiveWordStroke": 0, "captionsLetterSpacing": -5, "presentationAccentColor": "string", "presentationAccentColorB": "string", "presentationInkColor": "string", "presentationInkSoftColor": "string", "presentationBackgroundColor": "string", "presentationPillTextColor": "string", "presentationFontFamily": "string", "presentationBackground": "string", "presentationLogoUrl": "string", "presentationIconUrl": "string" }}Edit one scene PATCH
Edits a scene's content: `imagePrompt`, `animationPrompt`, `narration`, `voiceDescription` or `duration` (5 to 20 seconds, or 3 to 20 when clamped). Provide at least one. Every editable field is content, so the scene's rendered clip and the stitched video both become stale: `videoUrl` on the scene and `renderUrl` on the video are cleared. Regenerate the still with `POST /videos/{id}/scenes/{sceneId}/image` and re-render afterwards.
API info GET
Returns API metadata and the workspace the key resolved to, including its plan, credit balance, plan limits and current usage. This is the cheapest way to verify a key: it reads nothing beyond the workspace the transport already loaded.