seishi1 commited on
Commit
0e62dfb
·
1 Parent(s): 6f9f0a1

adding correct readme

Browse files
Files changed (1) hide show
  1. README.md +8 -191
README.md CHANGED
@@ -1,191 +1,8 @@
1
- <p align="right">
2
- <strong>中文</strong>
3
- </p>
4
- <div align="center">
5
-
6
- # kilo2api
7
-
8
- _觉得有点意思的话 别忘了点个 ⭐_
9
-
10
- <a href="https://t.me/+LGKwlC_xa-E5ZDk9">
11
- <img src="https://telegram.org/img/website_icon.svg" width="16" height="16" style="vertical-align: middle;">
12
- <span style="text-decoration: none; font-size: 12px; color: #0088cc; vertical-align: middle;">Telegram 交流群</span>
13
- </a>
14
-
15
- <sup><i>(原`coze-discord-proxy`交流群, 此项目仍可进此群**交流** / **反馈bug**)</i></sup>
16
- <sup><i>(群内提供公益API、AI机器人)</i></sup>
17
-
18
- </div>
19
-
20
- ## 功能
21
-
22
- - [x] 支持对话接口(流式/非流式)(`/chat/completions`),详情查看[支持模型](#支持模型)
23
- - [x] 支持识别**图片**多轮对话
24
- - [x] 支持自定义请求头校验值(Authorization)
25
- - [x] 支持cookie池(随机),详情查看[获取cookie](#cookie获取方式)
26
- - [x] 支持请求失败自动切换cookie重试(需配置cookie池)
27
- - [x] 可配置代理请求(环境变量`PROXY_URL`)
28
-
29
- ### 接口文档:
30
-
31
-
32
-
33
- ### 示例:
34
-
35
-
36
-
37
- ## 如何使用
38
-
39
-
40
-
41
- ## 如何集成NextChat
42
-
43
-
44
-
45
- ## 如何集成one-api
46
-
47
-
48
-
49
- ## 部署
50
-
51
- ### 基于 Docker-Compose(All In One) 进行部署
52
-
53
- ```shell
54
- docker-compose pull && docker-compose up -d
55
- ```
56
-
57
- #### docker-compose.yml
58
-
59
- ```docker
60
- version: '3.4'
61
-
62
- services:
63
- kilo2api:
64
- image: deanxv/kilo2api:latest
65
- container_name: kilo2api
66
- restart: always
67
- ports:
68
- - "7099:7099"
69
- volumes:
70
- - ./data:/app/kilo2api/data
71
- environment:
72
- - KL_COOKIE=****** # cookie (多个请以,分隔)
73
- - API_SECRET=123456 # [可选]接口密钥-修改此行为请求头校验的值(多个请以,分隔)
74
- - TZ=Asia/Shanghai
75
- ```
76
-
77
- ### 基于 Docker 进行部署
78
-
79
- ```docker
80
- docker run --name kilo2api -d --restart always \
81
- -p 7099:7099 \
82
- -v $(pwd)/data:/app/kilo2api/data \
83
- -e KL_COOKIE=***** \
84
- -e API_SECRET="123456" \
85
- -e TZ=Asia/Shanghai \
86
- deanxv/kilo2api
87
- ```
88
-
89
- 其中`API_SECRET`、`KL_COOKIE`修改为自己的。
90
-
91
- 如果上面的镜像无法拉取,可以尝试使用 GitHub 的 Docker 镜像,将上面的`deanxv/kilo2api`替换为
92
- `ghcr.io/deanxv/kilo2api`即可。
93
-
94
- ### 部署到第三方平台
95
-
96
- <details>
97
- <summary><strong>部署到 Zeabur</strong></summary>
98
- <div>
99
-
100
- [![Deployed on Zeabur](https://zeabur.com/deployed-on-zeabur-dark.svg)](https://zeabur.com?referralCode=deanxv&utm_source=deanxv)
101
-
102
- > Zeabur 的服务器在国外,自动解决了网络的问题,~~同时免费的额度也足够个人使用~~
103
-
104
- 1. 首先 **fork** 一份代码。
105
- 2. 进入 [Zeabur](https://zeabur.com?referralCode=deanxv),使用github登录,进入控制台。
106
- 3. 在 Service -> Add Service,选择 Git(第一次使用需要先授权),选择你 fork 的仓库。
107
- 4. Deploy 会自动开始,先取消。
108
- 5. 添加环境变量
109
-
110
- `KL_COOKIE:******` cookie (多个请以,分隔)
111
-
112
- `API_SECRET:123456` [可选]接口密钥-修改此行为请求头校验的值(多个请以,分隔)(与openai-API-KEY用法一致)
113
-
114
- 保存。
115
-
116
- 6. 选择 Redeploy。
117
-
118
- </div>
119
-
120
-
121
- </details>
122
-
123
- <details>
124
- <summary><strong>部署到 Render</strong></summary>
125
- <div>
126
-
127
- > Render 提供免费额度,绑卡后可以进一步提升额度
128
-
129
- Render 可以直接部署 docker 镜像,不需要 fork 仓库:[Render](https://dashboard.render.com)
130
-
131
- </div>
132
- </details>
133
-
134
- ## 配置
135
-
136
- ### 环境变量
137
-
138
- 1. `PORT=7099` [可选]端口,默认为7099
139
- 2. `DEBUG=true` [可选]DEBUG模式,可打印更多信息[true:打开、false:关闭]
140
- 3. `API_SECRET=123456` [可选]接口密钥-修改此行为请求头(Authorization)校验的值(同API-KEY)(多个请以,分隔)
141
- 4. `KL_COOKIE=******` cookie (多个请以,分隔)
142
- 5. `REQUEST_RATE_LIMIT=60` [可选]每分钟下的单ip请求速率限制,默认:60次/min
143
- 6. `PROXY_URL=http://127.0.0.1:10801` [可选]代理
144
- 6. `USER_AGENT=Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome` [可选]请求标识,用自己的(可能)防封,默认使用作者的。
145
- 7. `ROUTE_PREFIX=hf` [可选]路由前缀,默认为空,添加该变量后的接口示例:`/hf/v1/chat/completions`
146
- 8. `RATE_LIMIT_COOKIE_LOCK_DURATION=600` [可选]到达速率限制的cookie禁用时间,默认为60s
147
-
148
- ### cookie获取方式
149
-
150
- 1. 打开[kilocode](https://kilocode.ai/profile)。
151
- 2. 打开**F12**开发者工具。
152
- 3. 使用Google登录
153
- <span><img src="docs/img.png" width="800"/></span>
154
- 4. 右侧开发者工具-控制台,执行如下代码。
155
-
156
- ```
157
- document.querySelector('a[href^="vscode://kilocode.kilo-code/kilocode?token="]').href.split('token=')[1]
158
- ```
159
-
160
- 5. 打印的值即所需cookie值,即环境变量`KL_COOKIE`。
161
- <span><img src="docs/img2.png" width="800"/></span>
162
-
163
- ## 进阶配置
164
-
165
-
166
-
167
- ## 支持模型
168
-
169
- > 新用户绑卡即可获赠 $20 使用额度。如未自动到账,请前往[官方 Discord 服务器](https://discord.com/invite/Ja6BkfyTzJ),在[指定频道](https://discord.com/channels/1349288496988160052/1355527689272033391)提交注册邮箱��审核通过后额度将添加至账户。
170
-
171
- | 模型名称 |
172
- |-------------------------------------|
173
- | claude-3-7-sonnet-20250219 |
174
- | claude-3-7-sonnet-20250219-thinking |
175
- | gemini-2.5-pro-preview-03-25 |
176
- | gpt-4.1 |
177
-
178
- > 可通过下图获取并保存`__Secure-next-auth.session-token`随时在[kilo查询平台](https://kl.aytsao.cn/)查询余额。
179
-
180
- <span><img src="docs/img1.png" width="400"/></span>
181
-
182
- <span><img src="docs/img3.png" width="400"/></span>
183
-
184
-
185
- ## 报错排查
186
-
187
-
188
-
189
- ## 其他
190
-
191
-
 
1
+ ---
2
+ title: k2api
3
+ emoji: 📈
4
+ colorFrom: red
5
+ colorTo: blue
6
+ sdk: docker
7
+ pinned: false
8
+ ---