ShortFastDevelopers
Open ShortFast
DocumentationAPI Reference
Videos
POST
/videos/{id}/convert

Turns a finished AI video (type: ai) into the editable pipeline, so its stitched output becomes a source video with a transcript, caption pages and b-roll segments you can edit through the Editor endpoints. One-way: a video that already runs the editable pipeline is refused with 422.

Authorization

bearerAuth
AuthorizationBearer <token>

An API key created under Settings > API & Webhooks. Keys start with sf_live_.

In: header

Path Parameters

id*string

Header Parameters

Idempotency-Key?string

Unique key per action (a UUID works well). Reusing it replays the first response instead of running the action again, so a retry after a timeout can never generate, render, publish or charge twice.

Lengthlength <= 255

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/videos/string/convert"
{  "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": "auto",      "videoDuration": "subminute",      "language": "string",      "aspectRatio": "9:16",      "imageStyle": "auto",      "styleAuto": true,      "connectedBRolls": true,      "animateBRolls": true,      "animationQuality": "normal",      "bRollPace": "fast",      "backgroundMusic": true,      "bRollTransitions": true,      "customStyleText": "string",      "voiceId": "string",      "voiceProvider": "openai",      "showSubtitles": true,      "presentationTone": null,      "presentationAssets": [],      "presenter": {        "imageUrl": "http://example.com",        "avatarId": "string",        "name": "string",        "placement": "first",        "occurrences": 1      },      "targetDuration": 0,      "characterImageUrl": "http://example.com",      "characterDescription": "string"    },    "mood": "energetic",    "presentationMood": null,    "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",        "reference": "string",        "retryAt": "2019-08-24T14:15:22Z",        "platform": "string"      }    },    "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",        "reference": "string",        "retryAt": "2019-08-24T14:15:22Z",        "platform": "string"      }    },    "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"      ],      "unhealthyPlatforms": [        "string"      ],      "caption": "string",      "error": {        "code": "string",        "message": "string",        "blocked": true,        "action": "upgrade",        "reference": "string",        "retryAt": "2019-08-24T14:15:22Z",        "platform": "string"      },      "stats": {        "checkedAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z",        "available": true,        "totals": {          "views": 0,          "likes": 0,          "comments": 0,          "shares": 0        },        "platforms": [          {            "views": 0,            "likes": 0,            "comments": 0,            "shares": 0,            "platform": "string",            "status": "published",            "url": "string",            "error": "string"          }        ]      }    },    "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    },    "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": {},        "posterUrl": "http://example.com",        "sourceWidth": 0,        "sourceHeight": 0,        "stockQuery": "string",        "credit": {          "source": "string",          "author": "string",          "license": "string",          "url": "http://example.com"        },        "animation": "string",        "transition": "string",        "layout": "string",        "scale": 0,        "hidden": true,        "audioEffect": {},        "presenter": {          "imageUrl": "http://example.com",          "avatarId": "string",          "name": "string",          "bytes": 0,          "generatedAt": "2019-08-24T14:15:22Z"        }      }    ],    "presentationScenes": [],    "scenes": [      {        "imagePrompt": "string",        "animationPrompt": "string",        "narration": "string",        "voiceDescription": "string",        "duration": 3,        "id": "string",        "status": "string",        "imageUrl": "http://example.com",        "videoUrl": "http://example.com"      }    ]  }}

List narration voices GET

Every voice a brief can name in `voiceId`, with a preview clip. The `provider` is what `voiceProvider` expects: `gemini` voices are the premium expressive tier and cost more per minute than `openai` ones, only on accounts created before Oct 26, 2026.

Create a video and queue its generation POST

Creates a video from a brief and immediately queues the generation pipeline, so this call is asynchronous: it returns as soon as the job is enqueued, with `process.status: QUEUED`. Poll `GET /videos/{id}` or subscribe to `video.generation_completed`. The brief may be sent flat or nested under `brief`; the nested form wins, so a serialized video can be posted straight back. Unknown keys are ignored, a known key with a malformed value is a `400`. Generation charges credits and counts against the monthly generation limit, so it can be refused with `warning-no-credits`, `warning-plan-generations`, `warning-plan-storage` or `warning-plan-duration`. Pass `process.render: true` to chain the render as soon as generation finishes. `isAutomation` is refused here: create a blueprint with `POST /automations` instead.