You need to enable JavaScript to run this app.
文档中心
AI MediaKit

AI MediaKit

复制全文
下载 pdf
大模型处理工具 API
MaaS 模型代理 API
复制全文
下载 pdf
MaaS 模型代理 API
POST https://mediakit.cn-beijing.volces.com/api/v1/tools/call-maas-proxy​
本 API 用于提交一个异步的 MaaS 模型能力代理调用任务。通过本 API,您可以用一套统一的方式,调用已在火山方舟、豆包语音等模型产品中开通的能力(当前支持视频生成、图片生成、音频生成、语音识别),并由 AI MediaKit 统一处理任务的异步执行、结果回调、幂等控制与队列调度。​
说明​
本 API 调用的是火山方舟、豆包语音等模型产品的能力,并非 AI MediaKit 自有算法。使用前,您需先在对应模型产品中开通所需能力,并在 AI MediaKit 控制台完成对该模型产品的跨服务授权。各能力的完整功能说明与使用示例,请参阅对应指南:​
请求参数​
Header 参数​
​
参数​
类型​
是否必选​
示例值​
描述​
Authorization​
String​
是​
Bearer {Your_API_Key}​
格式为 Bearer {Your_API_Key}。请参考基础概念及准备工作获取 API Key。​
​
Body 参数​
​
参数​
类型​
是否必选​
示例值​
描述​
api​
String​
是​
ark.video_generation​
要调用的模型接口标识。支持以下取值:​
  • ark.image_generation:图片生成​
  • ark.video_generation:视频生成​
  • doubao.audio_generation:语音合成​
  • doubao.asr:语音识别​
maas_params​
Object​
是​
{...}​
目标模型接口所需的业务参数(如模型、提示词等),直接按对应模型产品的接口要求填写即可,AI MediaKit 会将这些参数原样传递给目标模型。任务的异步执行、结果回调、幂等控制等由 AI MediaKit 统一处理,无需您在此设置。各字段请以 api 参数所对应的模型产品官方文档为准:​
注意​
通过本接口进行图生图时,AI MediaKit 仅支持通过 URL (image_url) 方式提供参考图,暂不支持通过 Base64 编码 (image_base64) 方式提供。​
client_token​
String​
否​
your_unique_request_id_185​
用户请求凭证,用于幂等控制。大小写敏感,不超过 64 个 ASCII 码可打印字符。详情请参考幂等性控制。​
callback_args​
String​
否​
your_unique_callback_args​
自定义回调参数。您提供的内容将在任务完成时,通过事件回调原样返回,方便您关联业务。字段长度最大为 512 字节。​
callback_url​
String​
否​
https://example.com/callback​
用于接收该任务结果回调的 URL 地址。如果提供此参数,其优先级将高于在控制台配置的全局回调地址。地址必须以 http:// 或 https:// 开头。请参考事件回调了解回调接收机制和回调消息结构。​
queue_id​
String​
否​
q00a9731598092652e4a95292434198​
任务提交的目标队列 ID。如不传,默认会使用系统自动创建的队列 ID。您可以将不同业务或优先级的任务提交到不同的队列,以实现按队列对应的项目进行分账。您可以在 AI MediaKit 控制台队列管理页面创建和管理队列,系统会自动分配一个队列 ID。详情请参考按项目或 API Key 分账。​
​
请求示例​
本节按模型服务分别给出请求示例。​
图片生成 ark.image_generation​
将 api 设为 ark.image_generation,在 maas_params 中按火山方舟 - 图片生成 API 填写业务参数。​
​
curl -X POST 'https://mediakit.cn-beijing.volces.com/api/v1/tools/call-maas-proxy' \​
-H 'Authorization: Bearer {Your_API_Key}' \​
-H 'Content-Type: application/json' \​
-d '{​
"api": "ark.image_generation",​
"maas_params": {​
"model": "doubao-seedream-5-0-pro-260628",​
"prompt": "一张赛博朋克风格的城市夜景海报,霓虹灯,电影质感",​
"size": "1024x1024"​
}​
}'​
​
视频生成 ark.video_generation​
将 api 设为 ark.video_generation,在 maas_params 中按火山方舟 - 视频生成 API 填写业务参数。以下为图生视频示例,content 中同时包含文本提示词与参考图。​
​
curl -X POST 'https://mediakit.cn-beijing.volces.com/api/v1/tools/call-maas-proxy' \​
-H 'Authorization: Bearer {Your_API_Key}' \​
-H 'Content-Type: application/json' \​
-d '{​
"api": "ark.video_generation",​
"maas_params": {​
"model": "doubao-seedance-2-5-260628",​
"content": [​
{ ​
"type": "text", ​
"text": "女孩抱着狐狸,女孩睁开眼,温柔地看向镜头,镜头缓缓拉出,女孩的头发被风吹动" ​
},​
{ ​
"type": "image_url", ​
"image_url": { ​
"url": "https://example.com/your-reference-image.png" ​
} ​
}​
],​
"generate_audio": true,​
"ratio": "adaptive",​
"duration": 5,​
"watermark": false​
}​
}'​
​
语音合成 doubao.audio_generation​
将 api 设为 doubao.audio_generation,在 maas_params 中按请以豆包语音 - 音频生成 API 填写业务参数。​
​
curl -X POST 'https://mediakit.cn-beijing.volces.com/api/v1/tools/call-maas-proxy' \​
-H 'Authorization: Bearer {Your_API_Key}' \​
-H 'Content-Type: application/json' \​
-d '{​
"api": "doubao.audio_generation",​
"maas_params": {​
"model": "seed-audio-1.0",​
"text_prompt": "欢迎使用 AI MediaKit,这是一段语音合成示例。",​
"audio_config": {​
"format": "mp3",​
"sample_rate": 48000,​
"pitch_rate": 0,​
"speech_rate": 0,​
"loudness_rate": 0​
}​
}​
}'​
​
语音识别 doubao.asr​
将 api 设为 doubao.asr,在 maas_params 中按豆包语音 - 录音文件识别 API 填写业务参数。​
​
curl -X POST 'https://mediakit.cn-beijing.volces.com/api/v1/tools/call-maas-proxy' \​
-H 'Authorization: Bearer {Your_API_Key}' \​
-H 'Content-Type: application/json' \​
-d '{​
"api": "doubao.asr",​
"maas_params": {​
"audio": {​
"url": "https://example.com/your-audio.mp3",​
"format": "mp3"​
},​
"request": {​
"model_name": "bigmodel",​
"enable_itn": true,​
"enable_punc": true,​
"enable_ddc": false,​
"enable_speaker_info": false,​
"enable_channel_split": false,​
"show_utterances": false​
}​
}​
}'​
​
响应说明​
调用 API 提交任务后,接口会立即返回一个同步响应,表明任务是否成功进入后台处理队列。​
响应参数​
​
参数​
类型​
描述​
success​
Boolean​
任务是否成功提交。 ​
  • true:任务已成功提交到后台处理队列。 ​
  • false:请求存在错误,任务提交失败。请检查 error 字段以获取详细信息。​
