Skip to main content
QwenCloud home page
Docs
Directing

HappyOyster-Directing-Send Process Instruction API Reference

Send a single text instruction to a standard-mode Travel to drive subsequent frame generation. Only creationModel=simple is supported; a scriptlist Travel should use full script update.

POST
/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels/instruct
cURL - Send process instruction
curl --location 'https://dashscope-intl.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
  }
}

Scope

  • The primary API Key is not required; either the primary or a temporary API Key can call it.
  • Only creationModel=simple is supported; a scriptlist Travel should use Full Script Update, and calling instruct by mistake returns 403006.
If the model call fails and returns an error, see HappyOyster Error Codes to resolve it.

Authorizations

​
string
header
required

QwenCloud API Key. Only the primary API Key (sk- prefix) is supported. See Get an API Key.

Header Parameters

​
string
default"application/json"
required

Request content type. This parameter must be set to application/json.

​
string
required

API Key authentication. The primary API Key is not required; either the primary or a temporary API Key can call it.

  • Primary API Key: starts with sk-, e.g. sk-xxx.
  • Temporary API Key: starts with st-, e.g. st-xxx.

Body

application/json
​
string
required

The Travel ID to control; creationModel must be simple.

​
string
required

The text process instruction. Non-empty, up to 2000 characters.

​
string

Idempotency key for instruction retries. Recommended format [A-Za-z0-9_-]{1,32}.

​
string

Response

200-application/json
​
integer
​
string
​
object