灿培 API开发者文档
docs.cplicity.com
01

概览

灿培 API 基于统一的 OpenAI 兼容接口规范提供多模型接入服务。开发者仅需将原有应用的请求地址切换至灿培平台,并使用平台颁发的 API 令牌进行鉴权,即可通过统一的调用方式接入不同模型,无需针对单一模型进行重复适配。

接口地址(BASE URL)
https://cplicity.com
身份认证方式
Authorization: Bearer
兼容规范
兼容 OpenAI 接口规范

本服务适用于智能对话、文本生成与改写、内容生产、智能客服、代码辅助等典型场景,并支持将 AI 能力集成至网站、应用程序及企业内部系统。平台所提供模型的种类、功能说明及定价信息均于模型广场实时发布,开发者在接入前请以模型广场公示信息为准进行选型。

02

快速开始

开发者可通过以下三个步骤完成首次接口调用:

1

注册账户

访问 cplicity.com,按照页面指引完成灿培账户注册并登录控制台。

2

创建 API 令牌

登录控制台后,进入「令牌管理」页面创建 API 令牌,并请妥善保管。调用接口时须使用该令牌进行身份认证。同时请确保账户余额充足,相关说明请参阅「计费与充值」章节。

3

发起首次调用

请将下述示例中的 sk-您的令牌 替换为实际令牌,并将 model 参数设置为模型广场公示的模型名称,执行请求即可完成调用。

curl · 请求示例
curl https://cplicity.com/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer sk-您的令牌" \
  -d '{
    "model": "模型广场公示的模型名称",
    "messages": [
      { "role": "user", "content": "您好,请介绍一下您自己" }
    ]
  }'
!

注意事项:模型名称须以模型广场公示为准。填写时请准确复制模型名称,并确保大小写及符号完全一致。模型名称填写错误为接口调用失败的常见原因。

调用成功后,接口将以 JSON 格式返回响应结果,模型回复内容位于 choices[0].message.content 字段。请求与响应的完整规范请参阅「接口说明」章节。

03

认证

所有接口请求均须在请求头(Header)中携带 API 令牌进行身份认证,格式规范如下:

HTTP Header
Authorization: Bearer sk-您的令牌
  • 令牌管理:开发者可在 cplicity.com 控制台中完成令牌的创建、查询与删除操作。建议按项目分别创建独立令牌,以便于权限管理与问题排查。
  • 安全要求:请勿将令牌置于公开代码仓库、前端代码、截图等可被第三方获取的环境中,亦不得向任何第三方披露。令牌一经泄露,第三方可能使用您的账户余额发起调用。
  • 泄露处置:如怀疑令牌已经泄露,请立即在控制台删除该令牌并重新创建。原令牌删除后即时失效。
  • 认证失败:未携带令牌或令牌信息不正确时,接口将返回 401 状态码。具体排查方式请参阅「错误码」章节。
04

接口说明

接口基础地址(Base URL)为 https://cplicity.com,请求与响应格式遵循 OpenAI 兼容规范。对于基于 OpenAI SDK 或相关代码的既有应用,开发者仅需完成两项调整:将 Base URL 修改为 https://cplicity.com/v1,并将 API Key 替换为灿培平台令牌,即可完成接入。

方法路径说明
POST /v1/chat/completions 对话补全接口。用于提交对话消息并获取模型响应结果,支持流式输出模式。
GET /v1/models 模型列表接口。用于查询当前可用模型列表,模型名称以本接口返回结果及模型广场公示为准。

请求参数(聊天接口)

参数必填说明
model是拟调用的模型名称,须填写模型广场公示的准确名称。
messages是对话消息数组。每条消息包含 role(例如 user、assistant、system)及 content 字段。
stream否是否启用流式输出。设置为 true 时,响应内容将分段返回;默认值为 false,即完整生成后一次性返回。
temperature否采样温度参数,用于控制生成结果的随机程度。数值越高,生成结果多样性越强;数值越低,生成结果越稳定。请根据具体应用场景进行设置。

响应示例

JSON · 响应示例
{
  "id": "chatcmpl-xxxxxx",
  "object": "chat.completion",
  "model": "调用的模型名称",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "您好,我是……"
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 18,
    "completion_tokens": 42,
    "total_tokens": 60
  }
}

其中,usage 字段为本次调用的用量统计信息。平台将依据实际用量从账户余额中进行计费扣除。

通过 SDK 调用(Python 示例)

Python · OpenAI SDK
from openai import OpenAI

client = OpenAI(
    api_key="sk-您的令牌",
    base_url="https://cplicity.com/v1",
)

resp = client.chat.completions.create(
    model="模型广场公示的模型名称",
    messages=[{"role": "user", "content": "您好"}],
)
print(resp.choices[0].message.content)

其他编程语言的 OpenAI SDK 接入方式与上述示例一致,仅需修改 base_url 与 api_key 两项配置即可。

05

模型与价格

