Skip to main content
QwenCloud home page
Docs
Directing

HappyOyster-Directing-Query Travel Status API Reference

Query the Directing Travel lifecycle, server-side streaming status, executed text instructions, and chapter information; you can also report the client's pull-stream or playback heartbeat at the same time.

GET
/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels/status
cURL - Query Travel status
curl --location 'https://dashscope-intl.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/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": [
      {
        "instruction": "A giant robotic dinosaur suddenly appears",
        "relativeStartTimeMs": 12000,
        "relativeEndTimeMs": 16000,
        "startTime": 12,
        "endTime": 16,
        "status": "executed"
      }
    ],
    "chapters": [
      {
        "chapterId": 1,
        "title": "Chapter 1",
        "brief": "The detective enters the cyberpunk city",
        "actRange": [
          0,
          10
        ],
        "startTime": 4,
        "endTime": 20,
        "chapterImage": "https://cdn.happyoyster.com/chapters/ch1.jpg"
      }
    ],
    "characterActions": [],
    "environmentActions": []
  }
}

Scope

  • The primary API Key is not required; either the primary or a temporary API Key can call it.
  • Polling every 2-5 seconds is recommended.
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
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 Directing encrypted Travel ID.

​
enum<string>

The client's RTC pull-stream or playback status.

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

The millisecond timestamp of the client state change.

Response

200-application/json
​
integer
​
string
​
object
HappyOyster-Directing-Query Travel Status API Reference - QwenCloud