Projects

Projects sont la ressource de plus haut niveau dans Youka. Chaque projet possède son fichier source, ses paroles, ses exports et ses paramètres de projet. Les projets de karaoké contiennent aussi des stems séparés.

Création d’un projet

Dans la plupart des cas, utilisez client.projects.create() — il gère les téléversements pour vous.

const operation = await client.projects.create({
  source: { type: "path", path: "./song.mp3" },
  lyricsSource: { type: "transcribe" },
});
// => ProjectOperation

Types de source

path
bytes
url

Lit un fichier depuis le disque.

source: {
  type: "path",
  path: "./song.mp3",
  contentType: "audio/mpeg", // optional, inferred if omitted
}

Blob, File, ArrayBuffer ou Uint8Array en mémoire.

source: {
  type: "bytes",
  data: fileBuffer,
  filename: "song.mp3",
  contentType: "audio/mpeg", // optional
}

URL HTTP ou HTTPS distante.Les pages hébergées prises en charge dépendent de yt-dlp. Consultez la liste des URL prises en charge.

source: {
  type: "url",
  url: "https://example.com/song.mp4",
  maxVideoQuality: "1080p", // optional: "720p", "1080p", "4k", or "best"
}

maxVideoQuality contrôle la qualité vidéo maximale téléchargée pour les sources URL. La valeur par défaut est 1080p. Le SDK utilise la meilleure qualité disponible jusqu’à cette limite, et se rabat sur le meilleur format disponible si la plateforme n’expose pas de flux plafonné. Utilisez best pour ne pas plafonner.

Sur Node.js et Bun, le SDK s’assure automatiquement de la présence des binaires de dépendances URL requis (ffmpeg, ffprobe, yt-dlp) lors de la première utilisation. L’équivalent en CLI est youka deps ensure --for url.

Autres champs

string

Titre du projet. Par défaut, le nom de fichier de la source.

karaoke | lyric-video

Flux de travail. Par défaut, karaoke. lyric-video utilise l’audio original sans séparation des stems.

SplitModel

Modèle de séparation des stems pour le karaoké. Par défaut, mdx23c. Refusé pour lyric-video. Voir la référence des modèles de séparation .

string

Appliquer un preset réutilisable au moment de la création.

LyricsSource

Configurer la synchronisation des paroles. Voir ci-dessous.

Sources de paroles

// Transcribe lyrics from the audio
lyricsSource: {
  type: "transcribe",
  syncModel: "audioshake-transcription", // optional
  language: "en",                        // optional
}

// Align exact lyrics to the audio
lyricsSource: {
  type: "align",
  lyrics: "First line\nSecond line\n...",
  syncModel: "audioshake-alignment",
}

`client.projects.create(input, options?)`

client.projects.create() accepte aussi une source inputFile de bas niveau lorsque vous avez déjà un inputFileId téléversé.

const upload = await client.uploads.create({
  filename: "song.mp3",
  contentType: "audio/mpeg",
  contentLength: buffer.byteLength,
});

await client.uploads.upload(upload.uploadUrl, buffer, {
  contentType: "audio/mpeg",
});

const operation = await client.projects.create({
  source: {
    type: "inputFile",
    inputFileId: upload.inputFileId,
    filename: "song.mp3",
  },
  title: "My Song",
});

`client.projects.quote(input, options?)`

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

const quote = await client.projects.quote({
  source: { type: "path", path: "./song.mp3" },
  lyricsSource: { type: "transcribe", language: "en" },
  splitModel: "mdx23c",
});

console.log(quote.creditsRequired, quote.sufficientBalance);

client.projects.quote(...) accepte les mêmes formes de source que client.projects.create(...), y compris l’URL maxVideoQuality. Si vous connaissez déjà la durée du média et ne voulez pas téléverser le fichier juste pour obtenir un devis, passez la forme REST de bas niveau :

const quote = await client.projects.quote({
  durationSeconds: 210,
  lyricsSource: null,
  splitModel: "mdx23c",
});

`client.uploads.create(body, options?)`

Allouez un emplacement de téléversement et obtenez une URL signée.

const upload = await client.uploads.create({
  filename: "song.mp3",
  contentType: "audio/mpeg",
  contentLength: 4_521_344,
});
// => { inputFileId, uploadUrl }

