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.

Un projet est la ressource de travail en cours pour une piste de karaoké. Il contient le média source, les paroles synchronisées, les stems séparés, les paramètres de rendu et les exports créés à partir de celui-ci.

​
project create

Créer un nouveau projet à partir d’un fichier local ou d’une URL. 
youka project create <source> [options]
​
source
string
required
Un chemin de fichier local (./song.mp3) ou une URL HTTP/HTTPS (https://example.com/song.mp4).

​
Options

OptionDescription
--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 URL : 720p, 1080p, 4k, ou best
--preset <presetId>Appliquer un preset lors de la création du projet
--exportCréer un export une fois le projet prêt
--downloadCré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
Règles :
  • Si vous fournissez des paroles et omettez --mode, la CLI utilise align par défaut
  • align nécessite des paroles
  • transcribe et none n’acceptent pas de paroles
  • --download implique --export
  • --max-video-quality s’applique uniquement aux sources URL HTTP/HTTPS. La valeur par défaut est 1080p, la CLI utilise la meilleure qualité disponible jusqu’à cette limite et bascule vers 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 le média précisément, mais elle ne crée pas de projet.

​
Options

OptionDescription
--title <title>Titre du projet
--mode <mode>none, transcribe, ou align
--lyrics <text>Texte des paroles pour align
--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 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>
​
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 ainsi que 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 sécuriser les tentatives de réexécution.

​
project sync

Relancer la transcription ou l’alignement des paroles sur un projet existant. 
youka project sync <projectId> [options]
OptionDescription
--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 actifs du projet. 
youka project settings <projectId>
youka project settings <projectId> --preset <presetId> --body ./settings.json
Si ni --preset ni --body ne sont présents, la commande renvoie les paramètres actuels. Si l’un ou l’autre est présent, elle effectue une mise à jour. Exemples : 
youka project settings $PROJECT_ID --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 stem sur 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 également backing-vocals, backingVocals et backingvocals comme alias.

​
What’s next