Docs/IDE 集成与 API/API 参考总览

CodePus API 参考总览

CodePus 提供与 OpenAI 协议兼容的官方 AI 网关，你可以在 IDE 客户端或任意第三方程序中，使用账号颁发的 API Key（前缀 cpk_）访问。

快速开始

  • 创建 API Key：前往 API Key 管理，生成以 cpk_ 开头的密钥。
  • 配置 Base URL：参考 代理 Base URL 配置，将客户端指向 CodePus 网关。
  • 发起调用：按 OpenAI 兼容接口 的协议发送请求。

    • 核心文档

  • API 网关接入 — 网关地址、鉴权方式与请求规范。
  • OpenAI 兼容接口 — /v1/chat/completions 等端点的兼容说明。
  • 代理 Base URL 配置 — 在 IDE 或第三方工具中设置 proxyBaseUrl。
  • API Key 管理 — 创建、轮换与吊销 cpk_ 密钥。
  • 配额与加包 — Credits 配额、限流与加包策略。
  • IDE 登录与设备绑定 — 设备授权与登录流程。
  • IDE 集成故障排除 — 常见错误码与排查方法。

    • 鉴权

    所有请求需在 HTTP 头携带：
    Authorization: Bearer cpk_xxxxxxxxxxxxxxxx

    遇到问题？

    查看 IDE 集成故障排除 或前往 联系支持。
    ← Πίσω to DocumentationFeedback on this σελίδα