You need to enable JavaScript to run this app.
导航
智能创作云-作品拉取OpenAPI
最近更新时间:2024.07.30 20:47:24首次发布时间:2024.07.30 20:47:24
版本变更记录
版本修改时间变更内容备注
v1.02022-11-01初始化文档
V1.12023-04-111. GetMediaList接口新增可选入参ProductType
公共字段
  1. 请求Host:https://icp.volcengineapi.com

  2. 请求Header

描述:http请求中header需增加的字段

参数名参数类型是否必填描述
X-DateString使用UTC时间,精确到秒。请使用格式:YYYYMMDD'T'HHMMSS'Z' ,例如:20201103T104027Z

Authorization

String

HMAC-SHA256 Credential={AccessKeyId}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature}

  • 签名完整过程详见:签名示例

  • Java版签名Demo详见如下附件

    暂时无法在飞书文档外展示此内容

Content-TypeStringMIME类型,固定值: application/json

X-Content-Sha256

String

对完整请求Body的加密结果,HexEncode(Hash(RequestPayload))

HexEncodeHexEncode代指转16进制编码
Hash代指SHA256算法
RequestPayload代指完整的请求的body。

Authorization中的信息含义:

名称类型备注

AccessKeyId

String

请求的AccessKey。

  • AK/SK获取说明

    • 说明:在调用火山引擎视觉智能控制台的各个能力之前,确保您已生成访问密钥(AccessKey)。AccessKey包括AccessKeyID(AK)和AccessKeySecret(SK),其中AccessKeyID用于标识用户,AccessKeySecret是用来验证用户的密钥,请妥善保管。

    • 获取方式:点击右上角账号,下拉列表选择【密钥管理】,点击【新建密钥】按钮,可获取AK/SK,可以此为凭证调用上述已接入应用的接口。

    注:安全起见,建议新建子账户,并使用子账户的AK/SK

ShortDateString请求的短时间,使用UTC时间,精确到日。请使用格式:YYYYMMDD,例如:20221101
RegionString请求的地域,固定值: cn-north-1
ServiceString请求的服务,固定值: iccloud_muse
SignedHeadersString参与签名的Header,用分号分隔。
SignatureString计算完毕的签名。

HTTP接口详情
  1. ListUsers 获取用户列表

描述: 获取当前可用用户列表
请求方式: POST
Host: https://icp.volcengineapi.com
请求参数:

参数名类型是否必填描述
QueryActionString接口名称,值:ListUsers
VersionString接口版本,值:2022-02-01
HeaderServiceStringic_iam
RegionStringcn-north-1
AuthorizationString签名密钥,签名方法参考:https://www.volcengine.com/docs/6369/67269

X-Date

String

使用UTC时间,精确到秒。请使用格式:YYYYMMDD'T'HHMMSS'Z' ,例如:20201103T104027Z

Content-TypeStringapplication/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)        ]
    }
}
  1. GetMediaList

描述: 获取用户、团队空间媒资列表。返回媒资信息,通常用于系统内的作品列表展示等场景。目前只支持成片导出。
请求方式: POST
Host: https://icp.volcengineapi.com
请求参数:

参数参数类型参数位置是否必填描述
ActionStringQueryGetMediaList
VersionStringQuery2022-02-01
ProductTypeIntQuery1 是创作云,2 是资源运营平台,默认为 1
OwnerOwnerBody创作云用户
TeamSpaceNameStringBody团队空间 名称,默认为 "默认团队",如果带了就表示查询团队的作品。团队空间不存在会报错
MediaTypeIntBody1 是素材,2 是草稿,3 是成片。目前只支持成片,固定填 3
PageNumIntBody第 n 页,从 0 开始,PageNum >= 0
PageSizeIntBody页返回数量, 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)
    }
}

  1. GetMediaInfo

描述: 根据 MediaId 获取媒资详情,目前只支持查询成片详情。
请求方式: POST
Host: https://icp.volcengineapi.com
请求参数:

参数类型参数类型是否必填描述
ActionStringQueryGetMediaInfo
VersionStringQuery2022-02-01
MediaIds[]StringBody媒资ID列表
ArticleContentFormatStringBody图文作品内容的格式,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) // 媒资详情
        ]
    }
}
数据结构

User

用户

名称类型必选描述
IdInteger用户 Id

IsAdmin

bool

是否为 admin 主账号,主账号具有更改企业配置等管理员记权限。不是 admin 主账号,即为子账号,子账号仅有使用智能创作云业务功能的权限。

Permitted

bool

是否授权子账号使用智创云,如果没有获得授权,则无法通过智创云 OpenAPI 获得跳转智创云的链接。主账号默认是有授权的,无法取消。在客户套餐内创建的子账号,都是有授权的,超出套餐创建的子账号无授权。可以使用主账号在企业配置-子账号管理调整子账号的授权。

VolcUserName

String

用户在火山侧的账号名,如果有会返回

VolcUserIdString用户在火山侧的账号 id,如果有会返回
DisplayNamestring用户显示名。
Descriptionstring用户备注。
TeamInfosTeamInfo所属团队信息
RoleInfosRoleInfo所属角色信息

TeamInfo

参数类型必选备注
IdString团队id
NameString团队名字

RoleInfo

参数类型必选备注
IdString角色id
NameString角色名字

