HappyOyster-Directing-Resume Travel API Reference - Alibaba Cloud Model Studio

Resume a paused Directing Travel so that it re-enters the running state.

Scope

Resume a paused Directing Travel so that it re-enters the running state. 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 must be confirmed as paused 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-directing/openapi/v1/travels/resume

Replace {WorkspaceId} with your actual Workspace ID.

US (Virginia)

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

Replace {WorkspaceId} with your actual Workspace ID.

Request parameters

Resume Travel

curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels/resume' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
    -H 'Content-Type: application/json' \
    -d '{
    "encryptedTravelId": "{encryptedTravelId}",
    "userAgent": "your-client/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 Directing encrypted Travel ID to resume. Returned by Enter Travel.

userAgent string (Optional)

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

Response parameters

Resume succeeded

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

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 status after resuming; returns running.

Prerequisite states and call notes

The Travel must be confirmed as paused via Query Travel Status.
The version in the enter-room response must be storyV2.
A Travel that has already ended or failed cannot be resumed.

Error codes

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

Next steps

After resuming, you can:

Query Travel Status: confirm the Travel is back to running.
Standard mode: Send Process Instruction.
Script mode: Full script update.
End Travel: end the session and process artifacts.