Skip to main content
QwenCloud home page
Docs
Directing

HappyOyster-Directing-Query Travel List API Reference

Paginate through the Directing Travels under the current primary account, with optional filtering by status or associated World.

GET
/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels
cURL - Query Travel list
curl --location 'https://dashscope-intl.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels?page=1&pageSize=20&status=completed&encryptedWorldId={encryptedWorldId}' \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY"
{
  "code": 0,
  "message": null,
  "data": {
    "items": [
      {
        "encryptedTravelId": "trvl_a1b2****",
        "status": "completed",
        "mode": 2,
        "encryptedWorldId": "enc_a1b2****",
        "durationSec": 180,
        "createdAt": "2026-06-03T10:00:00Z",
        "endedAt": "2026-06-03T10:03:00Z"
      },
      {
        "encryptedTravelId": "trvl_g7h8****",
        "status": "completed",
        "mode": 2,
        "encryptedWorldId": "enc_a1b2****",
        "durationSec": null,
        "createdAt": "2026-06-03T11:00:00Z",
        "endedAt": "2026-06-03T11:03:00Z"
      }
    ],
    "pagination": {
      "page": 1,
      "pageSize": 20,
      "total": 2,
      "hasMore": false
    }
  }
}

Scope

  • Only the primary API Key is supported; temporary API Keys cannot be used (error code 403003).
  • The endpoint automatically filters by the Directing model; items[].mode is always 2.
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. Only the primary API Key is supported; it starts with sk-, e.g. sk-xxx. It is typically configured as the environment variable $DASHSCOPE_API_KEY. A temporary API Key (starting with st-) returns 403003.

Query Parameters

​
integer
default1

Page number, defaults to 1. When page <= 0 it is treated as 1.

​
integer
default20

Items per page, defaults to 20. When pageSize <= 0 it is treated as 20; when greater than 100 it is capped at 100.

​
enum<string>

Filter by Travel status. Unknown values are not applied as a filter.

Available options:init,pending,running,failed,completed
​
string

A Directing encrypted World ID under the current primary account. When provided, only the Travels of that World are returned.

Response

200-application/json
​
integer
​
string
​
object