Skip to main content
Directing

HappyOyster-Directing-End Travel API Reference

End a Directing Travel. After a normal end the status changes to completed and it enters artifact processing; on a no-stream timeout end it changes to failed and no replay artifacts are generated.

POST
/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels/end
curl --location 'https://dashscope-intl.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels/end' \
  -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": "completed",
    "endedAt": "2026-06-04T00:03:00Z",
    "durationSec": 180
  }
}

Scope

  • The primary API Key is not required; either the primary or a temporary API Key can call it.
  • After a normal end the status becomes completed and artifact processing begins; on a no-stream timeout end the status becomes failed and no replay artifacts are generated.
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 Directing encrypted Travel ID to end.

enum<string>

Failure end reason. When omitted, it is treated as a normal end. Currently only TRAVEL_NO_STREAM_AUTO_END is supported.

TRAVEL_NO_STREAM_AUTO_END
string

SDK or client version identifier. A non-empty string.

Response

200-application/json
integer
string
object
HappyOyster-Directing-End Travel API Reference - QwenCloud