心智视图 API

了解如何使用背景故事 API 来创建和管理角色背景故事，为你的 NPC 增添深度和个性。

此 API 仅适用于专业版及以上套餐。

获取 MindView 的提示词

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

以以下两种方式之一获取 MindView 的提示数据：

1. 会话模式 (session_id）：从存储的交互记录中读取提示数据。
2. 角色模式 (character_id 仅）：从当前角色配置生成静态提示数据。

请求头

名称	类型	描述
CONVAI-API-KEY*	字符串	为每位用户提供的唯一 api-key。登录您的 Convai 账户后，可在钥匙图标下找到。

请求正文

名称	类型	描述
session_id	字符串	会话标识符。若提供，API 将以会话模式运行。
character_id	字符串	角色标识符。用于 session_id 未提供。
offset	整数	可选。仅与 session_id一起使用。默认 -1 返回最新的提示词记录。

至少需要以下之一： session_id 或 character_id 为必需。

200：成功（会话模式响应）

{
  "prompt_id": "f2f8a75e-...",
  "prompt": "[{\"role\":\"system\",\"content\":\"...\"}]",
  "model": "gpt-4o-mini",
  "temperature": 0.7,
  "max_tokens": 512,
  "top_p": 1.0,
  "frequency_penalty": 0.0,
  "presence_penalty": 0.0,
  "stop": null,
  "session_id": "sess_123",
  "mindview": "{\"static_prompt\": {...}, \"dynamic_prompt\": {...}}"
}

200：成功（角色模式响应）

400：错误请求

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

会话模式（session_id)

Python

import json
import requests

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

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

payload = {
    "session_id": "<Your-Session-ID>",
    "offset": -1
}

response = requests.post(url, headers=headers, data=json.dumps(payload))
print(response.text)

cURL

角色模式（character_id)

Python

import json
import requests

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

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

payload = {
    "character_id": "<Your-Character-ID>"
}

response = requests.post(url, headers=headers, data=json.dumps(payload))
print(response.text)

cURL

实现说明：

• 如果两者都 session_id 和 character_id 都提供，则使用会话模式。
• 在当前实现中， mindview 和 提示词 字段会序列化为 JSON 字符串。