Character API 集成快速入门
此快速入门指南将在几分钟内让您的角色 API 与标准 OpenAI SDK 配合工作。您将配置基础 URL,注入 API 密钥,并发送第一个无限制请求。
安装 SDK
首先为您的语言安装官方客户端库。这确保了与我们提供的 OpenAI 兼容端点的兼容性。该库为您处理序列化和重试逻辑。
对于 Python,使用 pip。对于 Node.js,使用 npm。此步骤仅需几秒,并为后续代码示例设置环境。
配置你的基础 URL
将您的 SDK 客户端指向我们的端点以访问无审查模型。基础 URL 为 HTTPS://api.apicharacter.com/v1。这将替换配置中的默认 OpenAI URL。
如果不进行此更改,请求将会失败或命中错误的服务。您只需在初始化客户端实例时设置一次即可。
设置您的 API 密钥
将您的密钥注入环境变量或客户端配置。身份验证是必需的,以便跟踪您的预付费积分使用情况。您的密钥授予对 uncensored LLM 端点的访问权限。
妥善保管此值。它是您账户的唯一凭证。基本访问无需电话号码或额外验证。
发起您的首次请求
发送一个简单的聊天补全以验证连接性。模型 ID 为 "uncensored"。在构建应用程序之前,这确认了您的身份验证和基础 URL 是正确的。
查看标准 cURL 请求的示例。
curl https://api.apicharacter.com/v1/chat/completions \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "uncensored",
"messages": [{"role": "user", "content": "set my name to Alex"}]
}'
处理流式响应
在聊天界面中启用流式传输以降低延迟。在请求中将 stream 参数设置为 true。SDK 将按生成顺序 yield token。
这对于响应用户体验至关重要。你通过服务器发送事件 (SSE) 接收到达的部分数据块。
stream = client.chat.completions.create(
model="uncensored",
messages=[{"role": "user", "content": "Tell the story in second person."}],
stream=True,
)
for chunk in stream:
if chunk.choices and chunk.choices[0].delta.content:
print(chunk.choices[0].delta.content, end="", flush=True)
限制、错误和上下文
理解您的限制以避免服务中断。您拥有 100,000 个 Token 的上下文窗口。最大输出为 16,000 个 Token,除非您另有指定。
限流为每分钟 300 次请求。401 错误表示密钥无效,402 表示余额为零,429 表示达到限流阈值。在生产环境扩展时请留意这些限制。
Python
from openai import OpenAI
client = OpenAI(base_url="https://api.apicharacter.com/v1", api_key="YOUR_KEY")
resp = client.chat.completions.create(
model="uncensored",
messages=[{"role": "user", "content": "Summarise this thread without softening it."}],
)
print(resp.choices[0].message.content)Node.js
import OpenAI from "openai";
const client = new OpenAI({ baseURL: "https://api.apicharacter.com/v1", apiKey: process.env.API_KEY });
const resp = await client.chat.completions.create({
model: "uncensored",
messages: [{ role: "user", content: "Draft a villain monologue for my game." }],
});
console.log(resp.choices[0].message.content);常见问题解答
如何获取我的角色 API 密钥?
在仪表板上使用 Google 或邮箱注册。无需电话验证即可立即显示 API 密钥。如有需要,您可以生成新密钥以替换旧密钥。
这是 openai 兼容 API 吗?
是的,它遵循标准的 chat-completions 格式。您只需更改 base URL 和 API 密钥。大多数 OpenAI SDK 只需进行少量配置更改即可直接使用。
如果我收到 402 错误会怎样?
这意味着您的预付费额度已耗尽。通过加密货币充值以恢复服务。错误和拒绝不会消耗额度,因此您只需为实际使用情况付费。
即时获取您的密钥
注册,获取你的密钥,并更新基础 URL。搞定。