HappyOyster-Directing-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 creationModel must be simple, and it must be in a state that can receive instructions. 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-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"
}'

{
    "code": 0,
    "message": null,
    "data": {
        "encryptedTravelId": "trvl_a1b2****",
        "content": "A giant robot dinosaur suddenly appears",
        "accepted": true
    }
}

​

Prerequisite states and call notes

• Only creationModel=simple supports this endpoint; a scriptlist Travel should use Full Script Update, and calling instruct by mistake returns 403006.
• The Travel's current state must be able to receive instructions; a Travel that has ended or failed is not writable.
• When content is empty or over 2000 characters, 400000 is returned.
• We recommend generating a stable clientRequestId for each logical instruction and reusing it on retries.
• When the instruction fails the content safety policy, 403004 is returned.

​

Error codes

​

Next steps

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