API Documentation, ShortFormVideoStudio

Synchronous API: AI Short-Form Video Studio

Use this multipart endpoint only when the client can wait for scene planning, image generation, narration and FFmpeg rendering. It returns the same downloadable MP4 and project artifacts as asynchronous processing.

curl --location --request POST 'https://mxprocess.com/api/files/start-process' \
--header 'Authorization: Bearer YOUR_TOKEN' \
--form 'file=@"/path/to/source.docx"' \
--form 'actionName=ShortFormVideoStudio' \
--form 'parameters=[["language",["English"]],["audience",["startup founders"]],["platform",["TikTok and YouTube Shorts"]],["durationSeconds",["45"]]]' \
--form 'async=false'

Successful output contains shortFormVideoProject, downloadResults and the persisted action under key 0. Download JSON, caption and media assets with the standard action-result endpoint.

{"output":{"shortFormVideoProject":{"format":"1080x1920","duration_seconds":45},"downloadResults":[["short-form-video.mp4","https://storage.example/..."],["project.json","https://storage.example/..."]]},"0":{"id":123,"accomplished":true}}

Functional error example

{"error":"ERROR_SFVS001 Short-Form Video Studio requires between one and three sources."}

For production workloads, prefer the asynchronous API.