Skip to main content
Directing

HappyOyster-Directing-Resume Travel API Reference

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

POST
/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels/resume
cURL - Resume Travel
curl --location 'https://dashscope-intl.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"
}'
{
  "code": 0,
  "message": null,
  "data": {
    "encryptedTravelId": "trvl_a1b2****",
    "status": "running"
  }
}

Scope

  • The primary API Key is not required; either the primary or a temporary API Key can call it.
  • The Travel must be confirmed as paused before resuming. A Travel that has already ended or failed cannot be resumed.
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 encrypted Travel ID.

string

SDK or client version identifier.

Response

200-application/json
integer
string
object