task_id​
String​
任务的唯一标识符。仅在 success 为 true 时返回有效值。您可以使用此 ID 来查询任务状态和结果。​
request_id​
String​
本次 API 请求的唯一标识符,可用于问题排查。​
error​
Object​
错误详情对象,仅在 success 为 false 时返回。详见Error 对象。​
​
Error 对象​
​
参数​
类型​
描述​
code​
String​
具体的错误码。关于各错误码的详细信息,请参阅错误码。​
type​
String​
错误的宏观类型。例如 BadRequest。​
message​
String​
对错误的详细描述,可用于开发调试。​
param​
String​
(可选)指出导致错误的具体参数。​
​
响应示例​
成功响应​
​
{​
"success": true,​
"task_id": "amk-tool-call-maas-proxy-123456789",​
"request_id": "20240523100000ABCDEFG12345"​
}​
​
失败响应​
​
{​
"success": false,​
"task_id": "",​
"request_id": "20240523101000WXYZ54321",​
"error": {​
"code": "InvalidParameter",​
"message": "The 'api' parameter is required",​
"param": "api",​
"type": "BadRequest"​
}​
}​
​
异步任务结果​
参数说明​
模型能力调用是一个异步任务,任务的执行状态和最终结果不会在提交时同步返回。您可以通过以下两种方式获取任务结果:​
  • 方法一(轮询查询):使用提交任务时获取的 task_id,定期调用查询任务信息 API,直到 status 字段变为 completed 或 failed。​
  • 方法二(事件回调):在 AI MediaKit 控制台预先配置一个接收回调的 URL,或在提交任务时通过 callback_url 参数为单次任务指定回调地址。任务完成后,系统会将包含最终结果的详细信息 POST 到您指定的地址。详情请参阅事件回调。​
