# Youka Docs

> Product documentation for the Youka web app, desktop app, CLI, API, SDK, and AI agent workflows.

## Docs

- [AI Agents](https://docs.youka.io/en/agents/index.md): Operating rules and workflow patterns for agents calling the Youka CLI or API
- [Account, credits, and billing](https://docs.youka.io/en/api/account-billing.md): Inspect the authenticated account, credit balance, pricing, checkout, and billing portal URLs
- [Get the authenticated account](https://docs.youka.io/en/api/api-reference/account/get-the-authenticated-account.md)
- [Create a billing checkout session](https://docs.youka.io/en/api/api-reference/billing/create-a-billing-checkout-session.md)
- [Get billing catalog](https://docs.youka.io/en/api/api-reference/billing/get-billing-catalog.md)
- [Get billing management URL](https://docs.youka.io/en/api/api-reference/billing/get-billing-management-url.md)
- [Get credit balance](https://docs.youka.io/en/api/api-reference/credits/get-credit-balance.md)
- [Create an export](https://docs.youka.io/en/api/api-reference/exports/create-an-export.md)
- [Get export state and fresh download URL](https://docs.youka.io/en/api/api-reference/exports/get-export-state-and-fresh-download-url.md)
- [List project exports](https://docs.youka.io/en/api/api-reference/exports/list-project-exports.md)
- [Prepare a local export payload](https://docs.youka.io/en/api/api-reference/exports/prepare-a-local-export-payload.md)
- [Quote an export](https://docs.youka.io/en/api/api-reference/exports/quote-an-export.md)
- [Create media](https://docs.youka.io/en/api/api-reference/media/create-media.md)
- [Delete a media item](https://docs.youka.io/en/api/api-reference/media/delete-a-media-item.md)
- [Get a media item](https://docs.youka.io/en/api/api-reference/media/get-a-media-item.md)
- [List media](https://docs.youka.io/en/api/api-reference/media/list-media.md)
- [Create a preset](https://docs.youka.io/en/api/api-reference/presets/create-a-preset.md)
- [Delete a preset](https://docs.youka.io/en/api/api-reference/presets/delete-a-preset.md)
- [Get a preset](https://docs.youka.io/en/api/api-reference/presets/get-a-preset.md)
- [List presets](https://docs.youka.io/en/api/api-reference/presets/list-presets.md)
- [Update a preset](https://docs.youka.io/en/api/api-reference/presets/update-a-preset.md)
- [Get a project's active settings](https://docs.youka.io/en/api/api-reference/project-settings/get-a-projects-active-settings.md)
- [Update a project's active settings](https://docs.youka.io/en/api/api-reference/project-settings/update-a-projects-active-settings.md)
- [Create a project](https://docs.youka.io/en/api/api-reference/projects/create-a-project.md)
- [Delete a project](https://docs.youka.io/en/api/api-reference/projects/delete-a-project.md)
- [Get current project state](https://docs.youka.io/en/api/api-reference/projects/get-current-project-state.md)
- [List projects](https://docs.youka.io/en/api/api-reference/projects/list-projects.md)
- [Quote project creation](https://docs.youka.io/en/api/api-reference/projects/quote-project-creation.md)
- [Update project metadata](https://docs.youka.io/en/api/api-reference/projects/update-project-metadata.md)
- [Get task status](https://docs.youka.io/en/api/api-reference/tasks/get-task-status.md)
- [List project tasks](https://docs.youka.io/en/api/api-reference/tasks/list-project-tasks.md)
- [Run lyrics sync for a project](https://docs.youka.io/en/api/api-reference/tasks/run-lyrics-sync-for-a-project.md)
- [Run stem separation for a project](https://docs.youka.io/en/api/api-reference/tasks/run-stem-separation-for-a-project.md)
- [Create an upload target](https://docs.youka.io/en/api/api-reference/uploads/create-an-upload-target.md)
- [Async jobs and polling](https://docs.youka.io/en/api/async-jobs.md): Understand task-based writes, terminal task states, and which resources hold durable state.
- [Authentication](https://docs.youka.io/en/api/authentication.md): Authenticate with a Bearer API key and scope retries with stable idempotency keys.
- [Errors and retry behavior](https://docs.youka.io/en/api/errors.md): Error payload shape, safe retry guidance, and how to pair retries with idempotency keys.
- [Exports](https://docs.youka.io/en/api/exports.md): Quote, create, prepare, list, inspect, and download rendered karaoke exports
- [Idempotency](https://docs.youka.io/en/api/idempotency.md): Use stable Idempotency-Key headers on write requests so retries stay safe and deduplicated.
- [API Overview](https://docs.youka.io/en/api/index.md): Project-based API for uploads, async jobs, presets, media, project settings, and exports.
- [Lyrics sync](https://docs.youka.io/en/api/lyrics-sync.md): Re-run lyrics synchronization on an existing project
- [Media](https://docs.youka.io/en/api/media.md): Reusable backgrounds, logos, and intro/outro videos
- [Presets](https://docs.youka.io/en/api/presets.md): Reusable render configurations — create, update, list, and set the account default
- [Project settings](https://docs.youka.io/en/api/project-settings.md): Read and patch a project's active settings
- [Projects](https://docs.youka.io/en/api/projects.md): Upload source media and create, quote, inspect, update, list, and delete karaoke projects
- [Raw HTTP Quickstart](https://docs.youka.io/en/api/quickstart.md): Use cURL to upload a file, create a project, poll the task, and export the finished karaoke output.
- [Stems](https://docs.youka.io/en/api/stems.md): Re-run stem separation on an existing project
- [Tasks](https://docs.youka.io/en/api/tasks.md): Poll async project, lyrics, stem, and export work
- [Account](https://docs.youka.io/en/cli/account.md): Log in, log out, and inspect the active CLI account context
- [Billing](https://docs.youka.io/en/cli/billing.md): Inspect pricing and create checkout or billing portal URLs
- [Credits](https://docs.youka.io/en/cli/credits.md): Inspect credit balance and expiring credit packages
- [Dependencies](https://docs.youka.io/en/cli/deps.md): Inspect, install, and refresh local helper binaries for URL imports and local renders
- [Exports](https://docs.youka.io/en/cli/exports.md): Render and download karaoke exports in the cloud or on the local machine
- [Global options](https://docs.youka.io/en/cli/global-options.md): Flags available on every Youka CLI command
- [Youka CLI](https://docs.youka.io/en/cli/index.md): Create karaoke, customize the style, and export MP4 videos from the command line
- [Media](https://docs.youka.io/en/cli/media.md): Upload and manage reusable images, videos, logos, and intro/outro clips
- [Presets](https://docs.youka.io/en/cli/presets.md): Manage reusable render configurations
- [Projects](https://docs.youka.io/en/cli/projects.md): Create, inspect, wait on, and mutate work-in-progress karaoke projects
- [Tasks](https://docs.youka.io/en/cli/tasks.md): Inspect low-level task execution state
- [Add a Background Box to Subtitles](https://docs.youka.io/en/desktop/add-background-box.md): Make subtitles easier to read on busy backgrounds
- [Add a Line Break](https://docs.youka.io/en/desktop/add-line-break.md): Split a long line of lyrics into two lines
- [Adjust Line Length](https://docs.youka.io/en/desktop/adjust-line-length.md): Fix lyrics lines that run off the side of the screen
- [Cancel Your Subscription](https://docs.youka.io/en/desktop/cancel-subscription.md): Cancel your Youka subscription from the desktop app
- [Center Subtitles](https://docs.youka.io/en/desktop/center-subtitles.md): Position lyrics in the middle of the screen
- [Change the Background Video](https://docs.youka.io/en/desktop/change-background-video.md): Use your own image, video, or color as the karaoke background
- [Change Text to Uppercase](https://docs.youka.io/en/desktop/change-to-uppercase.md): Display all karaoke lyrics in uppercase letters
- [Create Karaoke from a File](https://docs.youka.io/en/desktop/create-from-file.md): Turn any local audio or video file into a karaoke track
- [Delete a Karaoke](https://docs.youka.io/en/desktop/delete-karaoke.md): Remove a karaoke project from your library
- [Edit the Lyrics](https://docs.youka.io/en/desktop/edit-lyrics.md): Update lyrics and re-sync them with your karaoke track
- [Fix Lyrics Sync](https://docs.youka.io/en/desktop/fix-lyrics-sync.md): Solutions for when lyrics are out of sync or incorrect
- [Fix Incorrect Font Display in Exports](https://docs.youka.io/en/desktop/incorrect-font-display.md): Resolve fonts that render wrong in exported karaoke videos
- [Desktop App](https://docs.youka.io/en/desktop/index.md): Create, edit, and export karaoke projects with the Youka desktop app
- [Keep Background Vocals](https://docs.youka.io/en/desktop/keep-background-vocals.md): Preserve backing vocals and choirs alongside the instrumental
- [Keep the Original Vocals](https://docs.youka.io/en/desktop/keep-original-vocals.md): Retain the singer's vocals on specific lines
- [Keyboard Shortcuts](https://docs.youka.io/en/desktop/keyboard-shortcuts.md): Speed up your workflow with keyboard shortcuts
- [Lyrics Are Out of Sync](https://docs.youka.io/en/desktop/lyrics-out-of-sync.md): Fix synchronization issues with your karaoke lyrics
- [Style Each Singer Differently](https://docs.youka.io/en/desktop/multiple-singers-style.md): Give each singer in a duet their own colors and fonts
- [Set Up a Duet](https://docs.youka.io/en/desktop/setup-duet.md): Assign lines to different singers for duet mode
- [Speed Up Downloads](https://docs.youka.io/en/desktop/speed-up-download.md): Optimize settings for faster karaoke video downloads
- [Split Model Reference](https://docs.youka.io/en/desktop/split-model.md): Pick the right audio separation model for your song
- [Sync Model Reference](https://docs.youka.io/en/desktop/sync-model.md): Pick the right lyric synchronization model for your song
- [Transfer Your Library to a New Computer](https://docs.youka.io/en/desktop/transfer-library.md): Move your Youka library and projects to another machine
- [Trim a Karaoke Video](https://docs.youka.io/en/desktop/trim-video.md): Cut the start, end, or middle of a karaoke project
- [Video URL to Karaoke](https://docs.youka.io/en/desktop/youtube-to-karaoke.md): Turn any online video URL into a karaoke track
- [Youka Docs](https://docs.youka.io/en/index.md): Guides and reference for creating karaoke with the Youka web app, desktop app, CLI, API, and SDK
- [Account, credits, and billing](https://docs.youka.io/en/sdk/account-billing.md): Inspect identity, credit balance, pricing, checkout, and billing portal URLs
- [Authentication](https://docs.youka.io/en/sdk/authentication.md): Configure the YoukaClient with your API key
- [Errors](https://docs.youka.io/en/sdk/errors.md): Handle YoukaRequestError, YoukaTaskError, and retryable failures
- [Exports](https://docs.youka.io/en/sdk/exports.md): Render karaoke videos in the cloud or locally
- [Node.js SDK](https://docs.youka.io/en/sdk/index.md): Automate Youka from Node.js and Bun with the official TypeScript SDK
- [Lyrics sync](https://docs.youka.io/en/sdk/lyrics-sync.md): Re-run lyrics synchronization on an existing project
- [Media](https://docs.youka.io/en/sdk/media.md): Upload and manage reusable backgrounds, logos, and intro/outro videos
- [Presets](https://docs.youka.io/en/sdk/presets.md): Manage reusable render configurations from the SDK
- [Project settings](https://docs.youka.io/en/sdk/project-settings.md): Read and update a project's active settings
- [Projects](https://docs.youka.io/en/sdk/projects.md): Upload media and create, inspect, list, and delete karaoke projects
- [Quickstart](https://docs.youka.io/en/sdk/quickstart.md): Create a karaoke project, wait for it to finish, export it, and download the result
- [Stems](https://docs.youka.io/en/sdk/stems.md): Trigger stem separation tasks on an existing project
- [Tasks](https://docs.youka.io/en/sdk/tasks.md): Inspect tasks and wait for async operations to finish
- [Add Intro and Outro](https://docs.youka.io/en/web/add-intro-outro.md): Add custom videos at the start and end of your karaoke
- [Add Lead-In Beats](https://docs.youka.io/en/web/add-lead-in.md): Show a visual countdown before each line starts
- [Add Logo Watermark](https://docs.youka.io/en/web/add-logo.md): Brand your karaoke videos with a logo watermark
- [Add Title Card](https://docs.youka.io/en/web/add-title-card.md): Show song title and artist at the start of your karaoke
- [Adjust Audio Mix](https://docs.youka.io/en/web/audio-mix.md): Control the volume of instrumental and vocal tracks
- [Let AI Detect Lyrics](https://docs.youka.io/en/web/auto-transcribe.md): Use AI to automatically transcribe and sync lyrics from your audio
- [Buy More Credits](https://docs.youka.io/en/web/buy-credits.md): Add credits to your account
- [Change Background](https://docs.youka.io/en/web/change-background.md): Set a color, gradient, image, or video as your karaoke background
- [Change Speed or Pitch](https://docs.youka.io/en/web/change-speed-pitch.md): Adjust the tempo and key of your karaoke
- [Chord Layout](https://docs.youka.io/en/web/chord-track.md): Play any song with synced chords above the lyrics, with notation, transpose, and capo controls
- [Create Your First Karaoke](https://docs.youka.io/en/web/create-karaoke.md): Upload any song and turn it into a karaoke video in minutes
- [Customize Text Style](https://docs.youka.io/en/web/customize-text-style.md): Change fonts, colors, and effects for your karaoke lyrics
- [Set Up Duet Mode](https://docs.youka.io/en/web/duet-editor.md): Assign singers to each line for duet karaoke
- [Edit Lyrics Text](https://docs.youka.io/en/web/edit-lyrics.md): Fix typos or change words in your karaoke lyrics
- [Export and Download](https://docs.youka.io/en/web/export-video.md): Download your karaoke video or audio tracks
- [Web App](https://docs.youka.io/en/web/index.md): Create, edit, and export karaoke in your browser with Youka Studio
- [Join a Karaoke Session](https://docs.youka.io/en/web/join-session.md): Join a friend's karaoke session as a guest
- [Keep Backing Vocals](https://docs.youka.io/en/web/keep-backing-vocals.md): Preserve background singers in your karaoke track
- [Layout Options](https://docs.youka.io/en/web/layout-options.md): Choose how lyrics appear on screen with different layout modes
- [Manage Your Projects](https://docs.youka.io/en/web/manage-projects.md): View, search, and organize your karaoke projects
- [Fine-Tune Lyrics Timing](https://docs.youka.io/en/web/manual-sync.md): Adjust word and line timing with the Manual Sync tool
- [Multilingual Karaoke](https://docs.youka.io/en/web/multilingual-karaoke.md): Display lyrics in multiple languages simultaneously with customizable styling and layout
- [Use Style Presets](https://docs.youka.io/en/web/presets.md): Save and reuse styling across projects
- [Add Your Own Lyrics](https://docs.youka.io/en/web/provide-lyrics.md): Paste your lyrics for more accurate karaoke timing
- [Remote Control](https://docs.youka.io/en/web/remote-control.md): Control karaoke playback from another device
- [Split Long Lines for Single-Line Display](https://docs.youka.io/en/web/split-long-lines.md): Create one-line-at-a-time lyric display by automatically splitting long lines
- [Trim Your Song](https://docs.youka.io/en/web/trim-song.md): Cut the beginning or end of your karaoke
- [Understanding Credits](https://docs.youka.io/en/web/understanding-credits.md): How the credit system works for creating karaoke
- [Use Transparent Background Videos in Video Editors](https://docs.youka.io/en/web/use-transparent-background.md): Layer your karaoke video over custom backgrounds in DaVinci Resolve, Premiere Pro, and Final Cut Pro
- [Your Karaoke Library](https://docs.youka.io/en/web/using-library.md): Store and play your karaoke videos anytime
- [Using the Studio Editor](https://docs.youka.io/en/web/using-studio.md): Customize your karaoke with the Studio's powerful editing tools
- [Save Different Versions](https://docs.youka.io/en/web/versions.md): Create variations of your karaoke project
- [Youka Extension](https://docs.youka.io/en/web/youka-extension.md): Unlock desktop features in your browser: create from video URLs, search lyrics, and export locally

## OpenAPI Specs

- [openapi](https://docs.youka.io/openapi.json)