Skip to main content
Todos os comandos youka aceitam o mesmo conjunto de flags globais. Elas controlam o modo de saída, o tratamento de entrada, o comportamento de espera e a API de destino.

​
Flags

FlagDescrição
--jsonModo máquina: imprime exatamente um envelope JSON no stdout. Logs e progresso são suprimidos.
--body <file|->Mescla um objeto JSON de um arquivo ou do stdin. As flags do CLI sobrescrevem campos correspondentes vindos de --body.
--waitConsulta (poll) o recurso criado até ele alcançar um estado terminal. Comum em project create, project sync, project separate e export create.
--idempotency-key <key>Encaminha uma chave de idempotência para a API em operações de escrita.
--quietSuprime a saída de progresso não-JSON quando combinado com --wait.
--no-colorDesativa a saída de cores ANSI.
--api <url>Substitui a URL base da API. O sufixo /pt/api/v1 é anexado automaticamente quando necessário.

​
Envelope JSON

Com --json, o CLI grava exatamente um envelope no stdout e nada mais. Sucesso: 
{
  "ok": true,
  "data": {
    /* command result */
  }
}
Falha: 
{
  "ok": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Missing or invalid API key.",
    "details": null
  }
}
Códigos de saída:
CodeSignificado
0Sucesso.
1Erro de execução (rede, API, renderização).
2Entrada inválida (flags incorretas, payload ilegível).
Envie o envelope por pipe para o jq em scripts: youka project show $ID --json | jq '.data.state'.

​
Passando bodies JSON

Qualquer comando de criação ou atualização aceita --body para o corpo completo da requisição. Use isso em vez de escapar JSON grande na linha de comando. 
youka preset create --body ./preset.json --json

​
Aguardando jobs assíncronos

--wait faz polling do recurso criado por você e retorna o estado final. Sem --wait, os comandos retornam assim que o job é enfileirado. 
youka project create ./song.mp3 --wait --json
youka export create $ID --wait --download --output ./out.mp4
Em scripts, combine --wait com --quiet para suprimir a barra de progresso enquanto ainda imprime o resultado JSON.

​
Idempotência

Passe --idempotency-key para tornar comandos de escrita seguros para repetir. Reutilizar a mesma chave com o mesmo payload retorna o resultado original em vez de criar um duplicado. 
youka project create ./song.mp3 \
  --idempotency-key "import-2026-04-08-song-001" \
  --json
Use chaves de idempotência sempre que um agente puder tentar novamente após um timeout.

​
Variáveis de ambiente

VariávelFinalidade
YOUKA_API_KEYChave de API usada quando não é definida via youka login.
YOUKA_API_BASE_URLURL base alternativa da API. Substituída por --api.

​
Próximos passos

  • Conta - salve sua chave de API
  • Projetos - seu primeiro workflow com scripts
  • Agentes de IA - regras de operação para autores de agentes