Skip to main content
QwenCloud home page
Docs
Adventure

HappyOyster-Adventure-Query Travel Status API Reference

Query the Adventure Travel lifecycle, server-side streaming status, and the current world's action pool; you can also report the client's pull-stream or playback heartbeat at the same time.

GET
/api/v2/apps/happyoyster-1.0-adventure/openapi/v1/travels/status
cURL - Query Travel status
curl --location 'https://dashscope-intl.aliyuncs.com/api/v2/apps/happyoyster-1.0-adventure/openapi/v1/travels/status?encryptedTravelId={encryptedTravelId}&clientStreamStatus=PLAYING&clientStreamStatusTimeMs=1788940800000' \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY"
{
  "code": 0,
  "message": null,
  "data": {
    "encryptedTravelId": "trvl_a1b2****",
    "status": "running",
    "rtcStatus": "PUSHING",
    "updateTime": "2026-06-04T00:02:00Z",
    "userInstructions": null,
    "chapters": null,
    "characterActions": [
      "dash",
      "jump",
      "crouch",
      "attack"
    ],
    "environmentActions": [
      "ride_motorcycle",
      "enter_exit_car"
    ]
  }
}

Scope

Query the Adventure Travel lifecycle, server-side streaming status, and the current world's action pool; you can also report the client's pull-stream or playback heartbeat at the same time. Before calling, confirm the following:
  • The primary API Key is not required; either the primary or a temporary API Key can call it.
  • Query with the encryptedTravelId returned by Enter Travel (Client).
  • Either your server or your client can call it. Polling every 2-5 seconds is recommended. Adventure does not support HTTP instruct, pause, resume, rewind, or update-script.
If the model call fails and returns an error, see HappyOyster Error Codes.

Authorizations

​
string
header
required

QwenCloud API Key. Only the primary API Key (sk- prefix) is supported. See Get an API Key.

Header Parameters

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

Query Parameters

​
string
required

The Adventure encrypted Travel ID. Returned by Enter Travel (Client).

​
enum<string>

The client's RTC pull-stream or playback status, case-insensitive. Unrecognized values are ignored. Allowed values: DISCONNECTED (not connected or has left the channel), CONNECTING (connecting to the RTC channel), CONNECTED (joined, but playback has not started or the first frame has not arrived), PLAYING (the remote stream has been received and is rendering), BUFFERING (buffering), PAUSED (the client paused playback; this does not mean the Adventure Travel supports server-side pause), RECONNECTING (reconnecting).

Available options:DISCONNECTED,CONNECTING,CONNECTED,PLAYING,BUFFERING,PAUSED,RECONNECTING
​
integer

The millisecond timestamp of the client state change. Used together with clientStreamStatus.

Response

200-application/json
​
integer

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

​
string

Error message. null on success.

​
object

Response data. null on failure.

HappyOyster-Adventure-Query Travel Status API Reference - QwenCloud