API 配置

输入后会自动更新下方示例
POST /api/v1/asr
语音识别

接口说明

将音频文件转换为文字。支持公网 URL 或 base64 编码。

请求参数

参数 类型 必填 说明
file string 音频文件,支持公网 URL 或 base64 编码

响应格式

{
  "text": "识别出的文字内容"
}

示例代码


                                

                                

                            
POST /api/v1/tts
语音合成

接口说明

将文字转换为语音。服务端内部处理异步轮询,直接返回音频数据。

请求参数

参数 类型 必填 说明
text string 要合成的文字内容
speed float 语速倍率,默认 1.0
format string 返回格式,"json"(默认) 或 "binary" 直接下载音频

响应格式

format=json (默认):

{
  "audio": "base64编码的音频数据"
}

format=binary:

直接返回 audio/wav 文件

示例代码


                                

                            
POST /api/v1/vision
图像理解

接口说明

分析图片内容并返回描述。支持公网 URL、base64 编码,或直接使用 multipart/form-data 上传文件。

请求参数

参数 类型 必填 说明
image string 图片文件,支持公网 URL、base64 编码,或使用 multipart 直接上传
prompt string 提示词,默认"请描述这张图片的内容"

响应格式

{
  "result": "图片内容描述"
}

示例代码


                                

                            

常用 Prompt 示例

  • 请描述这张图片的内容 - 通用描述
  • 这张图片里有哪些物体? - 物体识别
  • 图片中的人在做什么? - 行为分析
  • 提取图片中的文字 - OCR
POST /api/v1/agent/chat
智能体对话

接口说明

调用腾讯元器智能体进行多轮对话。学生需先在腾讯元器后台创建智能体,获取 assistant_id(appid)和 token(appkey)。

请求参数

参数 类型 必填 说明
assistant_id string 智能体 ID(腾讯元器 appid)
token string 智能体调用密钥(腾讯元器 appkey)
messages array 对话消息数组,支持多轮

messages 格式

[
  {"role": "user", "content": [{"type": "text", "text": "你好"}]},
  {"role": "assistant", "content": [{"type": "text", "text": "你好!有什么可以帮你?"}]},
  {"role": "user", "content": [{"type": "text", "text": "帮我查询天气"}]}
]

响应格式

{
  "content": "智能体的回复内容",
  "images": ["https://example.com/image.png"],
  "usage": {
    "prompt_tokens": 100,
    "completion_tokens": 50,
    "total_tokens": 150
  }
}

images 字段仅在回复包含图片时出现

示例代码


                        
POST /api/v1/agent/once
智能体单次调用

接口说明

向智能体发送一条消息并返回结果,简化版的智能体调用。支持附带一张图片。

请求参数

参数 类型 必填 说明
assistant_id string 智能体 ID(腾讯元器 appid)
token string 智能体调用密钥(腾讯元器 appkey)
prompt string 提问内容
image string 图片 base64 编码(JSON 模式)或文件上传(multipart 模式)

响应格式

{
  "content": "智能体的回复文本",
  "images": ["https://example.com/generated.png"]
}

images 字段仅在回复包含图片时出现

示例代码


                                

                            
GET /api/v1/usage/me
查询个人用量

接口说明

查询当前 API Key 的调用记录。

示例代码


                        

错误码说明

状态码 含义 说明
200 成功 请求处理成功
400 参数错误 请求参数缺失或格式不正确
401 未认证 API Key 无效或已过期
429 限流 触发 RPM 或总量限制
502 上游错误 移动云服务调用失败