HappyOyster-Acting-Send Process Instruction API Reference

​

Scope

• Authentication: The primary API Key is not required; either the primary or a temporary API Key can call it. For how to obtain them, see Obtain authentication credentials.
• Prerequisites: The Travel's state must be running or paused. Confirm via Query Travel Status.
• Caller: Either your server or your client can call it.

​

HTTP request

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"
}'

{
    "code": 0,
    "message": null,
    "data": {
        "encryptedTravelId": "trvl_a1b2****",
        "content": "Smile and greet me, and ask how my day is going",
        "accepted": true
    }
}

​

Prerequisite states and call notes

• The Travel's state must be running or paused.
• content is required and cannot be empty or contain only whitespace characters, up to 2000 characters.
• Sending an instruction in the paused state only accepts the instruction and does not automatically resume the Travel; when you need to continue running, the client must separately call Resume Travel.
• Reuse the clientRequestId when retrying the same logical instruction to avoid duplicate billing.
• A Travel that has ended or failed is not writable.
• When the instruction fails the content safety policy, 403004 is returned.
• Acting's creationModel is always simple, so there is no need to consider the ScriptList sub-mode.

​

Error codes

​

Next steps

• Query Travel Status: view instruction execution status and chapter information.
• Pause Travel / Resume Travel: control the running pace.
• End Travel: end the session and process artifacts.