JKJikouAPI文档进入控制台
文档目录
本页目录

开始使用

JikouAPI 文档

从创建 API 密钥、确认接口地址和发现模型开始,再按技术栈接入 OpenAI、Claude、Gemini、Codex 或 Claude Code。上线前请同时检查错误处理与密钥安全。

开始接入

首次接入建议按顺序完成下面三页,每一步都有可验证结果。

核心 API

SDK 与客户端

运行与维护

地址速查

用途地址或路径
OpenAI Base URL
Anthropic Base URL
查询模型GET /v1/models
文本对话POST /v1/chat/completions
ResponsesPOST /v1/responses
图像生成POST /v1/images/generations

开始使用

快速开始

用一次最小请求确认接口地址、API 密钥与模型 ID 都可用。

准备工作

创建密钥

在控制台“API 密钥”页面创建密钥。

选择分组

选择支持目标协议和模型的分组。

查询模型

复制模型接口实际返回的模型 ID。

发送第一个请求

先用 OpenAI 兼容请求排除客户端配置问题。

cURL

成功时会返回 JSON。失败时先记录状态码和错误信息,再查看“错误与重试”。

开始使用

API 密钥与权限

API 密钥代表调用权限和费用归属。按设备或应用隔离密钥,可以降低泄露影响。

身份认证

OpenAI 兼容接口推荐使用标准 Bearer 请求头:

HTTP Header
Authorization: Bearer sk-你的密钥

Anthropic 客户端也可能使用 x-api-key;Gemini 客户端可能使用 x-goog-api-key

密钥安全

  • 不要把密钥写入网页前端、公开仓库、截图、日志或聊天记录。
  • 服务端使用环境变量或密钥管理服务,不要硬编码。
  • 为不同应用创建不同密钥,疑似泄露时立即撤销并轮换。
  • 不要通过 URL 查询参数传递密钥。

核心 API

模型与能力

密钥所属分组决定可调用的模型。不要猜测模型名称,应以模型接口实时返回为准。

查询可用模型

OpenAI / Anthropic 分组
Gemini 原生协议

选择模型

复制响应中 data[].id 的完整值,填入请求的 model 字段。不同密钥看到不同列表通常是分组权限所致。

核心 API

文本 API

根据上游分组和客户端选择 OpenAI、Anthropic 或 Gemini 兼容协议。

选择协议

Base URL主要端点
cURL

流式响应

需要流式输出时可在请求中加入 "stream": true。客户端既要检查 HTTP 状态码,也要处理流中断和流内错误。

核心 API

图像生成 API

通过 OpenAI 兼容端点生成图像。可用模型和参数由密钥分组及上游模型决定。

生成图像

cURL

返回可能包含 URL 或 Base64 数据,取决于模型和 response_format 支持情况。

使用注意

  • 先通过模型列表确认图像模型 ID。
  • 图像请求通常更慢,应设置更长但有限的超时。
  • 不要对超时请求无限重试,以免产生重复费用。

集成

开发 SDK

兼容 OpenAI SDK 的客户端通常只需替换 API Key、Base URL 与模型 ID。

Python

安装
pip install openai
Python

使用环境变量

生产环境不要在源代码中写真实密钥。将密钥放入服务器环境变量,并确保日志、错误页面和构建产物不会输出该值。

集成

Codex、Claude Code 与 CC Switch

项目的“API 密钥”页面已经提供“导入到 CCS”按钮。下面是使用该按钮的教程,不需要手动拼接链接。

开始前

先安装并启动 CC Switch,然后登录控制台。导入操作会唤起本机的 ccswitch:// 协议,浏览器询问时允许打开。

连接教程

连接 Codex

  1. 进入 API 密钥 页面。
  2. 找到属于 OpenAI 分组的密钥。
  3. 点击右侧 导入到 CCS
  4. 在 CC Switch 中确认导入并启用。
  5. 重新打开终端,运行 codex
切换模型

在 Codex 中用 /model 切换,或用 codex -m 模型ID 启动。只能选择当前密钥分组支持的模型。

连接 Claude Code

  1. 进入 API 密钥 页面。
  2. 找到支持 Anthropic Messages 的密钥。
  3. 点击右侧 导入到 CCS
  4. 在 CC Switch 的 Claude 页面启用。
  5. 重新打开终端,运行 claude
让配置生效

Claude Code 会读取 CC Switch 写入的环境配置,切换提供商后建议重新打开终端。

帮助

错误与重试

先根据状态码区分请求、权限、额度与服务异常,再决定是否重试。

常见状态码

状态码常见原因处理建议
400JSON、参数或模型错误核对请求体、端点和模型列表
401缺少密钥或密钥无效检查认证头和密钥状态
403当前密钥没有权限检查分组、白名单和有效期
404路径不存在或协议不支持检查 Base URL 与 endpoint
429频率、并发或余额受限降低并发,检查额度后有限重试
5xx服务或上游暂时异常记录请求信息并退避重试

重试原则

只对 429、网络瞬断和部分 5xx 有限重试。建议指数退避并加入随机抖动,例如等待 1、2、4 秒,最多尝试 3 次。400、401、403 不应自动重试。

帮助

排错与安全

用最小请求把客户端、网络、反向代理和上游问题分开定位,并保持文档站与 API 系统隔离。

最小化排错

  1. 先用“快速开始”的 cURL 测试,绕开第三方客户端。
  2. 请求模型列表,确认 API 地址、密钥和分组权限。
  3. 复制返回的模型 ID,再发送最短文本请求。
  4. 若 cURL 成功但客户端失败,检查 Base URL 是否重复包含 /v1

文档站部署安全

  • 使用独立静态站点,例如 docs.jikouapi.com
  • 只上传公开静态文件,不上传配置、数据库备份、源码或密钥。
  • 开启 HTTPS,并配置 CSP、nosniff 和 Referrer Policy。
  • 文档站无需数据库写权限,也不应拥有 API 服务器环境变量。
  • 控制台顶部“文档链接”直接跳转,避免携带登录 token 的 iframe 嵌入。