Skip to main content
POST
/
projects
/
{projectId}
/
exports
/
local
Prepare a local export payload
curl --request POST \
  --url https://api.youka.io/api/v1/projects/{projectId}/exports/local \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "resolution": "1080p",
  "quality": "average",
  "fps": 30,
  "transparent": false,
  "stemVolumes": {},
  "playbackRate": 2.05,
  "toneFrequency": 1.005,
  "presetId": "<string>",
  "settingsOverride": {
    "displayLanguages": [
      "<string>"
    ]
  }
}
'
{
  "serveUrl": "<string>",
  "compositionId": "<string>",
  "compositionProps": {},
  "durationInSeconds": 123,
  "fps": 123,
  "transparent": true,
  "watermarked": true,
  "title": "<string>",
  "artists": [
    "<string>"
  ],
  "filename": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.youka.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Idempotency-Key
string

Path Parameters

​
projectId
string
required

Body

application/json
​
resolution
enum<string>
default:1080p
required
Available options:
540p,
720p,
1080p
​
quality
enum<string>
default:average
required
Available options:
low,
average,
high
​
fps
default:30
required
​
transparent
boolean
default:false
required
​
stemVolumes
object
​
playbackRate
number
Required range: 0.1 <= x <= 4
​
toneFrequency
number
Required range: 0.01 <= x <= 2
​
presetId
string
​
settingsOverride
object

Response

200 - application/json

Resolved local export payload

​
serveUrl
string<uri>
required
​
compositionId
string
required
Minimum string length: 1
​
compositionProps
object
required
​
durationInSeconds
number
required
​
aspectRatio
enum<string>
required
Available options:
16:9,
9:16,
4:3,
1:1
​
resolution
enum<string>
required
Available options:
540p,
720p,
1080p
​
quality
enum<string>
required
Available options:
low,
average,
high
​
fps
required
​
transparent
boolean
required
​
watermarked
boolean
required
​
title
string
required
​
artists
string[]
required
​
filename
string
required
Minimum string length: 1