Skip to main content
Exports are rendered video artifacts created from a project. Cloud exports run as async jobs and use credits. Local export preparation returns the server-built payload needed by a local renderer and does not queue a cloud render.

​
Endpoints

MethodPathPurpose
GET/projects/{projectId}/exportsList exports for a project.
POST/projects/{projectId}/exportsCreate a cloud export.
POST/projects/{projectId}/exports/quoteQuote credits for a cloud export.
POST/projects/{projectId}/exports/localPrepare a local export render payload.
GET/exports/{exportId}Fetch one export and its signed download URL.
Full request and response schemas are in API reference.

​
Quote a cloud export

curl -X POST https://api.youka.io/api/v1/projects/prj_abc123/exports/quote \
  -H "Authorization: Bearer yk_..." \
  -H "Content-Type: application/json" \
  -d '{
    "resolution": "1080p",
    "quality": "high",
    "transparent": false
  }'
Use this before POST /exports when you need to show the credit cost or check sufficientBalance.

​
Create a cloud export

curl -X POST https://api.youka.io/api/v1/projects/prj_abc123/exports \
  -H "Authorization: Bearer yk_..." \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: export-prj_abc123-1080p" \
  -d '{
    "resolution": "1080p",
    "quality": "high",
    "transparent": false,
    "presetId": "preset_abc123"
  }'
The response includes exportId and taskId. Poll tasks or GET /exports/{exportId} until the export reaches a terminal status.

​
Prepare a local export

curl -X POST https://api.youka.io/api/v1/projects/prj_abc123/exports/local \
  -H "Authorization: Bearer yk_..." \
  -H "Content-Type: application/json" \
  -d '{
    "resolution": "720p",
    "quality": "average",
    "transparent": false
  }'
This returns composition inputs, asset URLs, render options, title metadata, and the suggested output filename. Use it when integrating with a local renderer.

​
List and inspect

curl "https://api.youka.io/api/v1/projects/prj_abc123/exports?page=1&pageSize=50" \
  -H "Authorization: Bearer yk_..."

curl https://api.youka.io/api/v1/exports/exp_abc123 \
  -H "Authorization: Bearer yk_..."
Finished exports include a signed url. Download it before the URL expires.

​
Export request fields

FieldTypeDescription
resolution"540p" | "720p" | "1080p"Output resolution. Defaults to 1080p.
quality"low" | "average" | "high"Encoding quality. Defaults to average.
stemVolumesRecord<string, number>Per-stem volume overrides keyed by stem id.
playbackRatenumberSpeed multiplier from 0.1 to 4.
toneFrequencynumberPitch multiplier from 0.01 to 2.
transparentbooleanRender with a transparent background.
presetIdstringApply a preset before rendering.
settingsOverrideobjectPatch project settings for this export only.

​
What’s next