`client.uploads.upload(uploadUrl, body, options?)`

Effectuez un PUT des octets du fichier vers l’URL signée.

await client.uploads.upload(upload.uploadUrl, fileBuffer, {
  contentType: "audio/mpeg",
  signal: abortController.signal,
});

FetchBody

required

Tout corps compatible fetch : Blob, File, ArrayBuffer, Uint8Array, ReadableStream ou string.

Lève YoukaRequestError avec le code UPLOAD_FAILED si le téléversement renvoie un statut non-2xx.

`client.projects.get(projectId, options?)`

Récupérez l’état complet du projet, y compris les stems, les paroles et les exports.

const project = await client.projects.get("prj_abc123");
console.log(project.title, project.stems, project.lyrics);

`client.projects.update(projectId, body, options?)`

Patchez les métadonnées du projet.

const project = await client.projects.update("prj_abc123", {
  title: "Updated title",
  artists: ["Artist name"],
});

Passez au moins l’un de title ou artists.

`client.projects.list(options?)`

Listez tous les projets appartenant au compte authentifié.

const projects = await client.projects.list();
projects.forEach((p) => console.log(p.id, p.title));

Renvoie un tableau d’éléments de liste de projets (une forme plus légère que getProject).

`client.projects.delete(projectId, options?)`

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

await client.projects.delete("prj_abc123", {
  idempotencyKey: "delete-prj_abc123",
});

La suppression est définitive. Associez-la à une clé d’idempotence afin que les nouvelles tentatives soient sûres.

Et ensuite

Stems — relancer la séparation des stems
Lyrics sync — re-synchroniser les paroles
Exports — générer les vidéos finalisées
Tasks — attendre les opérations de projet avec client.projects.wait

Création de lyric-video et découverte des modèles

const capabilities = await client.capabilities.get();
const operation = await client.projects.create({
  kind: "lyric-video",
  source: { type: "path", path: "./song.wav" },
  lyricsSource: {
    type: "transcribe",
    syncModel: "elevenlabs-transcription",
    lyrics: "Optional reference lyrics",
  },
});
const { project } = await client.projects.wait(operation);
const versions = await client.projects.versions.list(project.id);

Les mêmes choix kind et de traitement des paroles fonctionnent avec projects.quote. Les devis de lyric-video facturent zéro crédit de séparation. Devis et création valident les mêmes exigences de modèle, de langue, de compte et de source. Les devis ne réservent ni crédits ni capacité. Utilisez lyricsSource: null pour ignorer le traitement des paroles. Le texte de référence en transcription sert d’indication et peut différer du résultat. Les modèles qui nécessitent des voix isolées ne peuvent pas traiter une lyric video sans séparation. Voir Automate lyric videos pour les capacités, les mises à jour de timing exactes et les checkpoints du catalogue.

Overview

How To

Customization

Audio

Settings

Exporting

Account

Création d’un projet

Types de source

Autres champs

Sources de paroles

`client.projects.create(input, options?)`

`client.projects.quote(input, options?)`

`client.uploads.create(body, options?)`

`client.uploads.upload(uploadUrl, body, options?)`

`client.projects.get(projectId, options?)`

`client.projects.update(projectId, body, options?)`

`client.projects.list(options?)`

`client.projects.delete(projectId, options?)`

Et ensuite

Création de lyric-video et découverte des modèles

​Création d’un projet

​Types de source

​Autres champs

​Sources de paroles

​client.projects.create(input, options?)

​client.projects.quote(input, options?)

​client.uploads.create(body, options?)

​client.uploads.upload(uploadUrl, body, options?)

​client.projects.get(projectId, options?)

​client.projects.update(projectId, body, options?)

​client.projects.list(options?)

​client.projects.delete(projectId, options?)

​Et ensuite

​Création de lyric-video et découverte des modèles

Création d’un projet

Types de source

Autres champs

Sources de paroles

`client.projects.create(input, options?)`

`client.projects.quote(input, options?)`

`client.uploads.create(body, options?)`

`client.uploads.upload(uploadUrl, body, options?)`

`client.projects.get(projectId, options?)`

`client.projects.update(projectId, body, options?)`

`client.projects.list(options?)`

`client.projects.delete(projectId, options?)`

Et ensuite

Création de lyric-video et découverte des modèles