ReelaDocs

Automatisation

Créez des vidéos et reliez les résultats terminés à votre workflow grâce aux abonnements de fin d’exécution de Reela CLI.

Créez des vidéos et reliez les résultats terminés à votre workflow grâce aux abonnements de fin d’exécution de Reela CLI.

Reela fournit des commandes de production vidéo et des abonnements de fin d’exécution pour les vidéos terminées. Un agent ou un autre outil peut envoyer un brief et recevoir le résultat via le daemon CLI sans laisser le site Reela ouvert.

Du brief à la vidéo

create transforme un brief textuel et des médias facultatifs en tâche vidéo. Vous pouvez saisir une instruction directement ou la lire depuis un fichier, choisir la durée et la mise en page, inclure des avatars et joindre des images de référence, des séquences vidéo ou une musique de fond.

reela create --prompt-file brief.txt \
  --visual ai-video --layout portrait --duration 30 \
  --session "Product campaign" --output json

La génération vidéo est une tâche de longue durée. Démarrez le daemon et configurez un abonnement de fin d’exécution avant l’envoi ; Reela exécute la génération en arrière-plan et transmet le résultat terminé à votre script. Réutiliser le titre d’une session regroupe les vidéos associées dans un projet. Consultez Livraison automatique ci-dessous pour la configuration.

Avant l’envoi, ajoutez --dry-run pour valider la requête et prévisualiser le nombre estimé de crédits, sans téléverser de fichiers ni créer de tâche. L’envoi d’une tâche peut consommer des crédits.

Consultez les options de création vidéo pour connaître les visuels et les médias pris en charge.

Choisir la qualité et le coût avec les niveaux

Les niveaux vous permettent de choisir l’option de génération pour chaque requête. Reela fournit des descriptions pour vous aider, ou aider un agent, à sélectionner une option adaptée au résultat souhaité, puis estime le nombre de crédits pour cette requête avant son envoi.

reela tiers list
reela tiers list --output json

La liste affiche le libellé et la description de chaque niveau et indique celui par défaut. Dans la sortie JSON, tiers contient des entrées avec label, content et is_default ; default_tier indique le niveau par défaut. Consultez content pour comprendre chaque option, plutôt que de choisir en fonction de sa position dans la liste. L’affichage des niveaux ne garantit pas que votre compte puisse utiliser chaque option ; Reela vérifie les droits d’accès lors de la validation ou de l’envoi d’une requête.

Transmettez le libellé exact à --tier. Remplacez <tier-label> ci-dessous par un libellé de votre liste, en conservant les guillemets s’il contient des espaces :

reela create --prompt-file brief.txt --visual ai-video \
  --tier "<tier-label>" --duration 30 --layout portrait \
  --dry-run --output json

La prévisualisation renvoie credits_cost et quota_after. Pour envoyer la requête, supprimez --dry-run et conservez le niveau sélectionné ainsi que les autres options. Un niveau décrit un choix de génération ; utilisez la prévisualisation pour estimer le coût de votre requête réelle.

Si vous omettez --tier, Reela utilise le niveau par défaut actuellement disponible dans le CLI. Si aucun niveau par défaut n’est disponible, exécutez reela tiers list pour actualiser les options ou indiquez explicitement un niveau. La sélection explicite d’un niveau permet de conserver le choix de votre workflow indépendamment des changements du niveau par défaut ; la disponibilité et les tarifs peuvent toutefois évoluer. Utilisez le même profil pour lister, prévisualiser et envoyer les requêtes.

Consultez la référence de la commande des niveaux pour plus de détails sur la sortie et le comportement de sélection.

Résultats structurés pour les agents et les outils

--output json met à disposition des données structurées pour les résultats des commandes, y compris les choix de niveaux, les estimations de crédits et les confirmations d’envoi. Le code de sortie 0 signifie que la commande a réussi ; les erreurs utilisent des codes de sortie non nuls et du texte brut sur stderr, y compris en mode JSON.

Après un envoi réussi, le daemon attend la fin de la tâche et appelle votre script abonné en lui transmettant le résultat. La réponse à l’envoi et l’événement de fin d’exécution incluent un task_id afin que votre workflow puisse associer la vidéo terminée à son brief d’origine.

Livraison automatique

Reela CLI peut exécuter votre propre programme lorsque la génération d’une vidéo est terminée. Cet abonnement de fin d’exécution relie le résultat de Reela à l’étape suivante : transmettre une vidéo à un outil de publication, mettre à jour un enregistrement ou avertir un autre système. Reela surveille la fin de la tâche et fournit les détails correspondants à votre script.

Enregistrer votre script

Indiquez le chemin absolu d’un exécutable sur la machine qui exécute Reela CLI. Il peut être écrit dans n’importe quel langage, à condition de lire l’événement depuis stdin et de signaler sa réussite au moyen de son code de sortie.

reela subscribe add script --path /absolute/path/on-video \
  --timeout-seconds 300 --max-retries 3

Chaque profil dispose d’un abonnement de script. Pour modifier l’exécutable d’un abonnement existant, utilisez reela config set delivery.script.path /absolute/path/on-video. Redémarrez un daemon déjà en cours d’exécution après avoir modifié l’abonnement ou ses paramètres, comme indiqué ci-dessous.

Recevoir l’événement de fin d’exécution

Reela démarre l’exécutable et écrit un objet JSON sur stdin :

{
  "event": "task.completed",
  "task_id": "12345",
  "status": "completed",
  "status_label": "completed",
  "title": "Product demo",
  "description": "A short product introduction",
  "download": {
    "filename": "product-demo.mp4",
    "download_url": "https://example.com/video.mp4"
  }
}

