AI 助理
文档备案控制台
官方文档
首页 大模型服务平台百炼 API参考（模型） 世界模型 HappyOyster Directing Open API参考 Directing-获取体验凭证

HappyOyster-Directing-获取体验凭证 API参考

更新时间：
复制 MD 格式
产品详情
我的收藏

三方服务端使用主 API Key 换取短时效、一次性的 ticket，再将其安全下发给客户端。此接口只校验 World 归属、状态与规格，不创建 Travel。

适用范围

三方服务端使用主 API Key 换取短时效、一次性的 ticket，再将其安全下发给客户端。调用前请确认以下事项：

  • 鉴权要求：仅支持主 API Key调用，临时 API Key 不可用（错误码 403003）。

  • 前置条件：World 必须属于当前主账号和 Directing 模型，且状态为 ready。可通过查询World构建状态接口确认。

  • 调用方：您的服务端调用，换得的 ticket 应只下发给准备立即进房的客户端。

HTTP调用

新加坡

POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/worlds/get-travel-credential

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

美国（弗吉尼亚）

POST https://{WorkspaceId}.us-east-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/worlds/get-travel-credential

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

请求参数 

curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/worlds/get-travel-credential' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
    -H 'Content-Type: application/json' \
    -d '{
    "encryptedWorldId": "{encryptedWorldId}"
}'

Content-Typestring（必选）

请求内容类型。此参数必须设置为application/json。

Authorization string （必选）

API Key 鉴权。仅支持主 API Key，以 sk- 开头，如 sk-xxx。通常配置为环境变量 $DASHSCOPE_API_KEY。临时 API Key（st- 开头）调用返回 403003。

请求体（Request Body）

encryptedWorldId string （必选）

当前主账号名下、状态为 ready 的 Directing World ID。由创建World接口返回。

响应参数 

{
    "code": 0,
    "message": null,
    "data": {
        "ticket": "tk_a1b2****",
        "expiresIn": 1800,
        "encryptedWorldId": "enc_a1b2****"
    }
}

code integer

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

message string

错误信息。成功时为 null。

data object

响应数据。失败时为 null。

属性

ticket string

前缀为 tk_ 的一次性 Travel 凭证。有效期 1800 秒（30 分钟），且只能成功使用一次。

expiresIn integer

有效期秒数，固定为 1800，即 30 分钟。

encryptedWorldId string

凭证对应的加密 World ID。

前置状态与调用注意事项

  • World 必须为 ready。
  • ticket 有效期为 30 分钟且只能成功使用一次；过期或已使用后须重新换取。
  • ticket 应只下发给准备立即进房的客户端，不应持久化为长期访问凭证。
  • 调用本接口不会创建 Travel；Travel 在进入房间成功时创建。
  • 未购买该 World 对应规格时返回 403007；容量配置暂不可用时返回 403008。

错误码

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

下一步

换取 ticket 后：

上一篇：Directing-查询World构建状态下一篇：Directing-客户端进入房间