Skip to main content

Référence de l'API HappyOyster-Directing-Send Process Instruction

Envoyer une instruction textuelle unique à un voyage en mode standard pour piloter la génération des images suivantes. Seul creationModel=simple est pris en charge ; un voyage scriptlist doit utiliser la mise à jour complète du script.

Scope

Envoyer une instruction textuelle unique à un voyage en mode standard (creationModel=simple) pour piloter la génération des images suivantes. 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 voyage doit être simple, et il doit être dans un état capable de recevoir des instructions. Confirmer via Interroger le statut du voyage.
  • 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/instructRemplacez {WorkspaceId} par votre véritable ID d'espace de travail.

Paramètres de la requête

  • Envoyer une instruction de processus
curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels/instruct' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
    -H 'Content-Type: application/json' \
    -d '{
    "encryptedTravelId": "{encryptedTravelId}",
    "content": "A giant robot dinosaur suddenly appears",
    "clientRequestId": "instruction_20260909_001",
    "userAgent": "your-client/1.2.0"
}'
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 voyage chiffré de mise en scène à contrôler ; creationModel doit être simple. Retourné par Entrer dans le voyage.
content string (Obligatoire)L'instruction de processus textuelle. Non vide, jusqu'à 2000 caractères ; retourne 400000 si vide ou dépassant 2000 caractères.
clientRequestId string (Facultatif)Clé d'idempotence pour les nouvelles tentatives d'instructions. Réutilisez la même valeur lors d'une nouvelle tentative pour la même instruction afin d'éviter une facturation en double. Format recommandé [A-Za-z0-9_-]{1,32}.
  • Son omission ou un format incorrect ne retourne pas d'erreur de paramètre : le serveur utilise alors le request_id de la passerelle par défaut, et utilise une clé d'idempotence aléatoire lorsque celui-ci n'est toujours pas disponible
  • Ce champ est uniquement utilisé pour la déduplication de la facturation ; il ne garantit pas que le traitement de l'instruction lui-même s'exécute exactement une fois
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

  • Instruction acceptée
{
    "code": 0,
    "message": null,
    "data": {
        "encryptedTravelId": "trvl_a1b2****",
        "content": "A giant robot dinosaur suddenly appears",
        "accepted": true
    }
}
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é.content stringLe texte d'instruction accepté.accepted booleanIndique si l'instruction a été acceptée et est entrée dans le flux de traitement.

États préalables et notes d'appel

  • Seul creationModel=simple prend en charge ce point de terminaison ; un voyage scriptlist doit utiliser Mise à jour complète du script, et l'appel erroné de instruct retourne 403006.
  • L'état actuel du voyage doit permettre de recevoir des instructions ; un voyage terminé ou ayant échoué n'est pas modifiable.
  • Lorsque content est vide ou dépasse 2000 caractères, 400000 est retourné.
  • Nous recommandons de générer un clientRequestId stable pour chaque instruction logique et de le réutiliser lors des nouvelles tentatives.
  • Lorsque l'instruction ne respecte pas la politique de sécurité du contenu, 403004 est retourné.

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 l'envoi de l'instruction :