Owner

描述媒资归属的实体

名称类型必选描述

Type

String

类型,取值有:

  • PERSON:个人
IdIntId,当 Type=PERSON,取值为用户 Id,和 VolcUsername 二选一
VolcUsernameString火山用户名,和 Id 二选一

PageInfo

分页信息,用于分页查询

名称类型必选描述
PageNumInt当前页数,从 0 开始
PageSizeInt一页返回数量
TotalNumInt数据总数
TotalPageInt总共多少页

MediaInfo

名称类型描述
BasicInfoMediaBasicInfo媒资基本信息
VideoMediaVideoDetailInfo视频媒资信息,此字段可能返回 null,表示取不到有效值。
ArticleMediaArticleDetailInfo文章媒资信息,此字段可能返回 null,表示取不到有效值。
ImageMediaImageDetailInfo图片媒资信息,此字段可能返回 null,表示取不到有效值。
AudioMediaAudioDetailInfo音频媒资信息,此字段可能返回 null,表示取不到有效值。

MediaBasicInfo

名称类型描述
MediaIdString媒资 Id
MediaTypeString媒资类型,取值 material: 素材;draft: 草稿;film: 成片;template: 模板
MediaFirstCategoryString媒资分类,取值 video/image/audio/article 等
SourceFromString含义详见:SourceFrom
DescriptionString描述
OwnerOwner媒资归属实体
NameString媒资名称
CreateTimeInt媒资创建时间,Unix 时间戳
UpdateTimeInt媒资更新时间,Unix 时间戳
Tags[]String媒资标签
UserDefinedCategory[]String用户自定义分类
CopyrightString版权类型
PreviewUrlstring预览图

ArticleDetailInfo

文章详情

名称类型描述
JsonContentString文章内容,格式:JSON
HtmlContentString文章内容,格式:HTML
AbstractString文章摘要
WordCountInt文章字数

Covers

Array of ArticleAssetInfo

封面组

Videos

Array of
ArticleAssetInfo

视频组

Images

Array of
ArticleAssetInfo

图片组

ArticleAssetInfo

名称类型描述
MediaIdString视频 id
DownloadUrlString原始分辨率下载链接,可以直接访问/浏览器下载的地址, 有效期24小时

TranscodeDownloadUrls

map[string]string

下载链接 map,可以直接访问/浏览器下载的地址, 有效期24小时;key 为分辨率,value 为链接


ImageDetailInfo

图片媒资详情

名称类型描述
MediaIdString图片媒资 id
HeightInt图片高度,单位:px
WidthInt图片宽度,单位:px

DownloadUrl

String

图片原始分辨率下载链接,可以直接访问/浏览器下载的地址, 有效期24小时

TranscodeDownloadUrls

Dict

下载链接 map,可以直接访问/浏览器下载的地址, 有效期24小时;key 为分辨率,value 为链接

SizeInt图片大小,单位:字节

AudioDetailInfo

名称类型描述
DownloadUrlString可以直接访问/浏览器下载的地址, 有效期24小时
CoverUrlstring封面url
MediaMetaInfoMediaMetaInfo媒资元信息

VideoDetailInfo

视频详情

名称类型必选描述
VideoIdString视频 Id,同媒资 Id
NameString视频名称
OwnerOwner媒资归属实体
CreateTimeInt媒资创建时间
UpdateTimeInt媒资更新时间
DownloadUrlString可以直接访问/浏览器下载的地址, 有效期24小时

TranscodeDownloadUrls

map[string]string

下载链接 map,可以直接访问/浏览器下载的地址, 有效期24小时;key 为分辨率,value 为链接

LayoutInt布局,0 表示未设置,1 表示横屏,2 表示竖屏
ResolutionString分辨率
CoverUrlstring封面url
PreviewVideoString预览视频
SecondaryEditedBool是否被二次编辑过
MediaMetaInfoMediaMetaInfo媒资元信息

MediaMetaInfo

媒资元信息

名称类型描述
SizeInt文件大小,单位 byte
Md5String文件的 Md5
HeightInt高度,单位:px
WidthInt宽度,单位:px
DurationInt时长,单位:秒
BitrateInt视频码率,单位:bps
MimeString文件Mime,如image/jpeg、video/mp4
VideoStreamInfoSetArray of VideoStreamInfo视频流信息
AudioStreamInfoSetArray of AudioStreamInfo音频流信息

VideoStreamInfo

视频流信息

名称类型描述
BitrateFloat视频码率,单位:bps
HeightInt高度,单位:px
WidthInt宽度,单位:px
CodecString编码格式,eg. h264, h265_hvc1
SizeInt文件大小,单位 byte
Md5String文件的 Md5
FpsInt帧率,单位:hz

AudioStreamInfo

音频流信息

名称类型描述
BitrateFloat视频码率,单位:bps
CodecString编码格式
SizeInt文件大小,单位 byte
Md5String文件的 Md5

SourceFrom

作品来源场景

{
    "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":"视频混剪"
}

错误码
CodeDomain错误说明
400req参数错误
500open_api内部错误
700open_api获取授权错误
701open_api用户不属于该客户
707open_apiRPC调用失败
804open_api用户不存在
805open_api团队空间不存在或用户不属于该团队空间
806open_api没有权限调用该接口