Projets

Un projet contient le média source, les paroles, les paramètres de rendu et les exports pour un karaoké ou une lyric video. Les projets de karaoké contiennent également des stems séparés.

`project create`

Créer un nouveau projet à partir d’un fichier local ou d’une URL.

youka project create <source> [options]

string

required

Un chemin de fichier local (./song.mp3) ou une URL HTTP/HTTPS (https://example.com/song.mp4).

Options

Option	Description
`--kind <kind>`	`karaoke` ou `lyric-video`. Par défaut : `karaoke`.
`--title <title>`	Titre du projet
`--mode <mode>`	`none`, `transcribe` ou `align`
`--lyrics <text>`	Texte des paroles
`--lang <code>`	Code de langue
`--sync-model <model>`	Modèle de synchronisation des paroles
`--split-model <model>`	Modèle de séparation des stems
`--max-video-quality <quality>`	Qualité vidéo maximale pour les sources via URL : `720p`, `1080p`, `4k` ou `best`
`--preset <presetId>`	Appliquer un preset lors de la création du projet
`--export`	Créer un export une fois le projet prêt
`--download`	Créer un export, attendre qu’il soit prêt et le télécharger
`--output <path>`	Chemin de sortie pour `--download`

Exemples

youka project create ./song.mp3 \
  --title "My Song" \
  --mode transcribe \
  --lang en \
  --wait \
  --json

youka project create "https://example.com/song.mp4" \
  --max-video-quality 4k \
  --download \
  --output ./karaoke.mp4 \
  --json

youka project create ./song.mp3 \
  --mode align \
  --lyrics "$(cat lyrics.txt)" \
  --sync-model audioshake-alignment \
  --wait \
  --json

Règles :

Si vous fournissez des paroles et omettez --mode, la CLI utilise par défaut align
align nécessite des paroles
transcribe accepte des paroles de référence optionnelles. Le modèle peut renvoyer un texte différent.
none n’accepte pas de paroles
--kind lyric-video utilise l’audio d’origine sans séparation des stems et refuse --split-model. Omettre --kind conserve le comportement karaoké.
--download implique --export
--max-video-quality s’applique uniquement aux sources via URL HTTP/HTTPS. Par défaut : 1080p, utilise la meilleure qualité disponible jusqu’à cette limite, et bascule sur le meilleur format disponible lorsque la plateforme n’expose pas de flux plafonné.

`project list`

Lister tous les projets du compte authentifié.

youka project list
youka project list --json

`project quote`

Estimer les crédits nécessaires pour créer un projet, sans créer le projet.

youka project quote <source> [options]

source accepte les mêmes formes de chemin de fichier local ou d’URL HTTP/HTTPS que project create. Sans --duration, la CLI téléverse la source afin que le serveur puisse mesurer précisément le média, mais elle ne crée pas de projet.

Options

Option	Description
`--kind <kind>`	`karaoke` ou `lyric-video`. Par défaut : `karaoke`.
`--title <title>`	Titre du projet
`--mode <mode>`	`none`, `transcribe` ou `align`
`--lyrics <text>`	Texte requis pour `align`, indication optionnelle pour `transcribe`
`--lang <code>`	Code de langue
`--sync-model <model>`	Modèle de synchronisation des paroles
`--split-model <model>`	Modèle de séparation des stems
`--max-video-quality <quality>`	Qualité vidéo maximale pour les sources via URL : `720p`, `1080p`, `4k` ou `best`
`--duration <seconds>`	Estimer à partir d’une durée connue sans téléverser la source

Exemples :

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`

Obtenir l’état actuel du projet, y compris state normalisé, pendingOperation, les stems, les paramètres et les exports.

youka project show <projectId>

string

required

L’ID de projet renvoyé par project create.

`project wait`

Interroger un projet jusqu’à ce qu’il atteigne un état terminal.

youka project wait <projectId> --json

`project delete`

Supprimer un projet et tous ses stems, paroles et exports associés.

youka project delete <projectId> --idempotency-key delete-<projectId>

La suppression est définitive. Passez --idempotency-key pour rendre les relances sûres.

`project sync`

Relancer la transcription ou l’alignement des paroles sur un projet existant.

youka project sync <projectId> [options]

Option	Description
`--mode <mode>`	`transcribe` ou `align`
`--text <text>`	Texte des paroles
`--lang <code>`	Code de langue
`--sync-model <model>`	Modèle de synchronisation des paroles

Exemple :

youka project sync $PROJECT_ID \
  --mode align \
  --text "$(cat lyrics.txt)" \
  --wait \
  --json

`project separate`

Relancer la séparation des stems sur un projet existant.

youka project separate <projectId> [--split-model <model>]

Exemple :

youka project separate $PROJECT_ID --split-model audioshakeai --wait --json

`project settings`

Lire ou mettre à jour les paramètres de projet actifs.

youka project settings <projectId>
youka project settings <projectId> --preset <presetId> --body ./settings.json

Si ni --preset ni --body n’est présent, la commande renvoie les paramètres actuels. Si l’un des deux est présent, elle effectue une mise à jour. Exemples :

youka project settings $PROJECT_ID --json

youka project settings $PROJECT_ID \
  --preset preset_abc123 \
  --body ./project-settings.json \
  --json

`project stem list`

Lister les stems d’un projet.

youka project stem list <projectId>
youka project stem list <projectId> --json

`project stem download`

Télécharger un ou plusieurs fichiers de stems sur le disque. Les stems sont téléchargés dans leur format d’origine tel qu’il est stocké ; la CLI ne les transcode pas.

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

Les valeurs --type prises en charge sont original, instrumental, vocals et backing_vocals. La CLI accepte aussi backing-vocals, backingVocals et backingvocals comme alias.

Et ensuite

Exports - générer le karaoké final
Presets - gérer des configurations de rendu réutilisables
Render settings reference - champs de preset et de paramètres partagés

Capacités, versions et timings

youka capabilities --json renvoie les IDs de modèles, les workflows pris en charge, la gestion du texte, la prise en charge des langues et l’éligibilité du compte. Wav2Vec2 est un modèle d’alignement. ElevenLabs Scribe est un modèle de transcription. Les modèles qui nécessitent des voix isolées ont besoin d’un workflow karaoké avec un modèle de séparation qui produit des voix.

youka capabilities --json
youka project create ./song.wav --kind lyric-video --mode transcribe --sync-model elevenlabs-transcription --json
youka project quote ./song.wav --kind lyric-video --mode transcribe --sync-model elevenlabs-transcription --json
youka project versions proj_example --json
youka project settings proj_example --version-id ver_example --json
youka project timings list proj_example --json
youka project timings get proj_example aln_example --json
youka project timings import proj_example aln_example --body corrected-request.json --json
youka project timings select proj_example aln_example --expected-revision "$ALIGNMENT_REVISION" --expected-selection-revision "$SELECTION_REVISION" --json

project settings --version-id lit ou met à jour la version choisie. Omettre le flag utilise la version principale. Les imports de timings remplacent l’alignement complet sans tâche de traitement ni blocage de crédits. Le corps JSON contient alignment et expectedRevision. La sauvegarde-et-sélection atomique nécessite aussi select: true et expectedSelectionRevision. Un jeton périmé renvoie HTTP 409. Récupérez et comparez les valeurs actuelles avant de tenter une autre modification. Voir Automate lyric videos pour les fichiers de requête, la validation des timings et le traitement du catalogue reprenable.

Overview

How To

Customization

Audio

Settings

Exporting

Account

`project create`

Options

Exemples

`project list`

`project quote`

Options

`project show`

`project wait`

`project delete`

`project sync`

`project separate`

`project settings`

`project stem list`

`project stem download`

Et ensuite

Capacités, versions et timings

​project create

​Options

​Exemples

​project list

​project quote

​Options

​project show

​project wait

​project delete

​project sync

​project separate

​project settings

​project stem list

​project stem download

​Et ensuite

​Capacités, versions et timings

`project create`

Options

Exemples

`project list`

`project quote`

Options

`project show`

`project wait`

`project delete`

`project sync`

`project separate`

`project settings`

`project stem list`

`project stem download`

Et ensuite

Capacités, versions et timings