Skip to main content

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.

Eine Voreinstellung ist eine wiederverwendbare Render-Konfiguration — Hintergrund, Untertitelstil, Layout — die du auf jedes Projekt oder jeden Export anwenden kannst. Nutze Voreinstellungen, wenn du über viele Tracks hinweg ein einheitliches Erscheinungsbild haben möchtest. Siehe Render settings reference für die vollständige preset-Form und jede enum-gestützte Option.

​
Wann man eine Voreinstellung verwendet

Verwende eine Voreinstellung, wenn…

Du über viele Projekte hinweg denselben Look möchtest und ihn an einer Stelle aktualisieren musst.

Verwende Projekteinstellungen, wenn…

Du projektspezifische Overrides brauchst, die sich nicht lohnen zu teilen.

​
Endpoints

MethodPathZweck
GET/presetsVoreinstellungen für das authentifizierte Konto auflisten.
POST/presetsEine neue Voreinstellung erstellen.
GET/presets/{presetId}Eine einzelne Voreinstellung abrufen.
PATCH/presets/{presetId}Namen aktualisieren, Body aktualisieren oder als Standard festlegen.
DELETE/presets/{presetId}Eine Voreinstellung löschen.
Vollständige Request- und Response-Schemas findest du unter API reference in der Sidebar.

​
Eine Voreinstellung erstellen

curl -X POST https://api.youka.io/de/api/v1/presets \
  -H "Authorization: Bearer yk_..." \
  -H "Idempotency-Key: create-neon-night-v1" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Neon Night",
    "preset": {
      "background": {
        "type": "gradient",
        "colors": ["#12001f", "#2f0a57"],
        "angle": 90
      },
      "singerTextStyles": {
        "0": {
          "fontFamily": "Inter",
          "textColor": "#00f5ff",
          "effectColor": "#ff4fd8"
        }
      }
    },
    "isDefault": false
  }'
Die Antwort enthält die neue presetId. Speichere sie und referenziere sie in Projekten oder Exports.
Kombiniere jedes POST mit einem Idempotency-Key. Wenn du denselben Key mit demselben Payload erneut verwendest, wird die ursprüngliche Voreinstellung zurückgegeben, statt ein Duplikat zu erstellen.

​
Gültige Preset-Felder ermitteln

Voreinstellungen werden serverseitig gegen das KaraokePresetSchema validiert. Das SDK exportiert dieses Schema, sodass du es zur Laufzeit in JSON Schema umwandeln kannst: 
import { KaraokePresetSchema } from "@youka/sdk";

const jsonSchema = KaraokePresetSchema.toJSONSchema();
Aus der CLI: 
youka preset schema --json
Agent-Autor:innen sollten dies aufrufen, bevor sie Voreinstellungen mutieren, damit das Modell jedes gültige Feld und jeden Werttyp kennt. Gut lesbare Referenz:

​
Eine Voreinstellung aktualisieren

curl -X PATCH https://api.youka.io/de/api/v1/presets/preset_abc123 \
  -H "Authorization: Bearer yk_..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Neon Night v2",
    "preset": {
      "singerTextStyles": {
        "0": {
          "textColor": "#ff2a2a"
        }
      }
    }
  }'
Übergebe eine beliebige Teilmenge von name und preset. Felder, die du nicht angibst, bleiben unverändert.

​
Die Standard-Voreinstellung festlegen

Jedes Konto hat höchstens eine Standard-Voreinstellung, die automatisch auf neue Projekte angewendet wird. 
curl -X PATCH https://api.youka.io/de/api/v1/presets/preset_abc123 \
  -H "Authorization: Bearer yk_..." \
  -H "Content-Type: application/json" \
  -d '{
    "isDefault": true
  }'
Wenn du einen neuen Standard setzt, wird der vorherige automatisch aufgehoben.

​
Eine Voreinstellung anwenden

Referenziere eine Voreinstellung an drei Stellen:
WoFeld
Bei der ProjekterstellungpresetId in POST /projects
Jederzeit in einem ProjektpresetId in PATCH /projects/{projectId}/settings
Beim ExportpresetId in POST /projects/{projectId}/exports
Beispiel beim Export: 
curl -X POST https://api.youka.io/de/api/v1/projects/prj_abc/exports \
  -H "Authorization: Bearer yk_..." \
  -H "Content-Type: application/json" \
  -d '{
    "presetId": "preset_abc123",
    "resolution": "1080p",
    "quality": "high"
  }'

​
Eine Voreinstellung löschen

curl -X DELETE https://api.youka.io/de/api/v1/presets/preset_abc123 \
  -H "Authorization: Bearer yk_..." \
  -H "Idempotency-Key: delete-preset_abc123"
Das Löschen einer Voreinstellung hat keine Auswirkungen auf Projekte oder Exports, die zuvor damit gerendert wurden. Zukünftige Exports, die auf die gelöschte Voreinstellung verweisen, schlagen fehl.

​
Was als Nächstes