API 使用文档
这里提供平台调用地址、API Key 使用方式、钱包余额查询、模型列表获取和标准对话请求示例。下游客户默认统一调用 POST /v1/chat/completions,可直接复制示例代码并替换 API Key 和模型 ID。
参数说明
下面解释示例代码里每个关键参数的来源和作用。
BASE URL
加载中...
API Key
加载中...
model
加载中...
messages
对话消息数组。常用格式是 { role: 'user', content: '你的问题' },平台会把它转发给所选模型。
stream
加载中...
max_tokens
加载中...
查询钱包余额
客户自己的系统可以用 API Key 调用
GET /v1/wallet/balance 查询当前 Key 归属账户的钱包余额。所有金额返回参数统一以“元”为单位,例如 balance: "998.68707820",接口不再返回 E8 原始整数金额字段。团队成员 Key 返回主账号钱包余额,成员自身的日/月/总人民币额度用于调用限额控制。curl 示例
加载中...
JavaScript 示例
加载中...
Python 示例
加载中...
接口返回当前 API Key 归属账户的人民币钱包信息。所有金额字段单位均为“元”,并以字符串返回,最多保留 8 位小数;不建议使用 JavaScript 浮点数直接参与账务计算。
balance钱包余额,单位:元。例如 998.68707820。frozen当前调用预结算冻结金额,单位:元。available钱包可用余额,单位:元,等于钱包余额减去冻结金额。total_recharged累计充值金额,单位:元。total_consumed累计模型调用实际结算金额,单位:元。outstanding待处理欠款金额,单位:元。发起对话请求(标准接口)
下游客户默认统一调用
POST /v1/chat/completions。把示例中的 YOUR_API_KEY 替换为你在 API Key 管理中创建的 Key,把 model 替换为模型中心可用的模型 ID。加载中...
获取可用模型列表
调用该接口可以获取当前 API Key 有权限使用的模型 ID,再把模型 ID 填到对话请求里的
model 字段。加载中...
音视频翻译模型对接示例
音频、视频翻译同样走
POST /v1/chat/completions,客户端先把音频或视频上传到公网可访问地址,再把文件 URL 放到消息内容里。模型 ID 请替换为模型中心里的音视频翻译模型 ID。音频翻译 curl 示例
加载中...
视频翻译 curl 示例
加载中...
JavaScript 示例
加载中...
Python 示例
加载中...
返回示例
加载中...
常用字段:
target_lang 为目标语言,例如 zh、en;source_lang 为源语言,可省略让模型自动识别;modalities: ["text"] 表示只返回翻译文本。如果上游模型支持配音输出,可改为 ["text", "audio"] 并传入 audio 参数。返回体里的 usage.prompt_tokens、usage.completion_tokens、usage.total_tokens 用于模型用量统计;人民币扣费以钱包账单中的 E8 金额为准。
input_audio音频输入,data 填公网音频 URL,format 填 mp3、wav、m4a 等格式。video_url视频输入,url 填公网视频 URL,建议使用 mp4 等通用格式。target_lang目标语言代码。中文建议 zh,英文建议 en。modalities输出类型。只要字幕/文本时使用 ["text"];需要语音结果时使用 ["text", "audio"]。实时语音合成(待支持)
CosyVoice、MiniMax、Seed 的 WebSocket、流式 HTTP 或事件协议需要独立实时网关桥接。
本阶段尚未开放实时入口。在非实时入口提交
stream=true 将返回 tts_realtime_not_supported,平台不会把非实时结果伪装成实时响应。当前状态暂未开放客户端实时语音合成入口。可用方案请使用对应厂商的非实时语音合成页面和 HTTP 接口。非实时语音合成 · CosyVoice
调用
POST /v1/audio/cosyvoice/speech,将文本、SSML 或含 LaTeX 公式的内容合成为音频。当前统一提供非流式响应。请求示例
curl -X POST "$API_BASE/v1/audio/cosyvoice/speech" \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "cosyvoice-v3-flash",
"input": {
"text": "你好,欢迎使用万象算力",
"voice": "longanyang",
"format": "mp3",
"sample_rate": 24000,
"volume": 50,
"rate": 1,
"pitch": 1,
"seed": 0,
"language_hints": ["zh"]
}
}'
请求头
Authorizationstring必填
使用 Bearer <API_KEY> 格式提交万象算力 API Key。Content-Typestring必填
固定为 application/json。基础请求字段
modelstring必填
模型名称。支持 cosyvoice-v3.5-plus、cosyvoice-v3.5-flash、cosyvoice-v3-plus、cosyvoice-v3-flash、cosyvoice-v2。不同模型支持的音色和高级能力可能不同。streamboolean可选
当前接口为非实时语音合成,请传 false 或省略;传 true 将返回 tts_realtime_not_supported。合成参数 · input
input.textstring必填
待合成文本。支持普通文本、SSML 和 LaTeX 公式;使用 SSML 时必须同时将 input.enable_ssml 设为 true,LaTeX 无需额外开关。input.voicestring必填
音色 ID,支持与所选模型匹配的系统音色、声音复刻音色和声音设计音色。音色不能跨模型混用,文本语种应与音色支持的语言一致。调用 cosyvoice-v3.5-plus 或 cosyvoice-v3.5-flash 时可传 platform-default 使用平台为该模型配置的默认复刻音色,或填写已为该模型创建的真实音色 ID;不能使用下列系统音色。常用系统音色示例(适用于支持系统音色的模型,不适用于 v3.5)
longanyang龙安洋,普通话/英文longanhuan_v3龙安欢,多方言/英文longjiaxin_v3龙嘉欣,粤语/英文longxiaochun_v3龙小淳,普通话/英文loongabby_v3美式英文女声loongriko_v3日语女声
音色说明
cosyvoice-v3.5-plus和cosyvoice-v3.5-flash请使用platform-default或该模型对应的复刻/设计音色 ID。- 系统音色可能持续更新,实际可用范围以当前模型和账号为准。
- 声音复刻或声音设计生成的音色,请填写对应功能返回的音色 ID。
- 同名音色在不同模型版本中可能带有
_v2、_v3后缀,请勿混用。
input.formatstring可选
音频编码格式,支持 mp3、pcm、wav、opus,默认 mp3。input.sample_rateinteger可选
采样率(Hz),支持 8000、12000、16000、22050、24000、44100、48000,默认 22050。当格式为 opus 时仅支持 8000、12000、16000、24000、48000。input.volumeinteger可选
音量,范围 0~100,默认 50。input.ratenumber可选
语速,范围 0.5~2.0,默认 1.0。input.pitchnumber可选
音调倍率,范围 0.5~2.0,默认 1.0。input.bit_rateinteger可选
音频码率,单位 kbps,范围 6~510,默认 32;仅当 input.format 为 opus 时可用。input.seedinteger可选
随机种子,范围 0~65535,默认 0。模型、文本、音色和其他参数一致时,相同种子有助于复现合成效果。文本与语言控制 · input
input.enable_ssmlboolean可选
是否解析 input.text 中的 SSML,默认 false。仅支持与模型匹配的复刻音色或明确支持 SSML 的系统音色;SSML 内容必须使用 <speak>...</speak> 包裹。input.language_hintsarray<string>可选
目标朗读语种提示。当前建议只传一个元素;该参数不会翻译输入文本,输入文本应与目标语种一致。zh中文en英语fr法语de德语ja日语ko韩语ru俄语pt葡萄牙语th泰语id印度尼西亚语vi越南语es西班牙语it意大利语ms马来西亚语fil菲律宾语ar阿拉伯语
input.instructionstring可选
合成指令,用于控制支持该能力的音色所表现的方言、情感、角色或说话风格。具体效果取决于模型和音色。input.hot_fixobject可选
文本热修复配置,可通过 pronunciation 自定义指定词语发音,或通过 replace 在合成前替换文本。cosyvoice-v2 不支持。input.hot_fix.pronunciationarray<object>可选
自定义发音列表。每一项以“原词语”为键、以带声调数字的拼音为值,例如 {"天气":"tian1 qi4"}。input.hot_fix.replacearray<object>可选
文本替换列表。每一项以“原文本”为键、以“替换文本”为值,例如 {"今天":"金天"}。input.enable_markdown_filterboolean可选
是否在合成前过滤 Markdown 标记,默认 false。当前主要适用于 cosyvoice-v3-flash 的复刻音色。input.word_timestamp_enabledboolean可选
字级时间戳仅适用于实时/流式模式;当前非实时接口请省略或传 false,传 true 将返回 tts_realtime_not_supported。AIGC 标识 · input
input.enable_aigc_tagboolean可选
是否在支持的 wav、mp3 或 opus 音频中写入 AIGC 隐性标识,默认 false。适用于 cosyvoice-v3-flash、cosyvoice-v3-plus、cosyvoice-v2。input.aigc_propagatorstring可选
AIGC 隐性标识中的内容传播者,仅在 input.enable_aigc_tag=true 时生效。input.aigc_propagate_idstring可选
AIGC 隐性标识中的传播行为唯一编号,仅在 input.enable_aigc_tag=true 时生效。平台响应字段
idstring
万象算力生成的语音任务编号。objectstring
固定为 audio.speech。createdinteger
响应生成时间,Unix 秒级时间戳。modelstring
本次使用的平台模型名称。statusstring
成功时为 completed。audio.contentstring
Base64 编码的完整音频内容。audio.urlstring
万象算力生成的音频下载地址;顶层 audio_url 返回相同地址。audio.formatstring
实际返回的音频格式。audio.mime_typestring
音频 MIME 类型,例如 audio/mpeg 或 audio/wav。usage.input_charactersinteger
本次计费的输入字符数。usage.total_charactersinteger
本次请求计费字符总数。usage.billing_unitstring
计费单位,当前为 character。providerstring
本次实际执行的渠道标识。request_idstring
请求追踪编号,排查问题时请保留。非实时语音合成 · MiniMax
调用
POST /v1/audio/minimax/speech,将文本合成为音频。支持音色、语速、音量、语调、情绪、输出音频、发音词典、混合音色、语种增强、文本归一化、声音效果和字幕等设置。请求示例
curl -X POST "$API_BASE/v1/audio/minimax/speech" \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "speech-2.8-hd",
"text": "你好,欢迎使用万象算力",
"stream": false,
"voice_setting": {
"voice_id": "male-qn-qingse",
"speed": 1,
"vol": 1,
"pitch": 0,
"emotion": "happy"
},
"audio_setting": {
"format": "mp3",
"sample_rate": 32000,
"bitrate": 128000,
"channel": 1
},
"language_boost": "Chinese",
"subtitle_enable": false
}'
请求头
Authorizationstring必填
使用 Bearer <API_KEY> 格式提交万象算力 API Key。Content-Typestring必填
固定为 application/json。基础请求字段
modelstring必填
模型名称。支持 speech-2.8-hd、speech-2.8-turbo、speech-2.6-hd、speech-2.6-turbo、speech-02-hd、speech-02-turbo、speech-01-hd、speech-01-turbo。textstring必填
待合成文本,长度须小于 10000 个字符。可用换行符分段;可在两个可发音文本之间使用 <#x#> 设置 0.01~99.99 秒停顿。streamboolean可选
当前接口为非实时语音合成,请传 false 或省略;不支持 true。音色参数 · voice_setting
voice_setting.voice_idstring必填*
合成音频的音色编号。支持系统音色、复刻音色和文生音色。使用 timbre_weights 设置混合音色时,本参数可传空字符串;未使用混合音色时必须填写。以下列出部分常用系统音色 ID:
中文
moss_audio_ce44fc67-7ce3-11f0-8de5-96e35d26fb85moss_audio_aaa1346a-7ce7-11f0-8e61-2e6e3c7ee85dChinese (Mandarin)_Lyrical_VoiceChinese (Mandarin)_HK_Flight_Attendant
英文
English_Graceful_LadyEnglish_Insightful_SpeakerEnglish_radiant_girlEnglish_Persuasive_Manmoss_audio_6dc281eb-713c-11f0-a447-9613c873494cmoss_audio_570551b1-735c-11f0-b236-0adeeecad052moss_audio_ad5baf92-735f-11f0-8263-fe5a2fe98ec8English_Lucky_Robot
日文
Japanese_Whisper_Bellemoss_audio_24875c4a-7be4-11f0-9359-4e72c55db738moss_audio_7f4ee608-78ea-11f0-bb73-1e2a4cfcd245moss_audio_c1a6a3ac-7be6-11f0-8e8e-36b92fbb4f95
粤语
Cantonese_GentleLadyCantonese_podacast_host_1
粤语使用说明
- 使用上述粤语音色时,请同时将
language_boost设置为Chinese,Yue。
音色说明
- 系统支持的音色可能持续更新;实际可用音色以当前账号可查询或可选择的音色为准。
- 复刻音色和文生音色请填写对应功能生成的音色 ID。
- 使用混合音色时,请在
timbre_weights中设置各音色的voice_id和权重,并将本字段设为空字符串。
voice_setting.speednumber可选
语速,范围 0.5~2,默认 1。voice_setting.volnumber可选
音量,范围 (0, 10],默认 1。voice_setting.pitchinteger可选
语调,整数范围 -12~12,默认 0。voice_setting.emotionstring可选
情绪。可选 happy、sad、angry、fearful、disgusted、surprised、calm、fluent、whisper;具体支持情况与模型有关。voice_setting.latex_readboolean可选
是否朗读由 $$ 包围的 LaTeX 公式,默认 false,仅适用于中文文本。音频参数 · audio_setting
audio_setting.formatstring可选
音频格式,支持 mp3、pcm、flac、wav、pcmu_raw、pcmu_wav、opus,默认 mp3。audio_setting.sample_rateinteger可选
采样率,可选 8000、16000、22050、24000、32000、44100,默认 32000。audio_setting.bitrateinteger可选
MP3 比特率,可选 32000、64000、128000、256000,默认 128000。audio_setting.channelinteger可选
声道数,1 为单声道,2 为双声道,默认 1。扩展参数
pronunciation_dict.tonestring[]可选
自定义发音规则数组,每项使用 原文/替换内容 格式,替换内容可使用文本、带声调数字的拼音、IPA 音标或日语假名。timbre_weightsobject[]可选
混合音色列表,最多 4 项。每项包含 voice_id 和整数权重 weight,权重范围 1~100。language_booststring可选
增强指定语种或方言的识别能力,可使用 Chinese、Chinese,Yue、English、Japanese、Korean、auto 等支持值。该参数不会翻译输入文本,文本应与指定语种一致。text_normalization_modestring可选
文本归一化模式,可选 basic 或 quality;quality 仅对部分模型的非流式请求生效。voice_modifyobject可选
声音效果设置。pitch、intensity、timbre 为 -100~100 的整数;sound_effects 可选 spacious_echo、auditorium_echo、lofi_telephone、robotic。subtitle_enableboolean可选
是否生成字幕,默认 false。subtitle_typestring可选
字幕粒度,可选 sentence、word。当前接口不支持流式,因此不要使用 word_streaming。output_formatstring可选
当前接口固定使用 hex 获取合成结果;可省略或传 hex。客户响应中的音频内容统一为 Base64 编码。aigc_watermarkboolean可选
是否在合成音频末尾添加音频节奏标识,默认 false。平台响应字段
audio.contentstring成功返回
生成音频的 Base64 编码内容。audio.url / audio_urlstring成功返回
生成音频的访问地址。audio.formatstring成功返回
实际返回的音频格式。audio.mime_typestring成功返回
音频 MIME 类型。usage.input_charactersinteger成功返回
本次请求的计费字符数。subtitle_urlstring按需返回
启用字幕且生成成功时返回的字幕文件地址。request_idstring成功返回
万象算力请求标识,可用于排查问题。非实时语音合成 · Seed
调用
POST /v1/audio/seed/speech,使用 Seed 模型将文本合成为语音。支持音色选择、输出格式、采样率、语速、音量、字幕及多语种等功能。请求示例
curl -X POST "$API_BASE/v1/audio/seed/speech" \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "seed-tts-2.0",
"req_params": {
"text": "你好,欢迎使用万象算力",
"speaker": "zh_female_vv_uranus_bigtts",
"audio_params": {
"format": "mp3",
"sample_rate": 24000,
"bit_rate": 64000,
"speech_rate": 0,
"loudness_rate": 0,
"enable_subtitle": true
},
"additions": "{\"silence_duration\":500,\"disable_markdown_filter\":true,\"explicit_language\":\"zh-cn\"}"
}
}'
请求头
Authorizationstring必填
万象算力 API Key,格式为 Bearer <API_KEY>。
Content-Typestring必填
固定为 application/json。
请求体 · req_params
modelstring必填
必填。模型 ID,例如 seed-tts-2.0;声音复刻功能可使用平台模型列表中提供的对应 Seed ICL 模型 ID。
req_paramsobject必填
必填。Seed 语音合成参数对象,包含待合成文本、音色及音频设置等字段。
req_params.textstring必填
必填,待合成文本。
req_params.speakerstring必填
必填,音色 ID。音色必须与所选模型匹配。
req_params.modelstring可选
可选,复刻音色使用的模型版本,默认 seed-tts-2.0-standard。仅当 speaker 为复刻音色时需要;指定后不支持 context_texts。
req_params.ssmlstring可选
可选,SSML 标记文本。目前仅中英文音色支持。启用时需将 additions.disable_markdown_filter 设置为 false;命中发音词典的片段不支持 SSML,建议二者择一。
音频参数 · audio_params
formatstring可选
输出格式,默认 mp3;支持 mp3、pcm、ogg_opus、wav。
sample_rateint可选
采样率,单位 Hz。wav/pcm/mp3 默认 24000,可选 8000/16000/22050/24000/32000/44100/48000;ogg_opus 仅支持 48000。
bit_rateint可选
比特率,单位 bps。mp3 默认 64000,支持 64000/160000;ogg_opus 支持 64000/160000;wav/pcm 不支持。启用 disable_default_bit_rate 后可选 16000/32000/64000/160000。
speech_rateint可选
语速,默认 0,范围 -50~100;-50 约为 0.5 倍速,100 约为 2.0 倍速。
loudness_rateint可选
音量,默认 0,范围 -50~100;-50 约为 0.5 倍音量,100 约为 2.0 倍音量。
enable_subtitlebool可选
是否返回字级时间戳,默认 false;仅支持中文和英文。
扩展参数 · additions
additions 必须是 JSON 序列化后的字符串,不是直接嵌套对象。例如:"additions": "{\"silence_duration\":500}"。max_length_to_filter_parenthesisint可选
过滤括号内文本的最大长度,单位字符,默认 0(不过滤),推荐范围 0~100。括号内容超过设定值时不会被过滤。
silence_durationint可选
文本末尾静音时长,单位 ms,默认 0,范围 0~30000。
disable_markdown_filterbool可选
默认 false。设为 true 时解析并去除 Markdown 语法;设为 false 时保留原始字符。
disable_emoji_filterbool可选
默认 false。设为 true 时解析并去除 Emoji;设为 false 时保留 Emoji 字符。
disable_default_bit_ratebool可选
设为 true 后允许使用扩展比特率 16000/32000/64000/160000,仍需与音频格式能力匹配。
latex_parserstring可选
LaTeX 文本朗读能力,可设为 v2。适合教育场景,会增加一定时延;启用时需同时设置 disable_markdown_filter=true。
explicit_languagestring可选
指定朗读语种。开启后仅朗读指定语种的文本,其他语种内容会被跳过或合成失败。支持的参数值如下:
zh-cn中文为主,支持中英混读en英语ja日语es-mx墨西哥西班牙语id印度尼西亚语pt-br巴西葡萄牙语pt葡萄牙语ko韩语it意大利语de德语fr法语th泰语vi越南语ru俄语fil菲律宾语ms马来语ar阿拉伯语pl波兰语tr土耳其语sv瑞典语nl荷兰语no挪威语uk乌克兰语fi芬兰语da丹麦语cs捷克语hu匈牙利语el希腊语ro罗马尼亚语hi印地语es-es西班牙西班牙语
说明
- 输入文本语种须与
explicit_language指定的语种一致,不一致时合成效果不予保证。 - 豆包语音合成模型 2.0 音色列表中,仅命名为
zh_xxx_xxxx_uranus_bigtts的音色支持nl、no、uk、fi、da、cs、hu、el、ro、hi、es-es等语种。
enable_auto_language_recognitionbool可选
自动多语种识别,默认 false。系统根据首句识别语种;若同时设置 explicit_language,以后者为准。
explicit_dialectstring可选
指定方言:beijing/dongbei/henan/shaanxi/shanghai/sichuan/tianjin/yue。所选 speaker 必须支持对应方言。
aigc_watermarkbool可选
是否在合成音频结尾添加 AIGC 节奏标识,默认 false。
aigc_metadataobject可选
Meta 隐式水印对象,适用于 mp3/wav/ogg_opus。子字段:enable、content_producer、produce_id、content_propagator、propagate_id。
post_process.pitchint可选
后处理音调,默认 0,范围 -12~12;数值越大音调越高,越小音调越低。
context_textsarray可选
语音指令字符串数组,仅豆包语音合成模型 2.0 音色支持,字段文字不参与计费;复刻音色指定 req_params.model 时不可使用。
section_idstring可选
段落标识,用于保持跨包语义;仅支持豆包语音合成模型 2.0 音色和声音复刻模型 2.0 音色。
tone_fidelitybool可选
还原模式,默认 false,尽可能还原上传 Prompt 音频的音色与风格;仅适用于声音复刻模型 2.0,同语种合成,不支持跨语种。
pronunciation_dict.tonearray可选
发音词典规则数组。格式为 原词/(拼音音节) 或 原词/目标文本;最多 5000 条,每个原词不超过 9 个字符,不能为空、含空格或重复。
平台成功响应
{
"id": "tts_...",
"object": "audio.speech",
"status": "completed",
"audio": {
"content": "BASE64_AUDIO",
"url": "https://www.wxaq.com/generated-audio/202610/example.mp3",
"format": "mp3",
"mime_type": "audio/mpeg"
},
"audio_url": "https://www.wxaq.com/generated-audio/202610/example.mp3",
"usage": {
"input_characters": 12,
"total_characters": 12,
"billing_unit": "character"
},
"request_id": "gw_..."
}
平台响应字段
audio.contentstring
生成音频的 Base64 编码内容。audio.url / audio_urlstring
生成音频的可访问地址;以实际响应是否提供为准。usage.input_charactersint
本次语音合成的计费文本字数,包含标点符号。request_idstring
万象算力请求 ID,用于查询调用记录和故障排查。视频生成模型对接示例
视频生成模型建议走专用接口
POST /v1/videos/generations 创建任务,再用 GET /v1/videos/generations/{taskId} 查询结果。模型 ID 请替换为模型中心里的视频生成模型 ID,例如 Seedance 2.0 或 Vidu 对应的平台模型 ID。文生视频 curl 示例
加载中...
图生视频 curl 示例
加载中...
视频生视频 curl 示例
加载中...
首尾帧生视频 curl 示例
加载中...
查询任务 curl 示例
加载中...
JavaScript 创建与查询示例
加载中...
Python 创建与查询示例
加载中...
视频生成通常是异步任务:创建接口返回
id 或 task_id 后,客户端建议每 5-10 秒查询一次。状态为 succeeded 时读取 output.video_url、video_url 或 output_url;状态为 failed 时展示失败原因。
content输入内容数组,通常包含一段 type: "text" 的提示词;图生视频可同时传 image_url,视频生视频可同时传 video_url。generation_type生成类型:text_to_video、image_to_video、video_to_video 或 start_end_to_video。首尾帧生视频使用 start_end_to_video。images首尾帧生视频必填且只能传 2 张图片 URL,顺序固定为第 1 张首帧、第 2 张尾帧。resolution视频清晰度,例如 480p、720p、1080p,以模型实际支持为准。ratio视频比例,例如 16:9、9:16、1:1。duration输出视频时长,单位秒。不同模型可用时长可能不同,请按模型中心配置为准。调用 MiniMax-H3 的 video_to_video 时,平台会在服务端按输入视频最长 15 秒加输出时长保守预冻结,不采信客户端声明的输入时长;最终以上游实际 Usage 结算并自动释放差额。查询当月模型用量
使用 API Key 查询其归属计费账户在当前上海自然月内,各模型已经完成结算的人民币消费金额。团队成员 Key 返回主账户整体用量,不按单个 Key 拆分;消费为 0 的模型不会返回。
curl 查询示例
加载中...
JavaScript 查询示例
加载中...
Python 查询示例
加载中...
成功返回示例
加载中...
接口:
GET /v1/usage/monthly/models。月份固定按 Asia/Shanghai 划分,只统计状态为已结算的账单;金额单位为人民币元,字符串格式并固定保留两位小数。month当前统计月份,格式为 YYYY-MM。models[].model平台模型 ID。models[].request_count该模型本月已结算的调用账单数量。models[].amount该模型本月客户实际消费金额,单位为元,固定两位小数;不包含上游成本等内部数据。查询调用记录
每次模型调用的非流式 JSON 返回体都会包含
request_id,响应头同时包含 x-request-id;流式调用请从响应头读取 x-request-id。使用创建该调用的同一个 API Key,可按请求 ID 查询本次调用的模型、状态、Token、耗时和客户计费金额。curl 查询示例
加载中...
JavaScript 查询示例
加载中...
Python 查询示例
加载中...
成功返回示例
加载中...
接口:
GET /v1/usage/requests/{request_id}。记录不存在或请求 ID 不属于当前 API Key 时,均返回 404 usage_record_not_found,不会泄露其他客户的调用记录。异步视频任务创建响应中的 request_id 同样可用于查询。request_id模型调用唯一请求 ID。普通 JSON 从返回字段读取;SSE 流式调用从 x-request-id 响应头读取。usage本次调用的输入、输出和总 Token;非 Token 类模型可能为 0,以计费字段为准。billing.amount客户侧人民币消费金额,字符串格式,单位为元;不会返回平台上游成本或内部路由信息。status调用状态,例如 success、pending 或 error。错误码说明
以下错误面向使用 API Key 调用平台接口的客户端排查。
INVALID_API_KEYAPI Key 缺失、填写错误、已禁用或失效。检查 Authorization: Bearer YOUR_API_KEY。INSUFFICIENT_BALANCE算力余额不足,请充值或联系上级账户处理额度。MODEL_NOT_FOUND模型 ID 不存在或当前不可用,请从模型中心复制正确 ID。MODEL_NOT_ALLOWED当前 API Key 没有使用该模型的权限。NO_CHANNEL_AVAILABLE所选模型暂时没有可用通道,请更换模型或稍后重试。RATE_LIMIT_EXCEEDED达到每分钟或每日请求数/Token 限制,请降低调用频率。BAD_REQUEST请求体格式不正确,例如 messages 为空、Content-Type 缺失或参数超限。STREAM_NOT_SUPPORTED所选模型或通道不支持流式能力,请改用 stream=false。REQUEST_TIMEOUT模型响应较慢或网络不稳定,可稍后重试并适当缩短输入。加载中...