Skip to main content
Directing

HappyOyster-Directing-Update Script API Reference

Submit the complete set of 45 turns in a script-mode Travel to fully replace the current Travel's acts. Only creationModel=scriptlist is supported.

POST
/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels/update-script
cURL - Update script
curl --location 'https://dashscope-intl.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels/update-script' \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "encryptedTravelId": "{encryptedTravelId}",
  "scriptList": {
    "acts": [
      {
        "turn": 1,
        "content": "[character_1] wakes up and looks toward the door.",
        "cameraType": "Static",
        "shotSize": "Medium",
        "cut": "long-take"
      },
      {
        "turn": 2,
        "content": "[character_1] walks slowly across the dark room.",
        "cameraType": "Tracking",
        "shotSize": "Wide",
        "cut": "hard-cut"
      }
    ]
  },
  "userAgent": "your-client/1.2.0"
}'
{
  "code": 0,
  "message": null,
  "data": {
    "encryptedTravelId": "trvl_a1b2****",
    "accepted": true,
    "turnCount": 45
  }
}

Scope

  • The primary API Key is not required; either the primary or a temporary API Key can call it.
  • Only creationModel=scriptlist is supported; a standard-mode Travel that calls it by mistake returns 409000.
  • acts must be exactly 45 entries; turn must be 1-45, contiguous and non-duplicated.
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

creationModel must be scriptlist.

object
required

Full script container. Only acts takes effect.

string

Response

200-application/json
integer
string
object