灿培平台提供覆盖对话、写作、代码、图像、音频、视频等场景的多类模型。各模型的名称及定价均以模型广场实时公示为准。本文档不提供固定价格清单;模型广场信息更新后即时生效,开发者应以实际调用时公示的定价为准。

  • 模型选型:开发者可在模型广场按应用场景与定价进行筛选,并查阅各模型的功能说明与计费方式。
  • 模型名称填写规范:调用时,model 参数须填写模型广场公示的模型名称,亦可通过 GET /v1/models 接口查询当前可用模型列表。
  • 定价说明:不同模型采用各自的计费方式(例如按 Token 用量计费或按次计费),具体以模型广场标注为准。
i

选型建议:对于日常对话与文本写作等场景,建议优先选用响应效率较高、成本较低的模型;对于复杂推理、长文本处理及代码生成等任务,建议选用能力更强的模型,以实现成本与效果的合理平衡。

访问模型广场,查阅全部模型及实时定价 →

06

计费与充值

灿培 API 采用按量计费模式。系统将依据所调用模型的计费方式统计实际用量,并从账户余额中据实扣除。

!

关于账户余额:API 令牌仅为调用凭证,账户余额为服务能否正常调用的决定因素。账户余额不足或耗尽时,接口调用将无法完成。因此,在正式接入前,请务必确认账户余额充足,并持续关注余额变动情况。

充值方式

  1. 添加官方客服微信 Tree3412,并向客服说明拟充值金额及对应账户信息。
  2. 按照客服指引完成付款操作。
  3. 经确认收款后,平台管理员将为相应账户完成充值。余额到账后,服务即可恢复正常调用。

充值业务仅通过官方客服微信 Tree3412 受理。请勿通过任何非官方渠道进行付款,以避免造成资金损失。

消费查询

开发者可在控制台中查询账户余额及调用记录,每次调用的用量与扣费明细均可查阅。如发现用量异常,请优先核查令牌是否存在泄露风险,相关处置方式请参阅「认证」章节。

07

错误码

接口调用失败时,系统将返回相应的 HTTP 状态码。开发者可依据下表所列状态码含义及处理建议进行排查:

状态码含义处理建议
401 令牌无效或缺失 请核查请求头是否已正确携带 Authorization: Bearer sk-…,并确认令牌内容完整且未被删除。如有必要,请在控制台重新创建令牌。
402 / 403 余额不足或无调用权限 该情况通常由账户余额不足,或当前令牌无权调用指定模型所致。请先在控制台核查账户余额,如余额不足请及时充值;同时确认模型名称及令牌信息是否准确。
429 请求频率过高 短时间内请求过于频繁。请适当降低调用频率后重试;对于批量任务,建议设置合理的请求间隔或采用队列机制进行处理。
500 服务端临时异常 请稍后重试。如该问题持续出现,请记录请求时间及错误信息,并联系官方客服协助处理。
i

建议排查顺序:状态码确认 → 账户余额核查 → 令牌有效性核查 → 模型名称核对。多数调用失败问题均可通过上述步骤定位。

08

常见问题

Q1如何创建令牌?令牌数量是否有限制?▾

登录 cplicity.com 并进入控制台,在「令牌管理」页面执行新建操作即可。开发者可按项目分别创建多枚令牌,各令牌相互独立、互不影响。不再使用的令牌可随时删除,删除后即时失效。

Q2接口调用失败时应如何排查?▾

请首先确认接口返回的状态码,并依次核查以下事项:① 账户余额是否充足;② 令牌是否准确且仍然有效;③ model 参数是否与模型广场公示的名称完全一致。结合「错误码」章节,通常可完成问题定位。

Q3流式输出与非流式输出有何区别?▾

非流式输出为默认模式,模型完成全部生成后一次性返回完整响应,接入方式较为简洁,适用于后台任务及批量处理场景。流式输出(stream: true)在生成过程中分段返回响应内容,适用于对话类界面,可显著缩短用户等待感知时间。两种模式的计费标准一致。

Q4图像、音频、视频类模型应如何调用?▾

该类模型具有各自独立的调用方式与参数规范,请严格按照模型广场中对应模型的说明进行调用,说明中将明确请求格式、参数要求及计费方式。如对接入方式存在疑问,建议先行查阅模型说明,或联系官方客服确认后实施接入。

Q5账户余额耗尽后有何影响?是否会产生欠费?▾

账户余额耗尽后,接口调用将直接失败并返回 402 / 403 状态码,不再继续产生费用,亦不会形成欠费。充值到账后,服务即可恢复正常调用。充值方式请参阅「计费与充值」章节。

Q6如怀疑令牌泄露,应如何处理?▾

请立即在控制台删除疑似泄露的令牌,并创建新令牌替换至应用程序中。原令牌删除后即时失效,第三方将无法继续使用。同时建议核查近期消费记录,以确认是否存在异常调用。

开始接入灿培 API

完成账户注册与令牌创建,即可按照本文档规范发起接口调用。

进入控制台 →