Enhance and export the latest saved edit

Request

Reserves a snapshot of the latest saved edit and returns immediately. The default request is {}. Enhancement completes before rendering starts. Creation-time toAutoEnhance/toAutoExport and legacy export routes keep their existing behavior. An active enhancement/export or concurrent edit change returns 409; wait for completion or reload before retrying. Poll the returned editId. Missing selected media or missing scripts in script-caption mode returns 400.

Security

ShuffllApiKey

Path

projectIdstring, (uuid)required

Unique identifier for the project

Example:dad4bce8-f5cb-4078-a211-995864315e39

Bodyapplication/json

toEnhanceboolean

Enhance the latest saved edit, then export. False exports existing media and captions.

Default:true

toUseScriptForSubtitlesboolean

Use each selected scene’s saved script as caption text and align it to speech timestamps. Requires toEnhance:true; no script needs to be sent. Regenerates captions for this export snapshot only. Disabled subtitle scenes/layers remain disabled; unmatched words receive estimated timing.

Default:false

curl -i -X POST \
  https://api-docs.shuffll.com/_mock/apis/auth/project/dad4bce8-f5cb-4078-a211-995864315e39/export \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "toEnhance": true,
    "toUseScriptForSubtitles": false
  }'

Responses

Export request accepted

Bodyapplication/json

projectIdstringrequired

editIdstringrequired

Response

{
  "projectId": "string",
  "editId": "string"
}