Skip to main content

Référence de l'API HappyOyster-Directing-Update Script

Soumettre l'ensemble complet de 45 tours dans un Travel en mode script pour remplacer intégralement les acts du Travel actuel. Seul creationModel=scriptlist est pris en charge.

Scope

Soumettre l'ensemble complet de 45 tours dans un Travel en mode script (creationModel=scriptlist) afin de remplacer intégralement les acts du Travel actuel. Avant d'effectuer l'appel, confirmer les points suivants :
  • Authentification : La clé API principale n'est pas requise ; la clé principale ou une clé API temporaire peut l'appeler. Pour savoir comment les obtenir, voir Obtenir les identifiants d'authentification.
  • Prérequis : Le creationModel du Travel doit être scriptlist, et son statut doit être running ou pending. Confirmer via Query Travel Status.
  • Appelant : Votre serveur ou votre client peut l'appeler.

Requête HTTP

  • Singapore
  • États-Unis (Virginie)
POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels/update-scriptRemplacez {WorkspaceId} par votre véritable ID d'espace de travail.

Paramètres de la requête

  • Mettre à jour le script
curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels/update-script' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
    -H 'Content-Type: application/json' \
    -d '{
    "encryptedTravelId": "{encryptedTravelId}",
    "scriptList": {
        "acts": [
            {
                "turn": 1,
                "content": "[character_1] wakes up and looks toward the door.",
                "cameraType": "Static",
                "shotSize": "Medium",
                "cut": "long-take"
            },
            {
                "turn": 2,
                "content": "[character_1] walks slowly across the dark room.",
                "cameraType": "Tracking",
                "shotSize": "Wide",
                "cut": "hard-cut"
            }
        ]
    },
    "userAgent": "your-client/1.2.0"
}'
L'exemple n'affiche que les actes 1 et 2 pour illustrer la structure et ne doit pas être soumis tel quel. Une requête réelle doit contenir toutes les 45 entrées, du tour 1 à 45, contiguës et non dupliquées.
Content-Typestring(Requis)Type de contenu de la requête. Ce paramètre doit être défini sur application/json.
Authorization string (Requis)Authentification par clé API. La clé API principale n'est pas requise ; la clé principale ou une clé API temporaire peut l'appeler.
  • Clé API principale : commence par sk-, par ex. sk-xxx.
  • Clé API temporaire : commence par st-, par exemple st-xxx.
Corps de la requête
encryptedTravelId string (Obligatoire)L'ID de Travel chiffré Directing à mettre à jour ; son creationModel doit être scriptlist. Renvoyé par Enter Travel.
scriptList object (Obligatoire)Conteneur de script complet. Seul acts prend effet ; même s'il inclut subjects, synopsis, scene, style, speed, language, setting, soundtrack, prologue ou videoTags, ces champs sont ignorés et la plateforme continue d'utiliser les valeurs enregistrées lors de la création du World.scriptList.acts array (Obligatoire)Liste complète des actes. Contraintes :
  • Doit contenir exactement 45 entrées
  • turn doit couvrir 1–45, contigus et non dupliqués
  • content non vide, jusqu'à 2000 caractères par battement ; tous les content totalisant jusqu'à 100000 caractères
  • cameraType (optionnel, par défaut Static), shotSize (optionnel, Wide / Medium / Close-up, par défaut Medium), cut (optionnel, par défaut long-take)
Ce point de terminaison est un remplacement complet et ne prend pas en charge la soumission uniquement des tours modifiés.
userAgent string (Facultatif)Identifiant de version du SDK ou du client. Une chaîne non vide ; prévaut sur le User-Agent HTTP.

Paramètres de réponse

  • Mise à jour acceptée
{
    "code": 0,
    "message": null,
    "data": {
        "encryptedTravelId": "trvl_a1b2****",
        "accepted": true,
        "turnCount": 45
    }
}
code integerCode de retour. 0 indique un succès ; une valeur non nulle correspond à un code d'erreur.
message stringMessage d'erreur. null en cas de succès.
data objectDonnées de réponse. null en cas d'échec.

Propriétés

encryptedTravelId stringL'identifiant de voyage chiffré.accepted booleanIndique si le script complet a été accepté et est entré dans le flux de traitement.turnCount integerLe nombre de tours dans cette mise à jour complète, fixé à 45.

États préalables et notes d'appel

  • Seul creationModel=scriptlist prend en charge ce point de terminaison ; un Voyage en mode standard qui l'appelle par erreur retourne 409000.
  • Le statut du Voyage doit être running ou pending.
  • acts doit contenir exactement 45 entrées ; turn doit être 1–45, contigus et non dupliqués, sinon 400000 est retourné.
  • Le contenu du script qui échoue à la politique de sécurité du contenu retourne 403004 ; un rejet pour conformité aux droits d'auteur ou à la propriété intellectuelle retourne 403005.

Codes d'erreur

Si l'appel du modèle échoue et renvoie une erreur, consultez Codes d'erreur HappyOyster pour la résoudre.

Étapes suivantes

Après la mise à jour :