Acting (Invitational Preview)
HappyOyster-Acting-Resume Travel API Reference
Resume a paused Acting Travel so that it re-enters the running state.
POST/api/v2/apps/happyoyster-1.0-acting/openapi/v1/travels/resume
curl --location 'https://dashscope-intl.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/travels/resume' \
-H "Authorization: Bearer $DASHSCOPE_API_KEY" \
-H 'Content-Type: application/json' \
-d '{
"encryptedTravelId": "{encryptedTravelId}",
"userAgent": "HappyOyster-Web/1.2.0"
}'
{
"code": 0,
"message": null,
"data": {
"encryptedTravelId": "trvl_a1b2****",
"status": "running"
}
}
Scope
Resume a paused Acting 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.
- Prerequisites: The Travel must be confirmed as
paused 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
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.
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/jsonThe Acting encrypted Travel ID to control. Returned by Enter Travel (Client).
SDK or client version identifier. A non-empty string; takes precedence over the HTTP User-Agent, used for SDK version and platform statistics.
Return code. 0 means success; non-zero is an error code.
Error message. null on success.
Response data. null on failure.
Returns paused on pause, and running on resume.
Available options:paused,running
curl --location 'https://dashscope-intl.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/travels/resume' \
-H "Authorization: Bearer $DASHSCOPE_API_KEY" \
-H 'Content-Type: application/json' \
-d '{
"encryptedTravelId": "{encryptedTravelId}",
"userAgent": "HappyOyster-Web/1.2.0"
}'
{
"code": 0,
"message": null,
"data": {
"encryptedTravelId": "trvl_a1b2****",
"status": "running"
}
}