版本 | 修改时间 | 变更内容 | 备注 |
---|---|---|---|
v1.0 | 2022-11-01 | 初始化文档 | |
V1.1 | 2023-04-11 | 1. GetMediaList接口新增可选入参ProductType |
描述:http请求中header需增加的字段
参数名 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
X-Date | String | 是 | 使用UTC时间,精确到秒。请使用格式:YYYYMMDD'T'HHMMSS'Z' ,例如:20201103T104027Z |
Authorization | String | 是 |
|
Content-Type | String | 是 | MIME类型,固定值: application/json |
X-Content-Sha256 | String | 否 | 对完整请求Body的加密结果,
|
Authorization中的信息含义:
名称 | 类型 | 备注 |
---|---|---|
AccessKeyId | String | 请求的AccessKey。
|
ShortDate | String | 请求的短时间,使用UTC时间,精确到日。请使用格式:YYYYMMDD,例如:20221101 |
Region | String | 请求的地域,固定值: cn-north-1 |
Service | String | 请求的服务,固定值: iccloud_muse |
SignedHeaders | String | 参与签名的Header,用分号分隔。 |
Signature | String | 计算完毕的签名。 |
描述: 获取当前可用用户列表
请求方式: POST
Host: https://icp.volcengineapi.com
请求参数:
参数名 | 类型 | 是否必填 | 描述 | |
---|---|---|---|---|
Query | Action | String | 是 | 接口名称,值:ListUsers |
Version | String | 是 | 接口版本,值:2022-02-01 | |
Header | Service | String | 是 | ic_iam |
Region | String | 是 | cn-north-1 | |
Authorization | String | 是 | 签名密钥,签名方法参考:https://www.volcengine.com/docs/6369/67269 | |
X-Date | String | 是 | 使用UTC时间,精确到秒。请使用格式: | |
Content-Type | String | 是 | application/json | |
Body | UserType | String | 是 | All 所有,Idle 空闲,Busy 繁忙 |
请求Body示例:
{ "UserType": "All" // All 所有,Idle 空闲,Busy 繁忙 }
成功响应:
{ "ResponseMetadata": { "RequestId": "20211213140257010225133143062CC07B", "Action": "ListUsers", "Version": "2022-02-01", "Service": "ic_iam", "Region": "cn-north-1", "Code":0 }, "Result": { "UIDs": [1,2], "Users": [ [User](https://bytedance.larkoffice.com/docx/DL9adQw2MoMUkRxSafPcKgLnnMb#CKMvdAW3WoXjO1xlRfHcUoAOnFd) [](https://bytedance.feishu.cn/docs/doccnjFtZ2tpXgezIfSLc9UDhYg#SlL2jU) ] } }
描述: 获取用户、团队空间媒资列表。返回媒资信息,通常用于系统内的作品列表展示等场景。目前只支持成片导出。
请求方式: POST
Host: https://icp.volcengineapi.com
请求参数:
参数 | 参数类型 | 参数位置 | 是否必填 | 描述 |
---|---|---|---|---|
Action | String | Query | 是 | GetMediaList |
Version | String | Query | 是 | 2022-02-01 |
ProductType | Int | Query | 否 | 1 是创作云,2 是资源运营平台,默认为 1 |
Owner | Owner | Body | 是 | 创作云用户 |
TeamSpaceName | String | Body | 否 | 团队空间 名称,默认为 "默认团队",如果带了就表示查询团队的作品。团队空间不存在会报错 |
MediaType | Int | Body | 是 | 1 是素材,2 是草稿,3 是成片。目前只支持成片,固定填 3 |
PageNum | Int | Body | 否 | 第 n 页,从 0 开始,PageNum >= 0 |
PageSize | Int | Body | 否 | 页返回数量, PageSize >= 1, 默认为 10,最大支持 20 |
请求Body示例:
{ "Owner": [Owner](https://bytedance.feishu.cn/wiki/wikcnQ9GLoxPndqYYHytv2jefse#Gcc0de8k2oAa8OxCSBvcDqvGnbe), // 创作云用户,必填 "TeamSpaceName": "默认团队", // 团队空间 名称,选填,如果带了就表示查询团队的作品,如果团队空间不存在会报错 "MediaType": 3, // 1是素材,2是草稿,3是成片,目前只支持成片,必填 "PageNum": 0, // 第 n 页,从 0 开始,PageNum >= 0,选填 "PageSize": 10 // 一页返回数量, PageSize >= 1, 默认为 10,最大支持 20, 选填 }
成功响应:
{ "ResponseMetadata": { "RequestId": "202211011545520101351620561D18688A", "Action": "GetMediaList", "Version": "2022-02-01", "Service": "iccloud_muse_staging", "Region": "cn-north-1", "Code": 0 }, "Result": { "MediaInfos": [ [MediaInfo](https://bytedance.feishu.cn/wiki/wikcnQ9GLoxPndqYYHytv2jefse#DUUod4KyeoOagWxYpLWcD3zSngd) ], "PageInfo": [PageInfo](https://bytedance.feishu.cn/wiki/wikcnQ9GLoxPndqYYHytv2jefse#G2cEdE66Yoke8axoLbJczOuznVf) } }
描述: 根据 MediaId 获取媒资详情,目前只支持查询成片详情。
请求方式: POST
Host: https://icp.volcengineapi.com
请求参数:
参数 | 类型 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|---|
Action | String | Query | 是 | GetMediaInfo |
Version | String | Query | 是 | 2022-02-01 |
MediaIds | []String | Body | 是 | 媒资ID列表 |
ArticleContentFormat | String | Body | 否 | 图文作品内容的格式,json或html,不传或传空则默认 json |
请求Body示例:
{ "MediaIds":[ // 必填,来自作品成片回调通知 "xxx" ], "ArticleContentFormat":"json" // 选填,图文作品内容的格式,json或html,不传或传空则默认 json }
成功响应:
{ "ResponseMetadata": { "RequestId": "20211213140257010225133143062CC07B", "Action": "GetMediaInfo", "Version": "2022-02-01", "Service": "iccloud_muse", "Region": "cn-north-1", "Code":0 }, "Result": { "MediaInfos": [ [MediaInfo](https://bytedance.feishu.cn/wiki/wikcnQ9GLoxPndqYYHytv2jefse#DUUod4KyeoOagWxYpLWcD3zSngd) // 媒资详情 ] } }
用户
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Id | Integer | 是 | 用户 Id |
IsAdmin | bool | 是 | 是否为 admin 主账号,主账号具有更改企业配置等管理员记权限。不是 admin 主账号,即为子账号,子账号仅有使用智能创作云业务功能的权限。 |
Permitted | bool | 是 | 是否授权子账号使用智创云,如果没有获得授权,则无法通过智创云 OpenAPI 获得跳转智创云的链接。主账号默认是有授权的,无法取消。在客户套餐内创建的子账号,都是有授权的,超出套餐创建的子账号无授权。可以使用主账号在企业配置-子账号管理调整子账号的授权。 |
VolcUserName | String | 否 | 用户在火山侧的账号名,如果有会返回 |
VolcUserId | String | 否 | 用户在火山侧的账号 id,如果有会返回 |
DisplayName | string | 否 | 用户显示名。 |
Description | string | 否 | 用户备注。 |
TeamInfos | TeamInfo | 是 | 所属团队信息 |
RoleInfos | RoleInfo | 是 | 所属角色信息 |
参数 | 类型 | 必选 | 备注 |
---|---|---|---|
Id | String | 是 | 团队id |
Name | String | 是 | 团队名字 |
参数 | 类型 | 必选 | 备注 |
---|---|---|---|
Id | String | 是 | 角色id |
Name | String | 是 | 角色名字 |
描述媒资归属的实体
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Type | String | 是 | 类型,取值有:
|
Id | Int | 否 | Id,当 Type=PERSON,取值为用户 Id,和 VolcUsername 二选一 |
VolcUsername | String | 否 | 火山用户名,和 Id 二选一 |
分页信息,用于分页查询
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
PageNum | Int | 是 | 当前页数,从 0 开始 |
PageSize | Int | 是 | 一页返回数量 |
TotalNum | Int | 是 | 数据总数 |
TotalPage | Int | 是 | 总共多少页 |
名称 | 类型 | 描述 |
---|---|---|
BasicInfo | MediaBasicInfo | 媒资基本信息 |
VideoMedia | VideoDetailInfo | 视频媒资信息,此字段可能返回 null,表示取不到有效值。 |
ArticleMedia | ArticleDetailInfo | 文章媒资信息,此字段可能返回 null,表示取不到有效值。 |
ImageMedia | ImageDetailInfo | 图片媒资信息,此字段可能返回 null,表示取不到有效值。 |
AudioMedia | AudioDetailInfo | 音频媒资信息,此字段可能返回 null,表示取不到有效值。 |
名称 | 类型 | 描述 |
---|---|---|
MediaId | String | 媒资 Id |
MediaType | String | 媒资类型,取值 material: 素材;draft: 草稿;film: 成片;template: 模板 |
MediaFirstCategory | String | 媒资分类,取值 video/image/audio/article 等 |
SourceFrom | String | 含义详见:SourceFrom |
Description | String | 描述 |
Owner | Owner | 媒资归属实体 |
Name | String | 媒资名称 |
CreateTime | Int | 媒资创建时间,Unix 时间戳 |
UpdateTime | Int | 媒资更新时间,Unix 时间戳 |
Tags | []String | 媒资标签 |
UserDefinedCategory | []String | 用户自定义分类 |
Copyright | String | 版权类型 |
PreviewUrl | string | 预览图 |
文章详情
名称 | 类型 | 描述 |
---|---|---|
JsonContent | String | 文章内容,格式:JSON |
HtmlContent | String | 文章内容,格式:HTML |
Abstract | String | 文章摘要 |
WordCount | Int | 文章字数 |
Covers | Array of ArticleAssetInfo | 封面组 |
Videos | Array of | 视频组 |
Images | Array of | 图片组 |
名称 | 类型 | 描述 |
---|---|---|
MediaId | String | 视频 id |
DownloadUrl | String | 原始分辨率下载链接,可以直接访问/浏览器下载的地址, 有效期24小时 |
TranscodeDownloadUrls | map[string]string | 下载链接 map,可以直接访问/浏览器下载的地址, 有效期24小时;key 为分辨率,value 为链接 |
图片媒资详情
名称 | 类型 | 描述 |
---|---|---|
MediaId | String | 图片媒资 id |
Height | Int | 图片高度,单位:px |
Width | Int | 图片宽度,单位:px |
DownloadUrl | String | 图片原始分辨率下载链接,可以直接访问/浏览器下载的地址, 有效期24小时 |
TranscodeDownloadUrls | Dict | 下载链接 map,可以直接访问/浏览器下载的地址, 有效期24小时;key 为分辨率,value 为链接 |
Size | Int | 图片大小,单位:字节 |
名称 | 类型 | 描述 |
---|---|---|
DownloadUrl | String | 可以直接访问/浏览器下载的地址, 有效期24小时 |
CoverUrl | string | 封面url |
MediaMetaInfo | MediaMetaInfo | 媒资元信息 |
视频详情
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
VideoId | String | 是 | 视频 Id,同媒资 Id |
Name | String | 是 | 视频名称 |
Owner | Owner | 是 | 媒资归属实体 |
CreateTime | Int | 是 | 媒资创建时间 |
UpdateTime | Int | 是 | 媒资更新时间 |
DownloadUrl | String | 是 | 可以直接访问/浏览器下载的地址, 有效期24小时 |
TranscodeDownloadUrls | map[string]string | 是 | 下载链接 map,可以直接访问/浏览器下载的地址, 有效期24小时;key 为分辨率,value 为链接 |
Layout | Int | 否 | 布局,0 表示未设置,1 表示横屏,2 表示竖屏 |
Resolution | String | 否 | 分辨率 |
CoverUrl | string | 是 | 封面url |
PreviewVideo | String | 否 | 预览视频 |
SecondaryEdited | Bool | 是 | 是否被二次编辑过 |
MediaMetaInfo | MediaMetaInfo | 是 | 媒资元信息 |
媒资元信息
名称 | 类型 | 描述 |
---|---|---|
Size | Int | 文件大小,单位 byte |
Md5 | String | 文件的 Md5 |
Height | Int | 高度,单位:px |
Width | Int | 宽度,单位:px |
Duration | Int | 时长,单位:秒 |
Bitrate | Int | 视频码率,单位:bps |
Mime | String | 文件Mime,如image/jpeg、video/mp4 |
VideoStreamInfoSet | Array of VideoStreamInfo | 视频流信息 |
AudioStreamInfoSet | Array of AudioStreamInfo | 音频流信息 |
视频流信息
名称 | 类型 | 描述 |
---|---|---|
Bitrate | Float | 视频码率,单位:bps |
Height | Int | 高度,单位:px |
Width | Int | 宽度,单位:px |
Codec | String | 编码格式,eg. h264, h265_hvc1 |
Size | Int | 文件大小,单位 byte |
Md5 | String | 文件的 Md5 |
Fps | Int | 帧率,单位:hz |
音频流信息
名称 | 类型 | 描述 |
---|---|---|
Bitrate | Float | 视频码率,单位:bps |
Codec | String | 编码格式 |
Size | Int | 文件大小,单位 byte |
Md5 | String | 文件的 Md5 |
作品来源场景
{ "MaterialLibrary":"素材库", "text2video":"图文转视频", "Text2Video":"图文转视频", "Default":"默认", "Editor":"编辑器", "editor":"编辑器", "miaoying-editor":"秒影编辑器", "api_process":"接口上传", "muse":"", "VTuberLive":"", "video_recreation":"视频拆条素材、草稿、成片", "VideoSegment":"视频拆条素材-算法上传", "template_consume":"模板解析", "template":"模板消费", "openapi":"open api", "download_film":"成片版权素材下载", "hera_android":"模板生产工具-安卓", "hera_ios":"模板生产工具-IOS", "add-logo":"添加水印成片", "video_delogo":"视频去水印素材、成片", "BrandManager":"", "winter_olympic":"冬奥素材", "super_resolution":"超分辨率草稿、成片", "smart-crop":"智能裁剪", "movie_studio":"智能照片电影成片", "copyrighted_media":"正版素材库", "templator_ios":"ck模板生产工具-iOS-V2", "templator_android":"ck模板生产工具-android-V2", "template_material_loki":"loki-资源effect", "graphic_editor":"图文编辑器", "FilmLibrary":"直接上传作品", "effect_mall":"商城数据", "effect_mall_encrypt":"商城加密数据", "open_api":"通过openAPI上传的素材", "chart-video":"图表转成的视频", "card_template":"卡片模板编辑器", "template_rec":"模板推荐", "tts":"智能配音", "video_cut":"视频拆条", "video_mixed":"视频混剪" }
Code | Domain | 错误说明 |
---|---|---|
400 | req | 参数错误 |
500 | open_api | 内部错误 |
700 | open_api | 获取授权错误 |
701 | open_api | 用户不属于该客户 |
707 | open_api | RPC调用失败 |
804 | open_api | 用户不存在 |
805 | open_api | 团队空间不存在或用户不属于该团队空间 |
806 | open_api | 没有权限调用该接口 |