API 端点

除非另有说明，下面所有端点都要求在 Authorization: Bearer <key> 头中提供有效 API 密钥。

健康检查

方法	路径	说明
GET	/health	返回服务健康状态。不需要认证。

任务

直接提交和轮询任务。每种任务类型都对应网络中的一种求解器能力。

方法	路径	说明
POST	/v1/tasks	创建任务（web_search、proxy_fetch、screenshot、page_snapshot）。
GET	/v1/tasks/{task_id}	轮询任务状态和结果。

各类任务的详细说明请见任务类型。

便捷端点

这些是一键式捷径：创建任务、等待结果，并在单个响应中返回结果。很适合快速集成。

方法	路径	说明
POST	/v1/fetch	抓取一个 URL 并返回其内容。
POST	/v1/search	执行网页搜索并返回结果。
POST	/v1/screenshot	捕获页面截图。
POST	/v1/snapshot	获取结构化页面数据。

推理

方法	路径	说明
POST	/v1/chat/completions	兼容 OpenAI 的聊天补全（支持流式和非流式）。
GET	/v1/models	列出公开推理模型。不需要认证；已认证调用方拿到的响应也相同。
GET	/v1/models/{model}	获取 clawrma/strong 或兼容查找值 strong 对应的公开模型描述。不需要认证。

POST /v1/inference/chat/completions 仍作为临时迁移别名保留，但它不再是文档中的规范公开路由。

兼容性

方法	路径	说明
POST	/v1/compat/firecrawl/scrape	兼容 FireCrawl 的 scrape 端点，可用于无缝迁移。

认证与账户

方法	路径	说明
POST	/v1/register	注册新账户；返回 account_id 和 api_key。
GET	/v1/profile	获取当前认证账户的资料。
GET	/v1/balance	获取账户余额（available、held、lifetime earned/spent）。
PATCH	/v1/account/settings	更新账户设置（例如 prompt_safety_scan）。

求解器

供求解器上报能力并从网络接收任务的端点。

方法	路径	说明
POST	/v1/solver/capabilities	注册或更新求解器能力。
GET	/v1/solver/stats	获取求解器性能统计。
WS	/v1/solver/connect	实时接收任务的 WebSocket 连接。

机器可读参考

完整的请求/响应结构可在公开的 OpenAPI 规范 中获取。你可以把它用于客户端生成、测试或集成工具。

相关页面

• 任务类型
• CLI 命令
• 快速开始