Videos
One video with its brief, theme config, media URLs and both job
documents. The content arrays are excluded by default because they
dominate the payload; opt into the ones you need with include.
Authorization
bearerAuth AuthorizationBearer <token>
An API key created under Settings > API & Webhooks. Keys start with sf_live_.
In: header
Path Parameters
id*string
Query Parameters
include?string
Comma-separated list of heavy arrays to embed. Known keys:
captions, captionsPages, bRolls, presentationScenes,
scenes. An unknown key is dropped rather than rejected, so a
newer client still gets its video.
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/videos/string?include=captions%2CcaptionsPages"{ "data": { "id": "string", "title": "string", "type": "faceless", "subType": "string", "isAutomation": true, "parentVideoId": "string", "isClip": true, "brief": { "prompt": "string", "text": "string", "scriptPrompt": "string", "description": "string", "descriptionPrompt": "string", "inputMode": "idea", "videoDuration": "short", "language": "string", "aspectRatio": "9:16", "imageStyle": "stock_footage", "customStyleText": "string", "voiceId": "string", "voiceProvider": "openai", "showSubtitles": true, "presentationTone": "string", "presentationAssets": [ { "type": "image", "url": "http://example.com", "description": "string" } ], "targetDuration": 0, "characterImageUrl": "http://example.com", "characterDescription": "string" }, "mood": "energetic", "presentationMood": "string", "durationSeconds": 0, "media": { "sourceUrl": "http://example.com", "audioUrl": "http://example.com", "captionsUrl": "http://example.com", "thumbnailUrl": "http://example.com", "renderUrl": "http://example.com", "bytes": 0 }, "process": { "status": "QUEUED", "progress": 0, "statusText": "string", "queuedAt": "2019-08-24T14:15:22Z", "startedAt": "2019-08-24T14:15:22Z", "error": { "code": "string", "message": "string", "blocked": true, "action": "upgrade" } }, "render": { "status": "QUEUED", "progress": 0, "queuedAt": "2019-08-24T14:15:22Z", "startedAt": "2019-08-24T14:15:22Z", "error": { "code": "string", "message": "string", "blocked": true, "action": "upgrade" } }, "publish": { "status": "SCHEDULED", "scheduledAt": "2019-08-24T14:15:22Z", "startedAt": "2019-08-24T14:15:22Z", "publishedAt": "2019-08-24T14:15:22Z", "failedAt": "2019-08-24T14:15:22Z", "platforms": [ "string" ], "missingPlatforms": [ "string" ], "caption": "string", "error": { "code": "string", "message": "string", "blocked": true, "action": "upgrade" } }, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "config": { "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" }, "captions": [ { "id": "string", "startMs": 0, "endMs": 0, "text": "string", "punctuated_word": "string", "confidence": 0 } ], "captionsPages": [ { "id": "string", "startMs": 0, "endMs": 0, "hidden": true, "emoji": {}, "audioEffect": {} } ], "bRolls": [ { "id": "string", "startMs": 0, "endMs": 0, "text": "string", "prompt": "string", "keywords": "string", "mediaType": "ai_image", "url": "http://example.com", "type": "string", "qualityUrls": {}, "animation": "string", "transition": "string", "layout": "string", "scale": 0, "hidden": true, "audioEffect": {} } ], "presentationScenes": [ { "id": "string", "startMs": 0, "endMs": 0, "text": "string", "emphasis": "string", "template": "string", "tone": "light", "caption": "show", "hidden": true, "visual": { "type": "string", "items": 1, "anchors": [ "string" ] }, "content": {}, "params": {}, "direction": {}, "composed": {} } ], "scenes": [ { "imagePrompt": "string", "animationPrompt": "string", "narration": "string", "voiceDescription": "string", "duration": 3, "id": "string", "status": "string", "imageUrl": "http://example.com", "videoUrl": "http://example.com" } ] }}Delete a video DELETE
Deletes the video, every clip made from it, and the stored files they own, then credits the freed bytes back to the workspace storage quota. This cannot be undone.
List a video's clips GET
The clips and variations made from this video, newest first. Sorted on creation time rather than activity, so a running job cannot shuffle rows between two pages of the same walk.