查询已完成 Acting Travel 的录制原片和三个合成变体。对外交付推荐使用 withInstructionAndWatermark。
适用范围
查询已完成 Acting Travel 的录制原片和三个合成变体。withInstruction 是用户过程指令的叠加版本;对外交付推荐使用 withInstructionAndWatermark。调用前请确认以下事项:
-
鉴权要求:仅支持主 API Key调用,临时 API Key 不可用(错误码
403003)。- 获取主 API Key:获取与配置 API Key。
-
前置条件:Travel 状态为
completed。原片 URL 可用是返回产物响应的前提。可通过查询Travel状态接口确认。 -
调用方:您的服务端调用。
HTTP调用
新加坡
GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/travels/artifacts
调用时请将{WorkspaceId}替换为真实的Workspace ID。
美国(弗吉尼亚)
GET https://{WorkspaceId}.us-east-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/travels/artifacts
调用时请将{WorkspaceId}替换为真实的Workspace ID。
请求参数 | 查询Travel产物 |
Authorization API Key 鉴权。仅支持主 API Key,以 | |
Query 参数 | |
encryptedTravelId 状态为 |
响应参数 | 四路产物全部就绪合成仍在处理 |
code 返回码。 | |
message 错误信息。成功时为 | |
data 响应数据。失败时为 |
前置状态与调用注意事项
- 客户端可在
composeStatus != ready时按受控间隔轮询。 video.withInstruction是过程指令叠加版,不是无指令原片。- 对外交付推荐读取
video.withInstructionAndWatermark;如业务只需要原片,可继续读取video.original.url。 - 四个视频变体共用同一时长解析结果,因此同一次响应中已就绪且时长可解析的变体会返回一致的
durationSec。 - 使用
TRAVEL_NO_STREAM_AUTO_END结束的 Travel 为failed,不会生成可查询产物。 - 收到
404000时不要一律展示为「尚未完成」:请先通过查询Travel状态或查询Travel列表读取status与errorCode,failed的 Travel 应展示失败原因。
404000 场景
| 场景 | 接口行为 |
|---|---|
Travel 仍在进行中(init / pending / running / paused) | 返回业务码 404000,message 为 Video is still being generated, please try again once the process is complete |
Travel 已 failed | 返回业务码 404000,message 为 Experience failed and no video was produced (errorCode=<errorCode>): <errorMessage>;失败为终态,不会再有成片 |
| Travel 不存在、不归属或不是 Acting | 返回业务码 404000 |
| 原片 URL 不可用 | 返回业务码 404000;原片是整个接口的硬门槛 |
| 原片已就绪、合成仍在处理 | HTTP 200;对应合成项 status=processing、url=null |
| 合成失败或 URL 暂不可用 | HTTP 200;对应合成项 status=unavailable、url=null |
错误码
如果模型调用失败并返回报错信息,请参见HappyOyster 错误码进行解决。
下一步
- 查询Travel列表:查看其它历史 Travel。
- 结束Travel:结束新的 Travel 后再来查询产物。