Skip to main content
Cada comando de youka acepta el mismo conjunto de flags globales. Controlan el modo de salida, el manejo de entrada, el comportamiento de espera y la API de destino.

​
Flags

FlagDescription
--jsonModo máquina: imprime exactamente un sobre JSON en stdout. Se suprimen los logs y el progreso.
--body <file|->Fusiona un objeto JSON desde un archivo o stdin. Los flags de la CLI anulan los campos coincidentes de --body.
--waitSondea el recurso creado hasta que alcance un estado terminal. Común en project create, project sync, project separate y export create.
--idempotency-key <key>Reenvía una clave de idempotencia a la API en operaciones de escritura.
--quietSuprime la salida de progreso no JSON cuando se combina con --wait.
--no-colorDesactiva la salida de color ANSI.
--api <url>Anula la URL base de la API. El sufijo /es/api/v1 se añade automáticamente cuando es necesario.

​
Sobre JSON

Con --json, la CLI escribe exactamente un sobre en stdout y nada más. Éxito: 
{
  "ok": true,
  "data": {
    /* command result */
  }
}
Fallo: 
{
  "ok": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Missing or invalid API key.",
    "details": null
  }
}
Códigos de salida:
CodeMeaning
0Éxito.
1Error en tiempo de ejecución (red, API, renderizado).
2Entrada no válida (flags incorrectos, payload ilegible).
Canaliza el sobre a través de jq para scripting: youka project show $ID --json | jq '.data.state'.

​
Pasar cuerpos JSON

Cualquier comando de creación o actualización acepta --body para el cuerpo completo de la solicitud. Úsalo en lugar de escapar JSON grande en la línea de comandos. 
youka preset create --body ./preset.json --json

​
Esperar trabajos asíncronos

--wait sondea el recurso creado en tu nombre y devuelve el estado final. Sin --wait, los comandos vuelven en cuanto el trabajo queda encolado. 
youka project create ./song.mp3 --wait --json
youka export create $ID --wait --download --output ./out.mp4
Combina --wait con --quiet en scripts para suprimir la barra de progreso mientras sigues imprimiendo el resultado JSON.

​
Idempotencia

Pasa --idempotency-key para que los comandos de escritura sean seguros de reintentar. Reutilizar la misma clave con el mismo payload devuelve el resultado original en lugar de crear un duplicado. 
youka project create ./song.mp3 \
  --idempotency-key "import-2026-04-08-song-001" \
  --json
Usa claves de idempotencia siempre que un agente pueda reintentar tras un timeout.

​
Variables de entorno

VariablePurpose
YOUKA_API_KEYClave de API usada cuando no se establece mediante youka login.
YOUKA_API_BASE_URLURL base alternativa de la API. Anulada por --api.

​
Qué sigue

  • Account - guarda tu clave de API
  • Projects - tu primer flujo de trabajo con scripting
  • AI agents - reglas operativas para autores de agentes