> ## 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.

# Projects

> Sube archivos multimedia y crea, inspecciona, lista y elimina proyectos de karaoke

Los proyectos son el recurso de nivel superior en Youka. Cada proyecto contiene su archivo de origen, stems separados, letras sincronizadas, exportaciones y la configuración del proyecto.

## Crear un proyecto

En la mayoría de los casos, usa `client.projects.create()` — se encarga de las subidas por ti.

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

### Tipos de source

<Tabs>
  <Tab title="path">
    Lee un archivo desde el disco.

    ```ts theme={null}
    source: {
      type: "path",
      path: "./song.mp3",
      contentType: "audio/mpeg", // optional, inferred if omitted
    }
    ```
  </Tab>

  <Tab title="bytes">
    `Blob`, `File`, `ArrayBuffer` o `Uint8Array` en memoria.

    ```ts theme={null}
    source: {
      type: "bytes",
      data: fileBuffer,
      filename: "song.mp3",
      contentType: "audio/mpeg", // optional
    }
    ```
  </Tab>

  <Tab title="url">
    URL remota HTTP o HTTPS.

    Las páginas alojadas compatibles dependen de yt-dlp. Consulta la [lista de URLs compatibles](https://github.com/yt-dlp/yt-dlp/blob/master/supportedsites.md).

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

    `maxVideoQuality` controla la calidad máxima de video descargada para las
    fuentes de URL. El valor predeterminado es `1080p`. El SDK usa la mejor
    calidad disponible hasta ese límite, y recurre al mejor formato disponible
    si la plataforma no expone un stream con límite. Usa `best` para no aplicar
    límite.

    <Note>
      En Node.js y Bun, el SDK garantiza automáticamente los binarios de
      dependencias necesarios para URL (`ffmpeg`, `ffprobe`, `yt-dlp`) en el
      primer uso. El equivalente en la CLI es `youka deps ensure --for url`.
    </Note>
  </Tab>
</Tabs>

### Otros campos

<ParamField path="title" type="string">
  Título del proyecto. De forma predeterminada, usa el nombre de archivo del origen.
</ParamField>

<ParamField path="splitModel" type="SplitModel">
  Modelo de separación de stems. El valor predeterminado es `mdx23c`. Consulta la [referencia de modelos de split](/es/desktop/split-model).
</ParamField>

<ParamField path="presetId" type="string">
  Aplica un preset reutilizable en el momento de la creación.
</ParamField>

<ParamField path="lyricsSource" type="LyricsSource">
  Configura la sincronización de letras. Ver abajo.
</ParamField>

### Fuentes de letras

```ts theme={null}
// 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()` también acepta un source `inputFile` de bajo nivel cuando ya tienes un `inputFileId` subido.

```ts theme={null}
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?)`

Cotiza los créditos necesarios para crear un proyecto sin crearlo.

```ts theme={null}
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(...)` acepta los mismos formatos de `source` que
`client.projects.create(...)`, incluido `maxVideoQuality` para URL. Si ya
conoces la duración del archivo multimedia y no quieres subir el archivo solo
para cotizar, pasa la forma REST de bajo nivel:

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

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

Reserva un slot de subida y obtén una URL firmada.

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

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

Haz PUT de los bytes del archivo a la URL firmada.

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

<ParamField path="body" type="FetchBody" required>
  Cualquier body compatible con `fetch`: `Blob`, `File`, `ArrayBuffer`, `Uint8Array`,
  `ReadableStream` o `string`.
</ParamField>

Lanza `YoukaRequestError` con el código `UPLOAD_FAILED` si la subida devuelve un estado no 2xx.

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

Obtén el estado completo del proyecto, incluidos stems, letras y exportaciones.

```ts theme={null}
const project = await client.projects.get("prj_abc123");
console.log(project.title, project.stems, project.lyrics);
```

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

Aplica un patch a los metadatos del proyecto.

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

Pasa al menos uno de `title` o `artists`.

## `client.projects.list(options?)`

Lista todos los proyectos propiedad de la cuenta autenticada.

```ts theme={null}
const projects = await client.projects.list();
projects.forEach((p) => console.log(p.id, p.title));
```

Devuelve un array de elementos de lista de proyectos (una forma más ligera que `getProject`).

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

Elimina un proyecto y todos sus stems, letras y exportaciones asociadas.

```ts theme={null}
await client.projects.delete("prj_abc123", {
  idempotencyKey: "delete-prj_abc123",
});
```

<Warning>
  La eliminación es permanente. Úsalo junto con una clave de idempotencia para que los reintentos sean seguros.
</Warning>

## Qué sigue

* [Stems](/es/sdk/stems) — volver a ejecutar la separación de stems
* [Lyrics sync](/es/sdk/lyrics-sync) — volver a sincronizar las letras
* [Exports](/es/sdk/exports) — renderizar videos terminados
* [Tasks](/es/sdk/tasks) — esperar operaciones del proyecto con `client.projects.wait`