Copy page

开始使用

概览

CapWorks API

这里是 CapWorks 所有公开和内部服务接口的统一入口。页面不是一份手写快照：构建前会从 Worker 路由、共享 TypeScript 契约、Better Auth 配置和 OpenConnector 源码重新生成规范，并检查是否存在漏记的业务路由。

接口面	规范	内容
CapWorks HTTP API	OpenAPI 3.1	项目、会话、成果、记忆、团队、语音、计费和集成
Better Auth API	OpenAPI 3.1	Email OTP、Google OAuth、会话与账户
实时 API	AsyncAPI 3.0	会话事件、成果协作、实时转写
OpenConnector API	OpenAPI 3.1	Provider、Action、Connection、Proxy、MCP 和运行时令牌

服务地址

• 在线文档同源代理：https://capworks-api-docs.pages.dev/proxy/capworks
• Web 开发环境代理：https://capworks-web-dev.pages.dev/api
• 本地 Worker：http://localhost:8787
• OpenConnector 开发环境：https://connector-admin-dev.capworks.ai

最小请求

健康检查不需要登录：

Code
curl https://capworks-api-docs.pages.dev/proxy/capworks/healthz

在文档站内测试业务接口时，先打开登录 / API 测试完成 Email OTP 登录。会话 Cookie 会由浏览器自动保存，之后点击 API Reference 中的 Test 即可发送受保护请求，不需要粘贴 Token。

业务接口依赖 Better Auth 的 HttpOnly 会话 Cookie。其他浏览器客户端应使用 credentials: 'include'：

Code
const response = await fetch('https://capworks-web-dev.pages.dev/api/v1/account/current', {
  credentials: 'include',
});

if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const account = await response.json();

下一步先阅读身份认证和通用约定，再进入对应的 API Reference。