6 API —— 让 AI 帮你自主建仓库、传文件、提交、部署
把本页地址 https://3000-d1b989576e3c4b1c85c66a6c82196129.e2b.bj6.sandbox.cloudstudio.club/api 和下面的 API Token 一起发给你使用的 AI
(如 ChatGPT / Claude / 其他助手),它就能阅读本文档、调用接口,自动完成建站。
你的 API Token
请先 登录 后生成 API Token。
认证方式
所有 /api/v1/* 接口都需要在请求头携带你的 Token:
Authorization: Bearer <你的API_TOKEN>
通过 Token 创建/修改的仓库都属于你的账号。返回均为 JSON,成功含 "ok": true,失败含 "ok": false 与 "error"。
令牌也可通过 X-API-Token 请求头传递(用于 Authorization 头被 CDN/网关剥离的环境);令牌只走请求头,不进 URL。
接口一览
| 方法 | 路径 | 说明 |
|---|---|---|
| GET | /api/v1/repos | 列出我的仓库 |
| POST | /api/v1/repos | 创建仓库 {name, description, visibility} |
| GET | /api/v1/repos/<name> | 仓库信息 + 文件列表 + 分支 + head |
| PUT/POST | /api/v1/repos/<name>/files/<path> | 创建/更新文件 {content 或 content_base64} |
| GET | /api/v1/repos/<name>/files/<path> | 读取文件内容 |
| DELETE | /api/v1/repos/<name>/files/<path> | 删除文件 |
| POST | /api/v1/repos/<name>/commit | 提交 {message, branch} |
| POST | /api/v1/repos/<name>/deploy | 部署为静态站点 {commit, message} |
| GET | /api/v1/repos/<name>/deployments | 部署记录 |
| POST | /api/v1/repos/<name>/branches | 创建分支 {branch, from} |
完整示例:让 AI 一键建站
下面是一条从零建仓库到部署上线的完整流程(把 TOKEN 换成你的令牌):
# 1. 创建仓库
curl -X POST https://3000-d1b989576e3c4b1c85c66a6c82196129.e2b.bj6.sandbox.cloudstudio.club/api/v1/repos \
-H "Authorization: Bearer TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"mysite","description":"我的站点","visibility":"public"}'
# 2. 写入首页
curl -X PUT https://3000-d1b989576e3c4b1c85c66a6c82196129.e2b.bj6.sandbox.cloudstudio.club/api/v1/repos/mysite/files/index.html \
-H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" \
-d '{"content":"<h1>Hello from AI</h1>"}'
# 3. 写入样式(支持 static/app.css 这类嵌套路径)
curl -X PUT https://3000-d1b989576e3c4b1c85c66a6c82196129.e2b.bj6.sandbox.cloudstudio.club/api/v1/repos/mysite/files/static/app.css \
-H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" \
-d '{"content":"h1{color:var(--accent)}"}'
# 4. 提交
curl -X POST https://3000-d1b989576e3c4b1c85c66a6c82196129.e2b.bj6.sandbox.cloudstudio.club/api/v1/repos/mysite/commit \
-H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" \
-d '{"message":"init site"}'
# 5. 部署,返回 preview_url
curl -X POST https://3000-d1b989576e3c4b1c85c66a6c82196129.e2b.bj6.sandbox.cloudstudio.club/api/v1/repos/mysite/deploy \
-H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" \
-d '{"message":"v1"}'
# 之后访客访问 https://3000-d1b989576e3c4b1c85c66a6c82196129.e2b.bj6.sandbox.cloudstudio.club/site/mysite 即可看到站点
说明
当前 API 部署为静态站点(只发布文件、不执行代码,安全可控)。
二进制文件用 content_base64 上传。全栈(后端运行)为后续阶段。
若请求被 CDN/WAF 拦截(返回 403 拦截页),多因请求体包含 HTML 代码被判定为攻击。
解决:HTML/XML 文件改用 content_base64(Base64 编码后传入);
文件写入的 PUT 若被拦截,可改用 POST(同一地址、同一参数);
若 Authorization 头被网关剥离(返回 401),改用 X-API-Token 头传令牌(令牌只走请求头,不进 URL)。