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

更新时间:
复制 MD 格式

查询单个 Directing World 的当前状态、创建参数和可返回的 ScriptList 信息。构建进度轮询请使用查询World构建状态接口。

适用范围

查询单个 Directing World 的当前状态、创建参数和可返回的 ScriptList 信息。调用前请确认以下事项:

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

  • 前置条件:使用创建World接口返回的 encryptedWorldId 查询。构建进度轮询应使用查询World构建状态

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

HTTP调用

新加坡

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

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

美国(弗吉尼亚)

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

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

请求参数

curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/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 (必选)

当前主账号名下的 Directing 加密 World ID。由创建World接口返回。

响应参数

{
    "code": 0,
    "message": null,
    "data": {
        "encryptedWorldId": "enc_a1b2****",
        "name": "午夜访客",
        "status": "ready",
        "mode": 2,
        "creationModel": "scriptlist",
        "prompt": null,
        "eventStyle": "normal",
        "perspective": null,
        "uploadMode": null,
        "resolution": "720p",
        "layout": null,
        "narrative": null,
        "refWorldId": null,
        "firstFrameImage": {
            "url": "https://cdn.happyoyster.com/frames/room.png",
            "referenceType": "default"
        },
        "inputImages": null,
        "scriptList": {
            "synopsis": "深夜,苏黎被敲门声惊醒。",
            "videoTitle": "午夜访客",
            "subjects": [
                {
                    "label": "[character_1]",
                    "name": "苏黎",
                    "type": "character",
                    "refImage": {
                        "url": "https://cdn.happyoyster.com/subjects/suli.png",
                        "referenceType": "default"
                    }
                }
            ],
            "acts": [
                {
                    "turn": 1,
                    "content": "雨水拍打窗户,[character_1] 从睡梦中惊醒。",
                    "cameraType": "Static",
                    "shotSize": "Wide",
                    "cut": "long-take"
                },
                {
                    "turn": 2,
                    "content": "[character_1] 走向房门,门外再次响起敲门声。",
                    "cameraType": "Push-in",
                    "shotSize": "Close-up",
                    "cut": "long-take"
                }
            ]
        },
        "previewUrl": null,
        "aspectRatio": null,
        "createdAt": "2026-06-03T10:00:00Z",
        "updatedAt": "2026-06-03T10:05:00Z"
    }
}

code integer

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

message string

错误信息。成功时为 null

data object

响应数据。失败时为 null

属性

encryptedWorldId string

加密 World ID。

name string

World 名称。

status string

构建状态:generating / ready / failed

mode integer

Directing 恒为 2

creationModel string

simple / scriptlist;决定 Travel 可调用的控制接口。

prompt string

simple 模式创建时的 Prompt;scriptlist 固定为 null

eventStyle string

创建时的事件风格:normal / dramatic / regular

perspective null

Directing 模型通常为 null

uploadMode null

Directing World 通常为 null

resolution string

480p / 720p

layout string

simple 模式的镜头运动风格;未传或 scriptlist 时通常为 null

narrative string

simple 模式的叙事风格;未传或 scriptlist 时通常为 null

refWorldId string

衍生创建时使用的加密参考 World ID。

firstFrameImage object

创建时的首帧图;响应不返回 base64。

inputImages array

simple 模式创建时持久化的参考图;scriptlist 不接受该字段,通常为 null

scriptList object

scriptlist World 有值;结构化剧本反解失败时为 null。含 synopsisvideoTitlescenestylespeedlanguagesettingsoundtrackprologuevideoTagssubjects(含 label/name/type/refImage 等)、acts(按已存内容完整返回,含 turn/content/cameraType/shotSize/cut)。

previewUrl null

当前固定为 null

aspectRatio null

Directing 模型固定为 null

createdAt string

创建时间,ISO 8601 格式。

updatedAt string

最近更新时间,ISO 8601 格式。

前置状态与调用注意事项

  • 本接口可查询 generatingreadyfailed World。
  • 不回显创建请求中的 async
  • 图片字段只返回 URL 和 referenceType,不会回传 base64。simple 模式的 inputImages 会作为参考图持久化并可在详情中返回;scriptlist 不接受该字段。
  • scriptList 正常反解时返回已保存的完整结构,acts 按已存内容完整返回;反解失败时返回 scriptList=null,不会用空 acts 表示反解失败。
  • 查询其它模型、其它主账号或已删除的 World 均返回 403001,不会泄漏资源是否存在。

错误码

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

下一步