Skip to main content

HappyOyster-Directing-查询World构建状态 API参考

查询 Directing World 的构建进度。接口返回加密 World ID、构建状态和首帧 URL,客户端轮询直至 World 进入 ready。

适用范围

查询 Directing World 的构建进度。调用前请确认以下事项:
  • 鉴权要求:不强制主 API Key,主 API Key 或临时 API Key 均可调用。获取方式请参见获取鉴权凭证。
  • 前置条件:使用创建World接口返回的 encryptedWorldId 查询。可从 generating 状态开始查询。
  • 调用方:您的服务端或客户端均可调用。

HTTP调用

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

请求参数

  • 查询World构建状态
curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/worlds/build-status?encryptedWorldId={encryptedWorldId}' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY"
Authorization string (必选)API Key 鉴权。不强制主 API Key,主 API Key 或临时 API Key 均可调用。
  • 主 API Key:以 sk- 开头,如 sk-xxx。
  • 临时 API Key:以 st- 开头,如 st-xxx。
Query 参数
encryptedWorldId string (必选)创建World接口返回的 Directing 加密 World ID。

响应参数

  • 构建中
  • 构建完成
{
    "code": 0,
    "message": null,
    "data": {
        "encryptedWorldId": "enc_a1b2****",
        "status": "generating",
        "firstFrame": null
    }
}
code integer返回码。0 表示成功,非 0 为错误码。
message string错误信息。成功时为 null。
data object响应数据。失败时为 null。

属性

encryptedWorldId string加密 World ID。status string构建状态:generating / ready / failed。firstFrame stringWorld 首帧 URL;尚未生成或构建失败时为 null。name stringWorld 名称。仅 status=ready 时返回。mode integerDirecting 恒为 2。仅 status=ready 时返回。

前置状态与调用注意事项

  • 建议每 3–5 秒轮询,直到 status 为 ready 或 failed。
  • 只有 ready 的 World 才能换取体验凭证并进入房间。
  • URL 图片在异步转存后校验失败时,World 可能从 generating 进入 failed。
  • 本接口不返回 aspectRatio。

错误码

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

下一步

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