Skip to main content

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.

Tasks are the underlying execution units for async work such as project creation, lyric sync, stem separation, and export rendering. Most workflows should stay at the project and export level. Use task only when you need the raw task record for debugging or low-level automation.

​
task

Get the latest state of a task by ID. 
youka task <taskId> --json
​
taskId
string
required
The task ID, for example from a project’s stemTaskId or lyricsSyncTaskId field.

​
Example

# Capture the task id returned by a mutation
TASK_ID=$(youka project sync $PROJECT_ID --mode transcribe --json | jq -r '.data.taskId')

# Inspect the raw task record
youka task $TASK_ID --json

​
Hidden escape hatch

task is intentionally hidden from the top-level youka --help output. It exists for debugging and agent workflows, not for the main happy path.
Prefer project wait, project show, export wait, and export show unless you explicitly need low-level task fields.

​
What’s next

  • Projects - use project wait and project show for the common flow
  • Exports - use export wait and export download for rendered artifacts
  • AI agents - polling and idempotency guidance