HappyOyster-Acting-Pause Travel API Reference - Alibaba Cloud Model Studio

Request to pause a running Acting Travel. After the pause, video generation stops and you can continue via the Resume Travel endpoint.

Scope

Request to pause a running Acting Travel. Before calling, confirm the following:

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 status must be running. Confirm via Query Travel Status.
Caller: Either your server or your client can call it.

HTTP request

Singapore

POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/travels/pause

Replace {WorkspaceId} with your actual Workspace ID.

US (Virginia)

POST https://{WorkspaceId}.us-east-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/travels/pause

Replace {WorkspaceId} with your actual Workspace ID.

Request parameters

Pause Travel

curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/travels/pause' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
    -H 'Content-Type: application/json' \
    -d '{
    "encryptedTravelId": "{encryptedTravelId}",
    "userAgent": "HappyOyster-Web/1.2.0"
}'

Content-Typestring(Required)

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

Authorization 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.

Request Body

encryptedTravelId string (Required)

The Acting encrypted Travel ID to pause. Returned by Enter Travel.

userAgent string (Optional)

SDK or client version identifier. A non-empty string; takes precedence over the HTTP User-Agent, used for SDK version and platform statistics.

Response parameters

Pause succeeded

{
    "code": 0,
    "message": null,
    "data": {
        "encryptedTravelId": "trvl_a1b2****",
        "status": "paused"
    }
}

code integer

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

message string

Error message. null on success.

data object

Response data. null on failure.

Properties

encryptedTravelId string

The encrypted Travel ID.

status string

The target pause status; returns paused.

Prerequisite states and call notes

The current Travel status must be running.
The version in the enter-room response must be actingV2; entering the room for Acting always returns this value.
Pause confirmation is an asynchronous process. After receiving a success response, if you need to immediately resume or send an operation that depends on the paused state, continue polling Query Travel Status until the queried status is paused.
Pause confirmation usually has a status barrier of about 3 seconds; the actual status is subject to the query result.
Pausing does not change aspectRatio; the client keeps the player orientation determined at the time of entering the room.

Error codes

If the model call fails and returns an error, see HappyOyster Error Codes to resolve it.

Next steps

After pausing, you can do the following:

Resume Travel: resume a paused Travel and continue generation.
Send Process Instruction: sending an instruction in the paused state only accepts the instruction and does not automatically resume.
End Travel: end the Travel directly.