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

# Projetos

> Carregue mídia e crie, inspecione, liste e exclua projetos de karaokê

Projetos são o recurso de nível superior no Youka. Cada projeto contém seu arquivo de origem, stems separados, letras sincronizadas, exportações e configurações do projeto.

## Criando um projeto

Na maioria dos casos, use `client.projects.create()` — ele cuida dos uploads para você.

```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">
    Lê um arquivo do disco.

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

  <Tab title="bytes">
    `Blob`, `File`, `ArrayBuffer` ou `Uint8Array` em memória.

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

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

    As páginas hospedadas compatíveis dependem do yt-dlp. Veja a [lista de URLs suportadas](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 a qualidade máxima de vídeo baixada para sources
    do tipo URL. O padrão é `1080p`. O SDK usa a melhor qualidade disponível até
    esse limite e recorre ao melhor formato disponível se a plataforma não
    disponibilizar um stream com limite. Use `best` para não impor limite.

    <Note>
      No Node.js e no Bun, o SDK garante automaticamente os binários de dependência
      necessários para URL (`ffmpeg`, `ffprobe`, `yt-dlp`) no primeiro uso. O
      equivalente na CLI é `youka deps ensure --for url`.
    </Note>
  </Tab>
</Tabs>

### Outros campos

<ParamField path="title" type="string">
  Título do projeto. O padrão é o nome do arquivo de origem.
</ParamField>

<ParamField path="splitModel" type="SplitModel">
  Modelo de separação de stems. O padrão é `mdx23c`. Veja a [referência de modelo de
  split](/pt/desktop/split-model).
</ParamField>

<ParamField path="presetId" type="string">
  Aplique um preset reutilizável no momento da criação.
</ParamField>

<ParamField path="lyricsSource" type="LyricsSource">
  Configure a sincronização de letras. Veja abaixo.
</ParamField>

### Sources 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()` também aceita um source `inputFile` de baixo nível quando você já tem um `inputFileId` enviado.

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

Estime os créditos necessários para criar um projeto sem criá-lo.

```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(...)` aceita as mesmas formas de `source` que
`client.projects.create(...)`, incluindo `maxVideoQuality` para URL. Se você já
souber a duração da mídia e não quiser enviar o arquivo apenas para estimar, passe
o formato REST de baixo nível:

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

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

Alocar um slot de upload e obter uma URL assinada.

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

Faça PUT dos bytes do arquivo para a URL assinada.

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

<ParamField path="body" type="FetchBody" required>
  Qualquer body compatível com `fetch`: `Blob`, `File`, `ArrayBuffer`, `Uint8Array`,
  `ReadableStream` ou `string`.
</ParamField>

Lança `YoukaRequestError` com o código `UPLOAD_FAILED` se o upload retornar um status não-2xx.

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

Buscar o estado completo do projeto, incluindo stems, letras e exportações.

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

Aplique patch nos metadados do projeto.

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

Passe pelo menos um entre `title` ou `artists`.

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

Liste todos os projetos pertencentes à conta autenticada.

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

Retorna um array de itens de lista de projetos (um formato mais enxuto do que `getProject`).

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

Exclua um projeto e todos os stems, letras e exportações associados.

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

<Warning>
  A exclusão é permanente. Use junto uma chave de idempotência para que novas tentativas sejam seguras.
</Warning>

## Próximos passos

* [Stems](/pt/sdk/stems) — executar novamente a separação de stems
* [Lyrics sync](/pt/sdk/lyrics-sync) — sincronizar letras novamente
* [Exports](/pt/sdk/exports) — renderizar vídeos finalizados
* [Tasks](/pt/sdk/tasks) — aguardar operações do projeto com `client.projects.wait`