Projekte

Projekte sind die oberste Ressource in Youka. Jedes Projekt besitzt seine Quelldatei, Lyrics, Exporte und Projekteinstellungen. Karaoke-Projekte enthalten außerdem getrennte Stems.

Erstellen eines Projekts

Für die meisten Anwendungsfälle verwende client.projects.create() — es übernimmt die Uploads für dich.

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

Source-Typen

path
bytes
url

Liest eine Datei von der Festplatte.

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

In-Memory-Blob, File, ArrayBuffer oder Uint8Array.

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

Remote-HTTP- oder HTTPS-URL.Welche gehosteten Seiten unterstützt werden, hängt von yt-dlp ab. Siehe die Liste unterstützter URLs.

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

maxVideoQuality steuert die maximal heruntergeladene Videoqualität für URL-Quellen. Standard ist 1080p. Das SDK verwendet die beste verfügbare Qualität bis zu diesem Limit und fällt auf das beste verfügbare Format zurück, wenn die Plattform keinen gecappten Stream bereitstellt. Verwende best ohne Limit.

Unter Node.js und Bun stellt das SDK bei der ersten Nutzung automatisch die benötigten URL-Abhängigkeits-Binaries (ffmpeg, ffprobe, yt-dlp) sicher. Das CLI-Äquivalent ist youka deps ensure --for url.

Weitere Felder

string

Projekttitel. Standardmäßig der Dateiname der Quelle.

karaoke | lyric-video

Workflow. Standard ist karaoke. lyric-video verwendet das Originalaudio ohne Stem-Separation.

SplitModel

Stem-Separationsmodell für Karaoke. Standard ist mdx23c. Für lyric-video abgewiesen. Siehe Split-Model-Referenz.

string

Wendet beim Erstellen ein wiederverwendbares Preset an.

LyricsSource

Konfiguriert die Lyrics-Synchronisierung. Siehe unten.

Lyrics-Quellen

// 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() akzeptiert außerdem eine Low-Level-inputFile-Quelle, wenn du bereits eine hochgeladene inputFileId hast.

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?)`

Ermittle die Credits, die zum Erstellen eines Projekts erforderlich sind, ohne es zu erstellen.

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(...) akzeptiert dieselben source-Formen wie client.projects.create(...), einschließlich URL-maxVideoQuality. Wenn du die Medienlänge bereits kennst und die Datei nicht nur fürs Quoting hochladen möchtest, übergib die Low-Level-REST-Form:

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

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

Reserviere einen Upload-Slot und erhalte eine signierte URL.

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

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

Übertrage die Datei-Bytes per PUT an die signierte URL.

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

FetchBody

required

Beliebiger fetch-kompatibler Body: Blob, File, ArrayBuffer, Uint8Array, ReadableStream oder string.

Wirft YoukaRequestError mit Code UPLOAD_FAILED, wenn der Upload einen Nicht-2xx-Status zurückgibt.

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

Rufe den vollständigen Projektzustand ab, einschließlich Stems, Lyrics und Exporte.

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

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

Patche Projekt-Metadaten.

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

Übergebe mindestens eines von title oder artists.

`client.projects.list(options?)`

Liste jedes Projekt auf, das dem authentifizierten Account gehört.

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

Gibt ein Array von Projekt-Listeneinträgen zurück (eine schlankere Form als getProject).

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

Lösche ein Projekt und alle zugehörigen Stems, Lyrics und Exporte.

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

Das Löschen ist dauerhaft. Verwende einen Idempotency-Key, damit Retries sicher sind.

Was als Nächstes

Stems — Stem-Separation erneut ausführen
Lyrics sync — Lyrics erneut synchronisieren
Exports — fertige Videos rendern
Tasks — auf Projekt-Operationen warten mit client.projects.wait

Lyric-Video-Erstellung und Model-Discovery

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);

Dieselben kind- und Lyric-Processing-Optionen funktionieren auch mit projects.quote. Lyric-Video-Quotes berechnen null Separation-Credits. Quote und Create validieren dasselbe Modell, dieselbe Sprache, denselben Account und dieselben Source-Anforderungen. Quotes reservieren keine Credits oder Kapazität. Verwende lyricsSource: null, um die Lyric-Verarbeitung zu überspringen. Referenztext bei der Transkription dient als Orientierung und kann vom Ergebnis abweichen. Modelle, die isolierte Vocals benötigen, können ein Lyric-Video ohne Separation nicht verarbeiten. Siehe Automate lyric videos für Capabilities, genaue Timing-Updates und Katalog-Checkpoints.

Overview

How To

Customization

Audio

Settings

Exporting

Account

Erstellen eines Projekts

Source-Typen

Weitere Felder

Lyrics-Quellen

`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?)`

Was als Nächstes

Lyric-Video-Erstellung und Model-Discovery

​Erstellen eines Projekts

​Source-Typen

​Weitere Felder

​Lyrics-Quellen

​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?)

​Was als Nächstes

​Lyric-Video-Erstellung und Model-Discovery

Erstellen eines Projekts

Source-Typen

Weitere Felder

Lyrics-Quellen

`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?)`

Was als Nächstes

Lyric-Video-Erstellung und Model-Discovery