HappyOyster-Directing-Query Travel List API Reference - Alibaba Cloud Model Studio

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

Scope

Paginate through the Directing Travels under the current primary account, with optional filtering by status or associated World. Before calling, confirm the following:

Authentication: Only the primary API Key is supported; temporary API Keys cannot be used (error code 403003).
- Get the primary API Key: Get and configure an API Key.
Caller: Called by your server.

HTTP request

Singapore

GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels

Replace {WorkspaceId} with your actual Workspace ID.

US (Virginia)

GET https://{WorkspaceId}.us-east-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels

Replace {WorkspaceId} with your actual Workspace ID.

Request parameters

Query Travel list

curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.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"

Authorization 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

page integer (Optional)

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

pageSize integer (Optional)

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

status string (Optional)

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

init: initializing session resources
pending: queued or waiting for service resources
running: running
failed: the Travel failed
completed: the Travel has ended; artifacts can be queried

encryptedWorldId string (Optional)

A Directing encrypted World ID under the current primary account. When provided, only the Travels of that World are returned. This endpoint automatically limits results to the Directing model and does not support the mode query parameter.

Response parameters

{
    "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
        }
    }
}

code integer

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

message string

Error message. null on success.

data object

Response data. null on failure.

Properties

items array

The Travels on the current page; an empty array when there is no result. Each item contains encryptedTravelId, status, mode (always 2), encryptedWorldId, durationSec (null when running or the final cut is not yet ready), createdAt, and endedAt (null when running).

pagination object

Pagination info. Contains page, pageSize, total, and hasMore.

Prerequisite states and call notes

The model filter takes effect automatically, and items[].mode is always 2.
When filtering with encryptedWorldId, that World must belong to the current primary account and the Directing model; a World ID from another model returns 403001.
For a running Travel, durationSec and endedAt can be null.
An unknown status does not raise an error; it is treated as no status filter. For a server-side paused status, query a single Travel through Query Travel Status.

Error codes

If the model call fails and returns an error, see HappyOyster Error Codes to resolve it.

Next steps

Query Travel Status: query the real-time status of a single Travel.
Query Travel Artifacts: query the video artifacts of a completed Travel.