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.

Medien sind wiederverwendbare Dateien — Video-Hintergründe, statische Bilder, Logos und Intro-/Outro-Clips — die du einmal hochlädst und dann aus Presets oder Projekteinstellungen referenzierst. Dadurch musst du dieselbe Datei nicht jedes Mal erneut hochladen, wenn du einen neuen Track renderst.

​
Medientypen

TypBeschreibung
videoLoopendes Hintergrundvideo.
imageStatisches Hintergrundbild.
logoLogo-Overlay.
intro-videoWird abgespielt, bevor das Karaoke startet.
outro-videoWird abgespielt, nachdem das Karaoke endet.

​
Endpoints

MethodPathZweck
GET/mediaListet Medien für das authentifizierte Konto auf.
POST/mediaRegistriert eine zuvor hochgeladene Datei als wiederverwendbares Medium.
GET/media/{mediaId}Ruft ein einzelnes Medienelement ab.
DELETE/media/{mediaId}Löscht ein Medienelement.
Vollständige Request- und Response-Schemas findest du in der API reference.

​
Upload-Ablauf

Das Erstellen eines Medienelements ist ein zweistufiger Prozess. Lade zuerst die Dateibytes hoch und registriere anschließend die hochgeladene Datei als wiederverwendbares Medium.
1

Create an upload target

curl -X POST https://api.youka.io/de/api/v1/uploads \
  -H "Authorization: Bearer yk_..." \
  -H "Content-Type: application/json" \
  -d '{
    "filename": "background.mp4",
    "contentType": "video/mp4",
    "contentLength": 8421120
  }'
Die Response enthält inputFileId und uploadUrl.
2

PUT the file bytes

curl -X PUT "$UPLOAD_URL" \
  -H "Content-Type: video/mp4" \
  --data-binary "@./background.mp4"
3

Register the media item

curl -X POST https://api.youka.io/de/api/v1/media \
  -H "Authorization: Bearer yk_..." \
  -H "Idempotency-Key: bg-loop-v1" \
  -H "Content-Type: application/json" \
  -d '{
    "inputFileId": "file_abc123",
    "type": "video"
  }'
Die Response enthält die neue mediaId und die Medien-url. Verwende die url in Presets oder Projekteinstellungen.
POST /media akzeptiert keine direkten Datei-Uploads. Es erwartet eine inputFileId aus einem vorherigen POST /uploads + PUT-Aufruf.

​
Medien auflisten

curl https://api.youka.io/de/api/v1/media \
  -H "Authorization: Bearer yk_..."
Gibt ein Array mit jedem wiederverwendbaren Medienelement des authentifizierten Kontos zurück.

​
Einen Hintergrund anwenden

Referenziere hochgeladene Medien aus einem Preset oder direkt aus den Projekteinstellungen: 
curl -X PATCH https://api.youka.io/de/api/v1/projects/prj_abc/settings \
  -H "Authorization: Bearer yk_..." \
  -H "Content-Type: application/json" \
  -d '{
    "settings": {
      "style": {
        "background": {
          "type": "image",
          "url": "https://cdn.youka.io/backgrounds/bg_abc123.jpg",
          "objectFit": "cover"
        }
      }
    }
  }'

​
Medien löschen

curl -X DELETE https://api.youka.io/de/api/v1/media/bg_abc123 \
  -H "Authorization: Bearer yk_..." \
  -H "Idempotency-Key: delete-bg_abc123"
Das Löschen von Medien hat keinen Einfluss auf Projekte oder Exporte, die zuvor damit gerendert wurden. Zukünftige Renderings, die die gelöschten Medien referenzieren, greifen auf den Standardhintergrund zurück.

​
What’s next