Utilisez task_id pour relier l’événement à votre envoi d’origine. title, description et download peuvent être null. Lorsqu’il est présent, download fournit à votre script le nom de fichier suggéré et l’URL de téléchargement de la vidéo terminée, afin qu’il puisse les utiliser directement. Gérez l’absence de la valeur download avant d’exécuter une action qui nécessite la vidéo.

Les liens download_url signés expirent 6 heures après leur génération. Téléchargez la vidéo ou copiez-la dans votre propre espace de stockage rapidement après avoir reçu l’événement de fin d’exécution. Gardez les URL de téléchargement privées et considérez-les comme des liens d’accès temporaires, et non comme des adresses vidéo permanentes.

L’abonnement reçoit les tâches terminées pour le compte sélectionné, y compris les vidéos créées en dehors du CLI. Si votre action concerne un workflow précis, faites correspondre l’ID de tâche de l’événement à vos tâches envoyées. Les abonnements de fin d’exécution ne gèrent actuellement que les tâches terminées avec succès ; les tâches échouées, annulées ou partielles ne déclenchent pas cet événement.

Exécution et nouvelles tentatives

  • Réussite : quittez avec 0 une fois votre action réussie. Reela ignore la sortie standard du script ; il n’utilise pas le texte affiché comme résultat.
  • Délai d’expiration : --timeout-seconds 300 autorise jusqu’à 300 secondes par exécution. Un délai d’expiration ou une sortie non nulle entraîne l’échec de la livraison.
  • Nouvelles tentatives : Reela réessaie la livraison après un échec. Lorsque seul l’exécution du script échoue, --max-retries 3 autorise trois tentatives au total, première tentative comprise. Les échecs impliquant d’autres méthodes activées utilisent delivery.max_retries.
  • Livraisons répétées : faites en sorte que les actions puissent être répétées sans risque pour le même task_id, afin qu’une nouvelle exécution ne publie pas la même vidéo et n’ajoute pas deux fois le même enregistrement.

Maintenir l’abonnement en cours d’exécution

Le daemon CLI gère les événements de fin d’exécution et lance vos méthodes de livraison activées. Après avoir choisi vos méthodes, démarrez-le et vérifiez l’état de la livraison :

reela daemon start
reela subscribe status

L’ajout d’une méthode tente également de démarrer un daemon arrêté. Si le daemon est déjà en cours d’exécution, redémarrez-le après avoir modifié les paramètres de livraison pour que ces changements prennent effet. Pour un daemon démarré manuellement, utilisez reela daemon stop puis reela daemon start.

Reela enregistre la progression de la livraison et la reprend à partir de ce point au redémarrage du daemon. En l’absence de progression enregistrée, il suit par défaut les nouveaux événements. reela daemon start --keep-backlog traite également les événements de tâches terminées antérieurs encore disponibles lorsqu’aucune progression enregistrée n’existe.

Utilisez reela daemon install pour activer le démarrage à la connexion. Si le daemon est installé en tant que service, redémarrez-le à l’aide du gestionnaire de services de votre système d’exploitation après avoir modifié la configuration. Consultez reela daemon status ou reela daemon logs --tail 50 pour examiner la livraison.

La livraison automatique nécessite que la machine exécutant le daemon reste allumée et connectée. Démarrez-le avant d’envoyer les vidéos dont la fin doit déclencher votre script.

daemon et subscribe sont disponibles sur Linux et macOS. La version x64 de Windows prend en charge les commandes vidéo, les requêtes d’état et les téléchargements manuels.

Livraison facultative par téléchargement et par e-mail

Vous pouvez activer les téléchargements automatiques ou l’envoi par e-mail des vidéos terminées en plus de votre script. Les téléchargements sont activés dans les paramètres de livraison par défaut ; définissez la destination avec reela config set delivery.download ~/Videos/reela. S’ils sont désactivés, activez-les avec reela subscribe add download --dir ~/Videos/reela. Activez l’e-mail avec reela subscribe add email, en ajoutant éventuellement --address me@example.com pour utiliser une adresse différente de celle de votre compte.

Plusieurs méthodes peuvent être actives simultanément, et l’échec d’une méthode n’empêche pas les autres de s’exécuter. Chaque exécution du script reçoit son propre contenu de fin d’exécution, y compris les informations de téléchargement lorsqu’elles sont disponibles. Consultez la référence des commandes de livraison pour connaître toutes les méthodes.

Réutiliser votre configuration de production

Reela met à disposition d’autres fonctionnalités qui peuvent devenir des étapes de votre workflow :

  • Identité de marque cohérente : répertoriez les kits de marque existants avec brand list et appliquez-en un à une tâche avec brand apply. La commande attend le résultat avec identité de marque. Consultez les commandes de marque.
  • Montage programmatique : téléchargez le JSON de montage, validez les modifications, enregistrez un brouillon pour prévisualisation et envoyez un rendu avec edit. Consultez les commandes de montage.
  • Comptes et préférences distincts : sélectionnez un profil avec --profile ou REELA_PROFILE. Les méthodes et paramètres de livraison s’appliquent au profil sélectionné. Consultez les profils et la configuration.

Par exemple, un workflow de vidéo produit peut envoyer un brief avec des images de référence et utiliser un abonnement de fin d’exécution du daemon pour transmettre la vidéo terminée à votre outil de publication. Reela assure la génération en arrière-plan et la livraison à la fin de l’exécution ; votre outil choisit quand envoyer la requête et quelle action effectuer à la réception du résultat.

Consultez la référence des commandes de livraison pour connaître toutes les options d’abonnement et de daemon. Pour l’installation et l’autorisation du compte, commencez par Bien démarrer.