创建AI智能体

编辑文档更新于 2025-09-21 11:59:40

描述

本接口用于创建 AI 智能体

接口请求地址

请求方式：POST/JSON
传输协议：HTTPS
调用频次限制：10 次/秒
请求 URL：

https://brtc-api.baijiayun.com/vcs/aiagent/v1/create

请求参数

名称	位置	类型	必选	中文名	说明
body	body	object	否	CreateAgent	none
» app_id	body	string	是		应用 ID
» room_id	body	string	是		房间 ID
» peer_user_id	body	[string]	是		对端用户 ID。如果是对话智能体，则只能设置1个对端用户；如果是语音转写智能体，则允许设置多个
» type	body	integer	否		智能体类型： - 1: 对话智能体 - 2: 语音转写智能体
» force_create	body	boolean	否		是否强制创建。同一个房间只允许1个运行中的智能体，如果指定force_create为true，则会先停止该房间中当前正在运行的智能体并创建新的
» task_idle_time	body	integer	否		任务最大空闲时长，单位是秒，默认值为300，即5分钟。
» interrupt_mode	body	integer	否		打断方式 - 1: 自动打断 - 2: 手动打断
» avatar_enable	body	boolean	否		0 不开启 1 开启
» external_agent_enable	body	boolean	否		0 不开启 1 开启
» server3a_enable	body	boolean	否		0 不开启 1 开启
» greeting_msg	body	string	是		智能体欢迎语
» self_introduction	body	string	是		智能体的自我介绍
» llm_config	body	object	是		none
»» vendor	body	string	是		none
»» model	body	string	是		none
»» app_key	body	string	是		应用 key
»» url	body	string	是		模型接口地址
»» input_modalities	body	[string]	是		输入模态
»» output_modalities	body	[string]	是		输出模态
»» prompt	body	string	是		提示词
»» temperature	body	number	是		采样温度
»» max_history	body	integer	是		问答记忆数量
»» param	body	object	是		大模型私有参数
» asr_config	body	object	是		none
»» type	body	string	是		目前支持 aliyun_realtime_asr
»» param	body	object	是		不同厂商不同参数
»»» domain	body	string	是		none
»»» region	body	string	是		none
»»» access_key_id	body	string	是		none
»»» access_key_secret	body	string	是		none
»»» app_key	body	string	是		none
» tts_config	body	object	是		none
»» type	body	string	是		目前支持 CosyVoice
»» skip_symbol	body	[integer]	是		跳过符号类型
»» param	body	object	是		不同厂商参数不同
»»» domain	body	string	是		none
»»» region	body	string	是		none
»»» access_key_id	body	string	是		none
»»» access_key_secret	body	string	是		none
»»» app_key	body	string	是		none
»»» ws_url	body	string	是		none
»»» voice	body	string	是		none
» vad_config	body	object	是		none
»» interrupt_duration	body	integer	是		vad 判断时长
»» prefix_padding	body	integer	是		vad 判断前预置时长
»» silence_duration	body	integer	是		语音结束判断阈值
»» volume_threshold	body	integer	是		none
»» detect_threshold	body	number	是		none
» avatar_config	body	object	是		none
»» type	body	string	是		数字人厂家
»» param	body	object	是		数字人配置

请求参数 json 模板

{
  "app_id": "string",
  "room_id": "string",
  "peer_user_id": [
    "string"
  ],
  "type": 1,
  "force_create": false,
  "task_idle_time": 300,
  "interrupt_mode": 1,
  "avatar_enable": false,
  "external_agent_enable": false,
  "server3a_enable": false,
  "greeting_msg": "string",
  "self_introduction": "string",
  "llm_config": {
    "vendor": "string",
    "model": "string",
    "app_key": "string",
    "url": "string",
    "input_modalities": [
      "text"
    ],
    "output_modalities": [
      "text"
    ],
    "prompt": "string",
    "temperature": 0,
    "max_history": 0,
    "param": {}
  },
  "asr_config": {
    "type": "tingwu",
    "param": {
      "domain": "string",
      "region": "string",
      "access_key_id": "string",
      "access_key_secret": "string",
      "app_key": "string"
    }
  },
  "tts_config": {
    "type": "aliyunisi",
    "skip_symbol": [
      0
    ],
    "param": {
      "domain": "string",
      "region": "string",
      "access_key_id": "string",
      "access_key_secret": "string",
      "app_key": "string",
      "ws_url": "string",
      "voice": "string"
    }
  },
  "vad_config": {
    "interrupt_duration": 500,
    "prefix_padding": 200,
    "silence_duration": 500,
    "volume_threshold": 50,
    "detect_threshold": 0.5
  },
  "avatar_config": {
    "type": "string",
    "param": {}
  }
}

返回参数

返回数据结构

名称	类型	必选	约束	说明
» code	integer	true	none	none
» data	object	true	none	none
»» agent_id	string	true	none	none
»» agent_user_id	string	true	none	none
» msg	string	true	none	none

返回示例

200 Response

{
  "code": 200,
  "data": {
    "agent_id": "abcedafeaga1231",
    "agent_user_id": "record#1234"
  },
  "msg": "succeed"
}