查询已完成 Directing Travel 的录制原片和三个合成变体。原片可用是返回产物响应的前提;对外交付推荐使用 withInstructionAndWatermark。
适用范围
查询已完成 Directing Travel 的录制原片及三个合成版本。原片可用是返回产物响应的前提;合成版本可以仍在处理中。对外交付推荐使用 withInstructionAndWatermark。调用前请确认以下事项:
-
鉴权要求:仅支持主 API Key调用,临时 API Key 不可用(错误码
403003)。- 获取主 API Key:获取与配置 API Key。
-
前置条件:Travel 状态为
completed。原片可用是返回产物响应的前提。可通过查询Travel状态接口确认。 - 调用方:您的服务端调用。
HTTP调用
- 新加坡
- 美国(弗吉尼亚)
GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels/artifacts调用时请将{WorkspaceId}替换为真实的Workspace ID。请求参数 |
|
Authorization string (必选)API Key 鉴权。仅支持主 API Key,以 sk- 开头,如 sk-xxx。通常配置为环境变量 $DASHSCOPE_API_KEY。临时 API Key(st- 开头)调用返回 403003。 | |
Query 参数 | |
encryptedTravelId string (必选)状态为 completed 的 Directing 加密 Travel ID。由客户端进入房间接口返回。 |
响应参数 |
|
code integer返回码。0 表示成功,非 0 为错误码。 | |
message string错误信息。成功时为 null。 | |
data object响应数据。失败时为 null。
属性 encryptedTravelId string加密 Travel ID。composeStatus string三个合成变体的聚合状态:
original。video object四类主线视频产物,字段结构固定。每项含 url、status、resolution、durationSec。
string视频 URL;status=processing 时为 null。video.*.status string单项状态:
string原片命中 720p 时 video.original.resolution 为 "720p";其它情况为 null。video.*.durationSec integer统一解析得到的视频时长秒数;可解析时所有 ready 变体均填写该值,processing / unavailable 或时长暂不可解析时可为 null。 |
前置状态与调用注意事项
- 需要全部合成版本时,可在
composeStatus != ready时继续轮询。 video.withInstructionAndWatermark是推荐的对外交付版本。- 四个视频变体共用同一时长解析结果,因此同一次响应中已就绪且时长可解析的变体会返回一致的
durationSec。 - 不要将
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 不存在、不归属或不是 Directing | 返回业务码 404000 |
| 原片 URL 不可用 | 返回业务码 404000;原片是整个接口的硬门槛 |
| 原片已就绪、合成仍在处理 | HTTP 200;对应合成条目 status=processing、url=null |
| 合成失败或 URL 暂不可用 | HTTP 200;对应合成条目 status=unavailable、url=null |
错误码
如果模型调用失败并返回报错信息,请参见HappyOyster 错误码进行解决。
下一步
- 查询Travel列表:查看其它历史 Travel。
- 结束Travel:结束新的 Travel 后再来查询产物。