HappyOyster-Acting-Send Process Instruction API Reference - Alibaba Cloud Model Studio

Envoyer une instruction textuelle unique à un voyage Acting pour déclencher le jeu de rôle ultérieur et la génération d'images. Appelable lorsque le voyage est en cours d'exécution ou en pause.

Scope

Envoyer une instruction textuelle unique à un voyage Acting pour déclencher le jeu de rôle ultérieur et la génération d'images. Avant d'appeler, confirmez 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 : L'état du voyage doit être running ou paused. Confirmez via Query Travel Status.
Appelant : Votre serveur ou votre client peut l'appeler.

Requête HTTP

Singapore

POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/travels/instruct

Remplacez {WorkspaceId} par votre véritable ID d'espace de travail.

États-Unis (Virginie)

POST https://{WorkspaceId}.us-east-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/travels/instruct

Remplacez {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-acting/openapi/v1/travels/instruct' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
    -H 'Content-Type: application/json' \
    -d '{
    "encryptedTravelId": "{encryptedTravelId}",
    "content": "Smile and greet me, and ask how my day is going",
    "clientRequestId": "instruction_greeting_001",
    "userAgent": "HappyOyster-Web/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'identifiant de voyage Acting chiffré à contrôler. Retourné par Enter Travel.

content string (Obligatoire)

L'instruction de processus textuelle. Non vide, jusqu'à 2000 caractères ; retourne 400000 si elle est manquante, vide ou dépasse la limite.

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": "Smile and greet me, and ask how my day is going",
        "accepted": true
    }
}

code integer

Code de retour. 0 indique un succès ; une valeur non nulle correspond à un code d'erreur.

message string

Message d'erreur. null en cas de succès.

data object

Données de réponse. null en cas d'échec.

Propriétés

encryptedTravelId string

L'identifiant de voyage chiffré.

content string

Le texte d'instruction accepté.

accepted boolean

Indique si l'instruction a été acceptée et est entrée dans le flux de traitement.

États préalables et notes d'appel

L'état du voyage doit être running ou paused.
content est obligatoire et ne peut pas être vide ni contenir uniquement des espaces blancs, jusqu'à 2000 caractères.
L'envoi d'une instruction dans l'état paused accepte uniquement l'instruction et ne reprend pas automatiquement le voyage ; lorsque vous devez continuer l'exécution, le client doit appeler séparément Resume Travel.
Réutilisez le clientRequestId lors d'une nouvelle tentative pour la même instruction logique afin d'éviter une facturation en double.
Un voyage terminé ou ayant échoué n'est pas modifiable.
Lorsque l'instruction ne respecte pas la politique de sécurité du contenu, 403004 est retourné.
Le creationModel d'Acting est toujours simple, il n'est donc pas nécessaire de prendre en compte le sous-mode ScriptList.

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 :

Query Travel Status : consulter l'état d'exécution des instructions et les informations sur les chapitres.
Pause Travel / Resume Travel : contrôler le rythme d'exécution.
End Travel : terminer la session et traiter les artefacts.