文档

CreateCustomizedStory - 创建自定义故事

更新时间:

创建自定义故事。 区别于推荐故事,自定义故事下面的文件列表由用户指定。

接口说明

请确保在使用该接口前,已充分了解 PDS 的收费方式和价格

使用此功能须开通增值服务图片处理功能。故事相关接口限时免费。

用户通过传入指定文件列表创建自定义故事。其中故事类型和故事子类型用户可自定义,不再有约束。

注意 通过该接口指定故事封面时,该封面文件必须存在于故事列表中,否则会返回错误。
注意 自定义故事列表中的文件类型只能为图片。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

POST /v2/image/create_customized_story

请求参数

名称类型必填描述示例值
bodyobject

请求体

drive_idstring

空间 id

1
story_typestring

故事类型。由用户自定义。

user_created
story_sub_typestring

故事子类型。由用户自定义。

user_created
story_namestring

故事名称。 长度不能超过 1024 字节。

test_name
story_coverobject

故事封面。该封面必须在故事文件列表中。

file_idstring

文件 id

63e5e4340f76cb3ead5f40f68163f0f967c1a7bf
revision_idstring

文件版本 id

642a88d4aff041ee68fd4fc89beb80e1119da343
story_filesobject []

故事文件列表

file_idstring

文件 id

63e5e4340f76cb3ead5f40f68163f0f967c1a7bf
revision_idstring

文件版本 id

642a88d4aff041ee68fd4fc89beb80e1119da343
custom_labelsobject

自定义标签。 标签数量不能超过 20 个。

string

自定义标签

label_value

返回参数

名称类型描述示例值
object

返回参数

drive_idstring

空间 id

1
story_idstring

故事 id

9132e0d8-fe92-4e56-86c3-f5f112308003

示例

正常返回示例

JSON格式

{
  "drive_id": "1",
  "story_id": "9132e0d8-fe92-4e56-86c3-f5f112308003"
}

错误码

访问错误中心查看更多错误码。