使用方法

系统本身开箱即用。

可通过环境变量 / 命令行参数 / 配置文件进行配置。 若使用配置文件，请在程序同目录下创建 config.yaml（默认读取的配置文件路径，也可通过 --config <路径> 参数指定其他位置）。

系统启动后，使用 root 登录并进行进一步配置。初始密码由 ROOT_PASSWORD 指定，未设置时由程序随机生成并打印在首次启动日志中，详见部署说明。

API 调用

在渠道页面中添加供应商 API Key，之后在令牌页面中新增访问令牌。

随后即可使用该令牌访问 Capkii。

OpenAI API

使用方式与 OpenAI API 一致。

在各类使用 OpenAI API 的场景中，将 API Base 设置为 Capkii 的部署地址，例如：https://your-capkii-domain.com，API Key 则为在 Capkii 中生成的令牌。

注意

API Base 的具体格式取决于所使用的客户端，请尝试如下地址：

• https://your-capkii-domain.com
• https://your-capkii-domain.com/v1
• https://your-capkii-domain.com/v1/chat/completions

使用示例

curl --request POST \
    --url https://your-capkii-domain.com/v1/chat/completions \
    --header 'Authorization: Bearer sk-替换为你的key' \
    -H "Content-Type: application/json" \
    --data '{
      "model": "gpt-4o-mini",
      "messages": [
          {
              "role": "user",
              "content": "hi~"
          }
      ]
  }'

Claude API

使用方式与 Claude API 一致。

在各类使用 Claude API 的场景中，将 API Base 设置为 Capkii 的部署地址，例如：https://your-capkii-domain.com/claude，API Key 则为在 Capkii 中生成的令牌。

使用示例

curl --request POST \
    --url https://your-capkii-domain.com/claude/v1/messages \
    -H "Content-Type: application/json" \
    -H "x-api-key: sk-替换为你的key" \
    --data '{
  "model": "claude-3-haiku-20240307",
  "max_tokens": 1024,
  "messages": [
    {
      "role": "user",
      "content": "hi~"
    }
  ]
}'

Gemini API

在各类使用 Gemini API 的场景中，将 API Base 设置为 Capkii 的部署地址，例如：https://your-capkii-domain.com/gemini，API Key 则为在 Capkii 中生成的令牌。

使用示例

curl --request POST \
  --url https://your-capkii-domain.com/gemini/v1alpha/models/gemini-2.0-pro-exp:generateContent \
  --header 'Content-Type: application/json' \
  --header 'x-goog-api-key: sk-替换为你的key' \
  --data '{
	"contents": [

		{
			"role": "user",
			"parts": [
				{
					"text": "hi~"
				}
			]
		}
	]
}'