聊天历史 API

与会话或角色聊天历史交互所需的所有相关 API。

此 API 仅适用于 Scale 方案及以上。

列出角色的会话

POST https://api.convai.com/character/chatHistory/list

列出该角色的所有会话。该 API 接受一个 limit 参数，可用于限制要获取的会话数量。如果该值设置为 "-1"，则返回所有会话。

请求头

名称	类型	说明
CONVAI-API-KEY*	字符串	每个用户提供的唯一 api-key。在登录 Convai 账户后，可在 Key 图标下找到。

请求体

名称	类型	说明
charID	字符串	你的角色 ID。
limit	字符串	要返回的会话数量

200：OK 返回会话列表

[
    {
        "sessionID": "c1234567890aba1111222233334447862",
        "date": "25-09-2024",
        "time": "20:52:57",
        "is_added_to_memory": false
    },
    {
        "sessionID": "8c123456789011111222223333344455",
        "date": "25-09-2024",
        "time": "19:54:56",
        "is_added_to_memory": false
    }
]

401 API 密钥验证失败

{
    "ERROR": "提供的 API 密钥无效。"
}

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

Python

import requests
import json

url = "https://api.convai.com/character/chatHistory/list"

headers = { 
    'CONVAI-API-KEY': '<Your-API-Key>',
    'Content-Type': 'application/json'
}

# 为 JSON 负载创建一个字典
payload = { 
    "charID": "<Your-Character-Id>",
    "limit": "-1"
}

# 将负载转换为 JSON
json_payload = json.dumps(payload)

response = requests.post(url, headers=headers, data=json_payload)

print(response.text)

cURL

curl -X POST "https://api.convai.com/character/chatHistory/list" \
     -H "CONVAI-API-KEY: <Your-API-Key>" \\
     -H "Content-Type: application/json" \
     -d '{"charID": "<Your-Character-Id>", "limit": "-1"}'

某个会话的聊天历史

POST https://api.convai.com/character/chatHistory/details

列出给定 session-id 的所有交互。输出中还包含一个布尔参数，用于说明用户输入是否为触发器。如果你在与角色交互时曾发送过触发器，则该值将设为 true。

请求头

名称	类型	说明
CONVAI-API-KEY*	字符串	每个用户提供的唯一 api-key。在登录 Convai 账户后，可在 Key 图标下找到。

请求体

名称	类型	说明
charID	字符串	你的角色 ID。
sessionID	字符串	你要获取其交互记录的角色的会话 ID。

200：OK 返回会话交互记录

[
    {
        "timestamp": "2024-09-25 19:54:59.124733",
        "interaction": [
            {
                "speaker": "User",
                "message": "你好"
            },
            {
                "speaker": "Character",
                "message": "你好，欢迎来到历史博物馆。我们这里有有史以来发现的最古老化石。你有兴趣参观一下吗？"
            }
         ],
        "is_trigger_input": false
    }
]

401 API 密钥验证失败

{
    "ERROR": "提供的 API 密钥无效。"
}

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

Python

import requests
import json

url = "https://api.convai.com/character/chatHistory/details"

headers = { 
    'CONVAI-API-KEY': '<Your-API-Key>',
    'Content-Type': 'application/json'
}

# 为 JSON 负载创建一个字典
payload = { 
    "charID": "<Your-Character-Id>",
    "sessionID": "<Your-Session-ID>"
}

# 将负载转换为 JSON
json_payload = json.dumps(payload)

response = requests.post(url, headers=headers, data=json_payload)

print(response.text)

cURL

curl -X POST "https://api.convai.com/character/chatHistory/list" \
     -H "CONVAI-API-KEY: <Your-API-Key>" \\
     -H "Content-Type: application/json" \
     -d '{"charID": "<Your-Character-Id>", "sessionID": "<Your-Session-ID>"}'