Skip to main content
Todo projeto tem configurações ativas — trim, background, estilo de legendas, layout — que controlam como as exportações são renderizadas. Use as configurações do projeto quando você quiser substituições locais do projeto que não valem a pena compartilhar como um preset. Veja Render settings reference para o mapa de campos compartilhados de preset, settings.style e settingsOverride.

Endpoints

MethodPathPurpose
GET/projects/{projectId}/settingsBuscar as configurações ativas do projeto.
PATCH/projects/{projectId}/settingsAplicar um preset, atualizar settings, ou ambos.
Os esquemas completos de requisição e resposta estão em API reference.

Buscar as configurações atuais

curl https://api.youka.io/pt/api/v1/projects/prj_abc/settings \
  -H "Authorization: Bearer yk_..."
Retorna as configurações ativas completas do projeto, incluindo qualquer preset que esteja aplicado.

Atualizar as configurações

PATCH aceita qualquer subconjunto de presetId e settings. Quando ambos são enviados, o preset é aplicado primeiro e depois settings é mesclado por cima.
curl -X PATCH https://api.youka.io/pt/api/v1/projects/prj_abc/settings \
  -H "Authorization: Bearer yk_..." \
  -H "Content-Type: application/json" \
  -d '{
    "presetId": "preset_abc123"
  }'

Descobrir campos válidos

O SDK exporta o schema que valida atualizações de configurações do projeto. Converta-o para JSON Schema em runtime:
import { RestUpdateProjectSettingsRequestSchema } from "@youka/sdk";

const schema = RestUpdateProjectSettingsRequestSchema.toJSONSchema();
Agents devem buscar o schema do SDK ou o schema de requisição do OpenAPI antes de alterar configurações do projeto, para que sempre conheçam o formato atual.
Referência legível para humanos:

Configurações do projeto vs presets vs substituições de exportação

O Youka tem três camadas onde as configurações de renderização podem ficar:
LayerScopeWhen to use
PresetAccount-wideA mesma aparência em muitos projetos.
Project settingsOne projectTrim, background ou cor específicos do projeto.
Export settingsOverrideOne export onlyAjustar uma única renderização sem mexer no projeto.
Cada camada é mesclada nessa ordem no momento da exportação.

Próximos passos