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.

Ein Projekt ist die Work-in-Progress-Ressource für einen Karaoke-Track. Es enthält die Quellmedien, synchronisierte Lyrics, separierte Stems, Rendereinstellungen und die daraus erstellten Exporte.

​
project create

Erstelle ein neues Projekt aus einer lokalen Datei oder einer URL. 
youka project create <source> [options]
​
source
string
required
Ein lokaler Dateipfad (./song.mp3) oder eine HTTP/HTTPS-URL (https://example.com/song.mp4).

​
Optionen

OptionBeschreibung
--title <title>Projekttitel
--mode <mode>none, transcribe oder align
--lyrics <text>Liedtext
--lang <code>Sprachcode
--sync-model <model>Lyrics-Synchronisationsmodell
--split-model <model>Stem-Separationsmodell
--max-video-quality <quality>Maximale Videoqualität für URL-Quellen: 720p, 1080p, 4k oder best
--preset <presetId>Beim Erstellen des Projekts ein Preset anwenden
--exportEinen Export erstellen, nachdem das Projekt bereit ist
--downloadEinen Export erstellen, darauf warten und ihn herunterladen
--output <path>Ausgabepfad für --download

​
Beispiele

youka project create ./song.mp3 \
  --title "My Song" \
  --mode transcribe \
  --lang en \
  --wait \
  --json
Regeln:
  • Wenn du Lyrics übergibst und --mode weglässt, setzt die CLI standardmäßig align
  • align erfordert Lyrics
  • transcribe und none akzeptieren keine Lyrics
  • --download impliziert --export
  • --max-video-quality gilt nur für HTTP/HTTPS-URL-Quellen. Standard ist 1080p; es wird die beste verfügbare Qualität bis zu diesem Limit verwendet und auf das beste verfügbare Format zurückgegriffen, wenn die Plattform keinen begrenzten Stream bereitstellt.

​
project list

Liste alle Projekte für das authentifizierte Konto auf. 
youka project list
youka project list --json

​
project quote

Gib die Credits an, die zum Erstellen eines Projekts erforderlich sind, ohne das Projekt zu erstellen. 
youka project quote <source> [options]
source akzeptiert dieselben Formen für lokale Dateipfade oder HTTP/HTTPS-URLs wie project create. Ohne --duration lädt die CLI die Quelle hoch, damit der Server die Mediendauer exakt messen kann, erstellt jedoch kein Projekt.

​
Optionen

OptionBeschreibung
--title <title>Projekttitel
--mode <mode>none, transcribe oder align
--lyrics <text>Liedtext für align
--lang <code>Sprachcode
--sync-model <model>Lyrics-Synchronisationsmodell
--split-model <model>Stem-Separationsmodell
--max-video-quality <quality>Maximale Videoqualität für URL-Quellen: 720p, 1080p, 4k oder best
--duration <seconds>Quote anhand einer bekannten Dauer, ohne die Quelle hochzuladen
Beispiele: 
youka project quote ./song.mp3 --mode transcribe --json
youka project quote https://example.com/song.mp4 --max-video-quality 4k --mode transcribe --json
youka project quote ./song.mp3 --duration 210 --mode none --json

​
project show

Rufe den aktuellen Projektstatus ab, einschließlich normalisiertem state, pendingOperation, Stems, Einstellungen und Exporten. 
youka project show <projectId>
​
projectId
string
required
Die von project create zurückgegebene Projekt-ID.

​
project wait

Frage ein Projekt ab, bis es einen Endzustand erreicht. 
youka project wait <projectId> --json

​
project delete

Lösche ein Projekt und alle dazugehörigen Stems, Lyrics und Exporte. 
youka project delete <projectId> --idempotency-key delete-<projectId>
Das Löschen ist dauerhaft. Übergib --idempotency-key, um Wiederholungen sicher zu machen.

​
project sync

Führe die Transkription oder Ausrichtung der Lyrics für ein bestehendes Projekt erneut aus. 
youka project sync <projectId> [options]
OptionBeschreibung
--mode <mode>transcribe oder align
--text <text>Liedtext
--lang <code>Sprachcode
--sync-model <model>Lyrics-Synchronisationsmodell
Beispiel: 
youka project sync $PROJECT_ID \
  --mode align \
  --text "$(cat lyrics.txt)" \
  --wait \
  --json

​
project separate

Führe die Stem-Separation für ein bestehendes Projekt erneut aus. 
youka project separate <projectId> [--split-model <model>]
Beispiel: 
youka project separate $PROJECT_ID --split-model audioshakeai --wait --json

​
project settings

Lies oder aktualisiere die aktiven Projekteinstellungen. 
youka project settings <projectId>
youka project settings <projectId> --preset <presetId> --body ./settings.json
Wenn weder --preset noch --body vorhanden ist, gibt der Befehl die aktuellen Einstellungen zurück. Wenn eines von beiden vorhanden ist, führt er ein Update durch. Beispiele: 
youka project settings $PROJECT_ID --json

​
project stem list

Liste die Stems für ein Projekt auf. 
youka project stem list <projectId>
youka project stem list <projectId> --json

​
project stem download

Lade eine oder mehrere Stem-Dateien auf die Festplatte herunter. Stems werden in ihrem ursprünglich gespeicherten Format heruntergeladen; die CLI transkodiert sie nicht. 
youka project stem download <projectId> <stemId> --output ./stems
youka project stem download <projectId> --type instrumental --output ./stems
youka project stem download <projectId> --type original --type backing-vocals --type vocals --output ./stems
youka project stem download <projectId> --all --output ./stems
Unterstützte --type-Werte sind original, instrumental, vocals und backing_vocals. Die CLI akzeptiert außerdem backing-vocals, backingVocals und backingvocals als Aliasse.

​
Was als Nächstes