Skip to main content
QwenCloud home page
Docs
Acting (Invitational Preview)

HappyOyster-Acting-Send Process Instruction API Reference

Send a single text instruction to an Acting Travel to drive subsequent role-play and frame generation. Callable when the Travel is running or paused.

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

Scope

Send a single text instruction to an Acting Travel to drive subsequent role-play and frame generation. Before calling, confirm the following:
  • Authentication: The primary API Key is not required; either the primary or a temporary API Key can call it.
  • 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.
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 Acting encrypted Travel ID to control. Returned by Enter Travel (Client).

​
string
required

The text process instruction. Non-empty, up to 2000 characters; returns 400000 when missing, empty, or over the limit.

​
string

Idempotency key for instruction retries. Reuse the same value when retrying the same instruction to avoid duplicate billing. Recommended format [A-Za-z0-9_-]{1,32}. Being omitted or malformed does not return a parameter error: the server falls back to the gateway request_id, and uses a random idempotency key when that is still unavailable. This field is only used for billing deduplication; it does not guarantee that the instruction processing itself runs exactly once.

​
string

SDK or client version identifier. A non-empty string; takes precedence over the HTTP User-Agent.

Response

200-application/json
​
integer

Return code. 0 means success; non-zero is an error code.

​
string

Error message. null on success.

​
object

Response data. null on failure.