Skip to main content
Chaque projet possède des paramètres actifs — découpe, arrière-plan, style de sous-titres, mise en page — qui contrôlent la façon dont les exports sont rendus. Utilisez les paramètres du projet lorsque vous souhaitez des surcharges locales au projet qui ne valent pas la peine d’être partagées sous forme de preset. Voir Référence des paramètres de rendu pour la cartographie des champs partagés preset, settings.style et settingsOverride.

Endpoints

MethodPathPurpose
GET/projects/{projectId}/settingsRécupérer les paramètres actifs du projet.
PATCH/projects/{projectId}/settingsAppliquer un preset, modifier les paramètres, ou les deux.
Les schémas complets des requêtes et des réponses se trouvent dans la référence API.

Récupérer les paramètres actuels

curl https://api.youka.io/fr/api/v1/projects/prj_abc/settings \
  -H "Authorization: Bearer yk_..."
Renvoie l’ensemble des paramètres actifs du projet, y compris tout preset appliqué.

Modifier les paramètres

PATCH accepte n’importe quel sous-ensemble de presetId et settings. Lorsque les deux sont fournis, le preset est appliqué d’abord puis settings est fusionné par-dessus.
curl -X PATCH https://api.youka.io/fr/api/v1/projects/prj_abc/settings \
  -H "Authorization: Bearer yk_..." \
  -H "Content-Type: application/json" \
  -d '{
    "presetId": "preset_abc123"
  }'

Découvrir les champs valides

Le SDK exporte le schéma qui valide les mises à jour des paramètres du projet. Convertissez-le en JSON Schema à l’exécution :
import { RestUpdateProjectSettingsRequestSchema } from "@youka/sdk";

const schema = RestUpdateProjectSettingsRequestSchema.toJSONSchema();
Les agents devraient récupérer le schéma du SDK ou le schéma de requête OpenAPI avant de modifier les paramètres du projet afin de toujours connaître la structure actuelle.
Référence lisible :

Paramètres du projet vs presets vs surcharges d’export

Youka propose trois couches où les paramètres de rendu peuvent vivre :
LayerScopeWhen to use
PresetÀ l’échelle du compteLa même apparence sur de nombreux projets.
Project settingsUn seul projetDécoupe, arrière-plan ou couleur spécifiques au projet.
Export settingsOverrideUn seul exportAjuster un rendu unique sans toucher au projet.
Chaque couche est fusionnée dans cet ordre au moment de l’export.

Et ensuite