当任务成功完成后,您获取到的任务信息中的 result 字段将包含以下内容。​
​
参数​
类型​
描述​
api​
String​
实际调用的模型接口标识,与请求中的 api 一致。​
duration​
Number​
音视频总时长,单位为秒。对于图片生成任务,该值为 0。部分任务(如语音识别)可能不返回此字段。​
maas_result​
Object​
目标模型接口返回的原始结果,AI MediaKit 原样返回。其具体结构(可能包含 Token 用量、生成产物地址等)请以 api 所对应的模型产品官方文档为准:​
​
结果示例​
以下按模型服务分别给出任务执行完成后的完整任务信息示例。maas_result 为目标模型接口原样返回的结果,其字段以对应模型产品官方文档为准;示例中的 task_id、request_id、资源地址等均为脱敏占位,实际以接口返回为准。​
图片生成 ark.image_generation​
maas_result 中包含生成图片地址等字段,result.duration 为 0。​
​
{​
"success": true,​
"task_id": "amk-tool-call-maas-proxy-123456789",​
"request_id": "20240523100000ABCDEFG12345",​
"status": "completed",​
"result": {​
"api": "ark.image_generation",​
"duration": 0,​
"maas_result": {​
"created": 1777358420,​
"model": "doubao-seedream-5-0-pro-260628",​
"data": [​
{​
"url": "https://example.com/generated-image.jpeg?X-Tos-Algorithm=TOS4-HMAC-SHA256&X-Tos-Expires=86400&X-Tos-Signature=***",​
"size": "1024x1024",​
"output_format": "jpeg"​
}​
],​
"usage": {​
"generated_images": 1,​
"input_images": 0,​
"output_tokens": 4096,​
"total_tokens": 4096​
}​
}​
},​
"expires_at": 1777531298,​
"created_at": 1777358413,​
"finished_at": 1777358420​
}​
​
视频生成 ark.video_generation​
maas_result.content.video_url 为生成视频地址,result.duration 为视频总时长(秒)。​
​
{​
"success": true,​
"task_id": "amk-tool-call-maas-proxy-123456789",​
"request_id": "20240523100000ABCDEFG12345",​
"status": "completed",​
"result": {​
"api": "ark.video_generation",​
"duration": 5.0,​
"maas_result": {​
"id": "cgt-20240523100000-abcde",​
"model": "doubao-seedance-2-5-260628",​
"status": "succeeded",​
"content": {​
"video_url": "https://example.com/generated-video.mp4?X-Tos-Algorithm=TOS4-HMAC-SHA256&X-Tos-Expires=86400&X-Tos-Signature=***"​
},​
"resolution": "720p",​
"ratio": "16:9",​
"frames_per_second": 24,​
"output_format": "mp4",​
"duration": 5,​
"created_at": 1777358413,​
"updated_at": 1777358420,​
"usage": {​
"completion_tokens": 108900,​
"total_tokens": 108900​
}​
}​
},​
"expires_at": 1777531298,​
"created_at": 1777358413,​
"finished_at": 1777358420​
}​
​
语音合成 doubao.audio_generation​
maas_result.audio 为 base64 编码的音频数据。​
​
{​
"success": true,​
"task_id": "amk-tool-call-maas-proxy-123456789",​
"request_id": "20240523100000ABCDEFG12345",​
"status": "completed",​
"result": {​
"api": "doubao.audio_generation",​
"maas_result": {​
"audio": "SUQzBAAAAAAAA...(base64 编码的音频数据,此处省略)"​
}​
},​
"expires_at": 1777531298,​
"created_at": 1777358413,​
"finished_at": 1777358420​
}​
​
语音识别 doubao.asr​
maas_result.result.text 为识别文本,result.duration 为识别音频的总时长(秒)。​
​
{​
"success": true,​
"task_id": "amk-tool-call-maas-proxy-123456789",​
"request_id": "20240523100000ABCDEFG12345",​
"status": "completed",​
"result": {​
"api": "doubao.asr",​
"duration": 34.167,​
"maas_result": {​
"audio_info": {​
"duration": 34167​
},​
"result": {​
"text": "人间忽晚,山河依旧。一个转身,秋天成了风景,冬天成了期待。好好生活,慢慢相遇。",​
"additions": {​
"duration": "34167"​
}​
}​
}​
},​
"expires_at": 1777531298,​
"created_at": 1777358413,​
"finished_at": 1777358420,​
"queue_id": "q00a9731598092652e4a95292434198"​
}​
​
最近更新时间:2026.10.10 17:25:31
这个页面对您有帮助吗?
有用
有用
无用
无用