Skip to main content

HappyOyster-Acting-查询World详情 API参考

查询单个 Acting World 的完整元数据和可回显创建参数。构建进度轮询请使用查询World构建状态接口。

适用范围

查询单个 Acting World 的完整元数据和可回显创建参数。调用前请确认以下事项:
  • 鉴权要求:仅支持主 API Key调用,临时 API Key 不可用(错误码 403003)。
  • 前置条件:使用创建World接口返回的 encryptedWorldId 查询。构建进度轮询应使用查询World构建状态。
  • 调用方:您的服务端调用。

HTTP调用

  • 新加坡
  • 美国(弗吉尼亚)
GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/worlds/detail调用时请将{WorkspaceId}替换为真实的Workspace ID。

请求参数

  • 查询World详情
curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/worlds/detail?encryptedWorldId={encryptedWorldId}' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY"
Authorization string (必选)API Key 鉴权。仅支持主 API Key,以 sk- 开头,如 sk-xxx。通常配置为环境变量 $DASHSCOPE_API_KEY。临时 API Key(st- 开头)调用返回 403003。
Query 参数
encryptedWorldId string (必选)当前主账号名下的 Acting 加密 World ID。由创建World接口返回。

响应参数

查询成功
{
    "code": 0,
    "message": null,
    "data": {
        "encryptedWorldId": "enc_a1b2****",
        "name": "深夜视频通话",
        "status": "ready",
        "mode": 3,
        "creationModel": "simple",
        "prompt": "深夜视频通话中,一位安静的女孩微笑着回应镜头",
        "eventStyle": "first_frame",
        "perspective": null,
        "uploadMode": "first_frame",
        "resolution": "480p",
        "aspectRatio": "9:16",
        "layout": null,
        "narrative": null,
        "refWorldId": null,
        "firstFrameImage": {
            "url": "https://cdn.happyoyster.com/frames/portrait-call.jpg",
            "referenceType": "default"
        },
        "inputImages": null,
        "sceneImage": null,
        "roleImage": null,
        "scenePrompt": null,
        "rolePrompt": null,
        "scriptList": null,
        "previewUrl": null,
        "createdAt": "2026-09-09T08:00:00Z",
        "updatedAt": "2026-09-09T08:05:00Z"
    }
}
code integer返回码。0 表示成功,非 0 为错误码。
message string错误信息。成功时为 null。
data object响应数据。失败时为 null。

属性

encryptedWorldId string加密 World ID。name stringWorld 名称。status string构建状态:generating / ready / failed。mode integerActing 恒为 3。creationModel stringActing 恒为 simple。prompt string创建时提交的顶层 Prompt。eventStyle string兼容返回字段;合规创建省略该字段时,服务端通常按 uploadMode 映射并回显 first_frame。它不是 Acting 的创建参数,客户端不应主动回传。perspective nullActing 不接受视角创建参数,固定为 null。uploadMode string固定为 first_frame。resolution string480p / 720p;创建时未传则为 480p。aspectRatio string9:16 / 16:9;创建时未传则为 9:16。layout nullActing 不接受该创建参数,固定为 null。narrative nullActing 不接受该创建参数,固定为 null。refWorldId string衍生创建时使用的 Acting 加密参考 World ID;无则为 null。firstFrameImage object创建时的必填首帧图;只返回 URL 形式,不回传 base64。含 url 和 referenceType。inputImages nullActing 当前不使用该字段。sceneImage nullActing 不使用场景角色图片槽位,固定为 null。roleImage nullActing 不使用场景角色图片槽位,固定为 null。scenePrompt nullActing 不使用场景角色文案,固定为 null。rolePrompt nullActing 不使用场景角色文案,固定为 null。scriptList nullActing 不支持 ScriptList,固定为 null。previewUrl null当前固定为 null。createdAt string创建时间,ISO 8601 格式。updatedAt string最近更新时间,ISO 8601 格式。

前置状态与调用注意事项

  • 本接口可查询 generating、ready 或 failed World;部分构建产物在未就绪时可能为 null。
  • 详情接口不回显 async,因为它是调用行为开关,不是 World 属性。
  • 图片只返回 URL 和 referenceType,不会回传创建请求中的 base64 内容。
  • eventStyle 通常与 uploadMode 同值;客户端应以 uploadMode 作为 Acting 创建模式的权威字段。
  • 播放器可预先读取 aspectRatio,但实际进房时仍应以进入房间响应值设置方向。
  • 查询其它模型、其它主账号或已删除的 World 均返回 403001,不会泄漏资源是否存在。

错误码

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

下一步

文本生成
图像生成
视频生成
3D模型生成
音频
  • 音频生成
Realtime API
  • 概述
向量与排序
决策模型
TokenPlan
模型生产