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
- US (Virginia)
GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travelsReplace {WorkspaceId} with your actual Workspace ID.Request parameters |
|
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:
| |
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 | Query succeeded |
code integerReturn code. 0 means success; non-zero is an error code. | |
message stringError message. null on success. | |
data objectResponse data. null on failure.
Properties items arrayThe 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 objectPagination info. Contains page, pageSize, total, and hasMore. |
Prerequisite states and call notes
- The model filter takes effect automatically, and
items[].modeis always2. - When filtering with
encryptedWorldId, that World must belong to the current primary account and the Directing model; a World ID from another model returns403001. - For a running Travel,
durationSecandendedAtcan benull. - An unknown
statusdoes 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.