Skip to main content
Every project has active settings — trim, background, subtitle style, layout — that control how exports are rendered. Use project settings when you want project-local overrides that aren’t worth sharing as a preset. See Render settings reference for the shared preset, settings.style, and settingsOverride field map.

Endpoints

MethodPathPurpose
GET/projects/{projectId}/settingsFetch the active project settings.
PATCH/projects/{projectId}/settingsApply a preset, patch settings, or both.
Full request and response schemas are in API reference.

Fetch the current settings

curl https://api.youka.io/api/v1/projects/prj_abc/settings \
  -H "Authorization: Bearer yk_..."
Returns the full active project settings, including any preset that is applied.

Patch the settings

PATCH accepts any subset of presetId and settings. When both are passed, the preset is applied first and then settings is merged on top.
curl -X PATCH https://api.youka.io/api/v1/projects/prj_abc/settings \
  -H "Authorization: Bearer yk_..." \
  -H "Content-Type: application/json" \
  -d '{
    "presetId": "preset_abc123"
  }'

Discover valid fields

The SDK exports the schema that validates project settings updates. Convert it to JSON Schema at runtime:
import { RestUpdateProjectSettingsRequestSchema } from "@youka/sdk";

const schema = RestUpdateProjectSettingsRequestSchema.toJSONSchema();
Agents should fetch the SDK schema or the OpenAPI request schema before mutating project settings so they always know the current shape.
Human-readable reference:

Project settings vs presets vs export overrides

Youka has three layers where render settings can live:
LayerScopeWhen to use
PresetAccount-wideThe same look across many projects.
Project settingsOne projectProject-specific trim, background, or color.
Export settingsOverrideOne export onlyTweak a single render without touching the project.
Each layer is merged in that order at export time.

What’s next