Skip to main content
Un préréglage est une configuration de rendu réutilisable — arrière-plan, style des sous-titres, mise en page — que vous pouvez appliquer à n’importe quel projet ou export. Utilisez des préréglages lorsque vous souhaitez une apparence cohérente sur de nombreux morceaux. Voir Référence des paramètres de rendu pour la forme complète de preset et toutes les options basées sur des enums.

​
Quand utiliser un préréglage

Utilisez un préréglage lorsque…

Vous voulez le même rendu sur de nombreux projets et devez le mettre à jour à un seul endroit.

Utilisez les paramètres de projet lorsque…

Vous avez besoin de personnalisations locales au projet qui ne valent pas la peine d’être partagées.

​
Endpoints

MethodPathPurpose
GET/presetsLister les préréglages du compte authentifié.
POST/presetsCréer un nouveau préréglage.
GET/presets/{presetId}Récupérer un préréglage unique.
PATCH/presets/{presetId}Mettre à jour le nom, le corps, ou définir par défaut.
DELETE/presets/{presetId}Supprimer un préréglage.
Les schémas complets de requête et de réponse sont disponibles sous API reference dans la barre latérale.

​
Créer un préréglage

curl -X POST https://api.youka.io/fr/api/v1/presets \
  -H "Authorization: Bearer yk_..." \
  -H "Idempotency-Key: create-neon-night-v1" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Neon Night",
    "preset": {
      "background": {
        "type": "gradient",
        "colors": ["#12001f", "#2f0a57"],
        "angle": 90
      },
      "singerTextStyles": {
        "0": {
          "fontFamily": "Inter",
          "textColor": "#00f5ff",
          "effectColor": "#ff4fd8"
        }
      }
    },
    "isDefault": false
  }'
La réponse inclut le nouveau presetId. Conservez-le et référencez-le depuis les projets ou les exports.
Associez chaque POST à une clé d’idempotence. Réutiliser la même clé avec le même payload renvoie le préréglage d’origine au lieu d’en créer un doublon.

​
Découvrir les champs valides d’un préréglage

Les préréglages sont validés côté serveur par rapport au KaraokePresetSchema. Le SDK exporte ce schéma afin que vous puissiez le convertir en JSON Schema à l’exécution : 
import { KaraokePresetSchema } from "@youka/sdk";

const jsonSchema = KaraokePresetSchema.toJSONSchema();
Depuis la CLI : 
youka preset schema --json
Les auteurs d’agents devraient appeler ceci avant de modifier des préréglages afin que le modèle connaisse chaque champ valide et chaque type de valeur. Référence lisible :

​
Mettre à jour un préréglage

curl -X PATCH https://api.youka.io/fr/api/v1/presets/preset_abc123 \
  -H "Authorization: Bearer yk_..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Neon Night v2",
    "preset": {
      "singerTextStyles": {
        "0": {
          "textColor": "#ff2a2a"
        }
      }
    }
  }'
Passez n’importe quel sous-ensemble de name et preset. Les champs que vous n’incluez pas restent inchangés.

​
Définir le préréglage par défaut

Chaque compte possède au plus un préréglage par défaut, appliqué automatiquement aux nouveaux projets. 
curl -X PATCH https://api.youka.io/fr/api/v1/presets/preset_abc123 \
  -H "Authorization: Bearer yk_..." \
  -H "Content-Type: application/json" \
  -d '{
    "isDefault": true
  }'
Définir un nouveau préréglage par défaut désactive automatiquement le précédent.

​
Appliquer un préréglage

Référencez un préréglage à trois endroits :
WhereField
Lors de la création du projetpresetId dans POST /projects
À tout moment sur un projetpresetId dans PATCH /projects/{projectId}/settings
Au moment de l’exportpresetId dans POST /projects/{projectId}/exports
Exemple lors de l’export : 
curl -X POST https://api.youka.io/fr/api/v1/projects/prj_abc/exports \
  -H "Authorization: Bearer yk_..." \
  -H "Content-Type: application/json" \
  -d '{
    "presetId": "preset_abc123",
    "resolution": "1080p",
    "quality": "high"
  }'

​
Supprimer un préréglage

curl -X DELETE https://api.youka.io/fr/api/v1/presets/preset_abc123 \
  -H "Authorization: Bearer yk_..." \
  -H "Idempotency-Key: delete-preset_abc123"
Supprimer un préréglage n’affecte pas les projets ni les exports qui ont été rendus auparavant avec celui-ci. Les futurs exports qui référencent le préréglage supprimé échoueront.

​
Et ensuite