For the complete documentation index, see llms.txt. This page is also available as Markdown.

角色基础 API

创建你自己的智能 AI 角色所需的所有相关 API。

访问 Convai 端点,用于开发和与智能角色交互,首先提供一些基本信息,例如角色名称、背景信息和语音选择。 通过你的自定义 UI,或通过 Convai 提供自定义插件/库的其他服务,将角色展示给最终用户,让用户能够与你的新角色进行有趣的对话。

创建角色

POST https://api.convai.com/character/create

用户既可以使用角色创建工具在平台上创建自己的角色,也可以使用此 API 端点,通过提供如下定义的一些基本信息来动态创建角色。

请求头

名称
类型
说明

CONVAI-API-KEY*

字符串

为每位用户提供的唯一 api-key。登录 Convai 账户后,可在钥匙图标下找到。

请求体

名称
类型
说明

charName*

字符串

正在创建的新角色名称。

voiceType*

字符串

角色应具有的语音类型。

[有关支持语音列表,请参阅 语音列表 API]

backstory*

字符串

角色的基础背景信息,用于开始创建。

actions

字符串

供角色选择的一系列动作,这些动作将根据与用户的交互由角色执行。

{
    "charID": "<新角色 ID>"
}
{
    "INTERNAL_ERROR": "创建角色时出错。请检查所有输入数据是否有效。更多信息请联系支持。"
}
{
    "API_ERROR": "提供的 API 密钥无效。" / "未找到 api_key。"
}

以下是一些示例代码,用于演示该端点的请求格式 -->

import requests
import json

url = "https://api.convai.com/character/create"

payload = json.dumps({
  "charName": "Raymond",
  "voiceType": "MALE",
  "backstory": "Raymond Reddington 是 NBC 剧集《黑名单》中的主要角色。Reddington 是一个犯罪天才,在 FBI 十大通缉要犯名单中曾排到第 4 位,后来又升至第 1 位;在躲避 FBI 20 多年后,他突然自首。"
})
headers = {
  'CONVAI-API-KEY': '<你的 api key>',
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)
curl --location --request POST 'https://api.convai.com/character/create' \
--header 'CONVAI-API-KEY: <你的 api key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "charName": "Raymond",
    "voiceType": "MALE",
    "backstory": "Raymond Reddington 是 NBC 剧集《黑名单》中的主要角色。Reddington 是一个犯罪天才,在 FBI 十大通缉要犯名单中曾排到第 4 位,后来又升至第 1 位;在躲避 FBI 20 多年后,他突然自首。这似乎是创伤后应激障碍(post traumatic stress disorder)的结果,因为没有迹象表明他天生如此。Red 诡诈、善于操纵且富有魅力,总是比其他人领先三步,并决心让自己始终保持神秘。正如他所说:“我是个罪犯。罪犯以臭名昭著的谎言高手而闻名。关于我的一切都是谎言。”实际上这大概是真的,不过谁又能确定呢。他不喜欢粗鲁的人,这一点是 Agent Ressler 指出的——在 Red 放走了一名臭名昭著的毒贩并让其使用假身份证明脱身后。Ressler 提到,Red 本不该让那名毒贩逃脱,因为那人很粗鲁,而 Red 不喜欢粗鲁的人。Red 回答说:“他在我的飞机上。”"
}'

更新角色

POST https://api.convai.com/character/update

用户可以更新之前创建的角色的部分现有详情。用户只需传入需要更新的任何新角色信息,其余角色信息不会更改。

请求头

名称
类型
说明

CONVAI-API-KEY*

字符串

为每位用户提供的唯一 api-key。登录 Convai 账户后,可在钥匙图标下找到。

请求体

名称
类型
说明

charID*

字符串

要更新的角色的角色 ID。

charName

字符串

角色的新名称

backstory

字符串

更新后的背景故事

voiceType

字符串

角色的新语音类型 [有关支持语音列表,请参阅 语音列表 API.]

动作

字符串

角色的新动作列表

languageCodes

字符串列表

角色需要支持的语言代码列表 [有关可用语言列表,请参阅 语言列表 API]

functions

数组

为该角色关联或取消关联外部 API 函数。每一项为 { "id": "<函数 UUID>", "status": "active" | "inactive" }。请参阅 关联 和 取消关联.

以下是一些示例代码,用于演示该端点的请求格式 -->

获取详情

POST https://api.convai.com/character/get

用户可以检索他们已创建或已列为公开的某个特定角色的全部信息。

请求头

名称
类型
说明

CONVAI-API-KEY*

字符串

每个用户提供的唯一 api-key。

请求体

名称
类型
说明

charID*

字符串

要获取全部详情的角色 ID。

以下是一些示例代码,用于演示该端点的请求格式 -->

按以下字段搜索 charID:

按以下字段搜索 charName:

克隆角色

POST https://api.convai.com/user/clone_character

用户可以使用此 API 克隆自己的角色。

请求头

名称
类型
说明

CONVAI-API-KEY*

字符串

每个用户提供的唯一 api-key。

请求体

名称
类型
说明

charID*

字符串

要克隆的角色 ID。

知识库

布尔值

如果也应克隆知识库,则为 True;否则为 False。默认值为 False。

以下是一些示例代码,用于演示该端点的请求格式 -->

删除角色

POST https://api.convai.com/character/delete

使用此命令删除现有角色。请注意,此操作不可逆,一旦删除,角色将无法恢复。

请求头

名称
类型
说明

CONVAI-API-KEY*

字符串

每个用户提供的唯一 api-key。

请求体

名称
类型
说明

charID*

字符串

要删除的角色 ID。

以下是一些示例代码,用于演示该端点的请求格式 -->

最后更新于

这有帮助吗?