HappyOyster-Acting-查询World列表 API参考

更新时间:
复制 MD 格式

分页查询当前主账号名下的 Acting World。接口自动按模型隔离,不会返回 Directing 或 Adventure World。

适用范围

分页查询当前主账号名下的 Acting World。调用前请确认以下事项:

  • 鉴权要求:仅支持主 API Key调用,临时 API Key 不可用(错误码 403003)。

  • 调用方:您的服务端调用。

HTTP调用

新加坡

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

调用时请将{WorkspaceId}替换为真实的Workspace ID

美国(弗吉尼亚)

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

调用时请将{WorkspaceId}替换为真实的Workspace ID

请求参数

curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/worlds?page=1&pageSize=20&status=ready' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY"

Authorization string (必选)

API Key 鉴权。仅支持主 API Key,以 sk- 开头,如 sk-xxx。通常配置为环境变量 $DASHSCOPE_API_KEY。临时 API Key(st- 开头)调用返回 403003

Query 参数

page integer (可选)

页码,默认 1page <= 0 时按 1 处理。

pageSize integer (可选)

每页条数,默认 20pageSize <= 0 时按 20,大于 100 时按 100 处理。

status string (可选)

按构建状态筛选。未知值不筛选。可选值:

  • generating:构建中
  • ready:就绪
  • failed:构建失败

mode integer (可选)

无需传入。列表已按 Acting 模型过滤,items[].mode 恒为 3。若仍传入且非 3 返回 400000

响应参数

{
    "code": 0,
    "message": null,
    "data": {
        "items": [
            {
                "encryptedWorldId": "enc_a1b2****",
                "name": "深夜视频通话",
                "status": "ready",
                "mode": 3,
                "previewUrl": null,
                "createdAt": "2026-09-09T08:00:00Z",
                "perspective": null,
                "creationModel": "simple",
                "uploadMode": "first_frame"
            },
            {
                "encryptedWorldId": "enc_g7h8****",
                "name": "客厅轻松对谈",
                "status": "ready",
                "mode": 3,
                "previewUrl": null,
                "createdAt": "2026-09-09T09:00:00Z",
                "perspective": null,
                "creationModel": "simple",
                "uploadMode": "first_frame"
            }
        ],
        "pagination": {
            "page": 1,
            "pageSize": 20,
            "total": 2,
            "hasMore": false
        }
    }
}

code integer

返回码。0 表示成功,非 0 为错误码。

message string

错误信息。成功时为 null

data object

响应数据。失败时为 null

属性

items array

当前页 World 列表;无结果时为空数组。每项含 encryptedWorldIdnamestatusgenerating / ready / failed)、mode(恒为 3)、previewUrl(通常为 null)、createdAtperspective(通常为 null)、creationModel(恒为 simple)、uploadMode(固定为 first_frame)。

pagination object

分页信息。含 page(当前页码)、pageSize(实际每页条数)、total(总记录数)、hasMorepage × pageSize < total 时为 true)。

前置状态与调用注意事项

  • 模型过滤自动生效,列表不会混入其它模型的 World,且 items[].mode 恒为 3
  • 列表项是轻量快照,不返回图片、Prompt、resolutionaspectRatiorefWorldId;需要完整配置时调用查询World详情
  • 翻页时应使用响应中的 pagination.pageSizehasMore,不要假设请求值一定原样采用。
  • 空结果不是错误,返回 items=[] 和对应分页信息。

错误码

如果模型调用失败并返回报错信息,请参见HappyOyster 错误码进行解决。

下一步