POST/api/ark
多个素材和 CV Action 共用该路径,请求体结构由 Action 和 Version 决定。
ℹ️当前没有公开可发现模型 当前模型列表和模型广场没有提供适用于此接口的公开调用名,本页仅用于核对 OpenAPI 契约,不能作为可独立执行示例。请勿猜测模型名称;待模型广场发布对应模型后,再使用模型详情中的调用名接入。
🔑Volcengine V4 签名请求使用平台签发的 AK/SK 计算 HMAC-SHA256 V4 签名。
请求结构
下方内容用于确认方法、地址和鉴权方式,属于 HTTP 结构片段,不是可独立执行示例。
POST https://silvamux.io/api/ark
Authorization: HMAC-SHA256 Credential=<AK>/...
Content-Type: application/json
请求参数
| 参数 | 类型与位置 | 必填 | 说明 |
|---|
Action | string (CreateAssetGroup | GetAssetGroup | ListAssetGroups | UpdateAssetGroup | DeleteAssetGroup | CreateAsset | GetAsset | ListAssets | UpdateAsset | DeleteAsset | CVProcess | CVSubmitTask | CVGetResult) · query | 是 | — |
Version | string (2024-01-01 | 2022-08-31) · query | 否 | 火山协议版本。素材操作使用 2024-01-01,CV 操作使用 2022-08-31;当前 handler 不强制校验该参数。 |
请求体
application/json · CreateAssetGroup | GetAssetGroup / DeleteAssetGroup | ListAssetGroups | UpdateAssetGroup | CreateAsset | GetAsset / DeleteAsset | ListAssets | UpdateAsset | CVSubmitTask / CVProcess / CVGetResult · 必填
CreateAssetGroup
| 字段 | 类型 | 必填 | 说明 |
|---|
Description | string | 否 | — |
GroupType | string (AIGC) | 否 | — |
Name | string | 是 | — |
GetAssetGroup / DeleteAssetGroup
ListAssetGroups
| 字段 | 类型 | 必填 | 说明 |
|---|
Filter | object | 否 | — |
Filter.GroupIds | array<string> | 否 | — |
Filter.GroupType | string | 否 | — |
Filter.Name | string | 否 | — |
PageNumber | integer (int64) | 否 | — |
PageSize | integer (int64) | 否 | — |
SortBy | string | 否 | — |
SortOrder | string | 否 | — |
UpdateAssetGroup
| 字段 | 类型 | 必填 | 说明 |
|---|
Description | string | 否 | — |
Id | string | 是 | — |
Name | string | 否 | — |
CreateAsset
| 字段 | 类型 | 必填 | 说明 |
|---|
AssetType | string (Image | Video | Audio) | 是 | — |
GroupId | string | 是 | — |
Name | string | 否 | — |
URL | string (uri) | 是 | — |
ListAssets
| 字段 | 类型 | 必填 | 说明 |
|---|
Filter | object | 否 | — |
Filter.GroupIds | array<string> | 否 | — |
Filter.GroupType | string | 否 | — |
Filter.Name | string | 否 | — |
Filter.Statuses | array<string> | 否 | — |
PageNumber | integer (int64) | 否 | — |
PageSize | integer (int64) | 否 | — |
SortBy | string | 否 | — |
SortOrder | string | 否 | — |
UpdateAsset
| 字段 | 类型 | 必填 | 说明 |
|---|
Id | string | 是 | — |
Name | string | 否 | — |
CVSubmitTask / CVProcess / CVGetResult
| 字段 | 类型 | 必填 | 说明 |
|---|
audio_url | string (uri) | 否 | — |
image_url | string (uri) | 否 | — |
mask_url | string (uri) | array<string (uri)> | 否 | — |
req_key | string | 是 | — |
task_id | string | 否 | — |
响应
200火山兼容响应 envelope。
application/json · ArkResponse
| 字段 | 类型 | 必填 | 说明 |
|---|
ResponseMetadata | FreeFormObject | 否 | — |
Result | FreeFormObject | 否 | — |
default火山兼容错误 envelope。
application/json · ArkResponse
| 字段 | 类型 | 必填 | 说明 |
|---|
ResponseMetadata | FreeFormObject | 否 | — |
Result | FreeFormObject | 否 | — |