API 文档
提交目标 URL,异步获取 cf_clearance、turnstile_token、Cookie 与 User-Agent。本文档为本地静态页面,不依赖外部 CDN,适合 aaPanel 反向代理环境。
Base URL当前访问地址
鉴权方式
X-API-Key 请求头接口版本v1
如果你设置了
SOLVER_API_KEY,除 /v1/health 外,其它接口都必须携带 API Key。接口列表
GET/v1/health
健康检查
检查服务是否可用,并返回当前队列长度。此接口不需要 API Key。
curl BASE_URL/v1/health
{
"ok": true,
"queue": 0
}
POST/v1/solve需要 API Key
提交解算任务
提交目标页面 URL。可选传入 Turnstile sitekey、代理、超时时间等参数。
| 参数 | 必填 | 说明 |
|---|---|---|
url | 是 | 需要解算的目标页面 URL |
sitekey | 否 | Turnstile sitekey,用于自动注入验证组件 |
timeout | 否 | 超时时间,单位毫秒,默认 60000 |
proxy | 否 | 代理地址,例如 http://user:pass@ip:port |
curl -X POST BASE_URL/v1/solve \
-H "X-API-Key: 你的API_KEY" \
-H "Content-Type: application/json" \
-d '{"url":"https://example.com","sitekey":"0x4AAAAAA...","timeout":60000}'
{
"task_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"status": "pending"
}
GET/v1/result/{taskID}需要 API Key
查询任务结果
通过任务 ID 查询执行状态和最终结果。
curl BASE_URL/v1/result/任务ID \ -H "X-API-Key: 你的API_KEY"
{
"task_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"status": "completed",
"solution": {
"url": "https://example.com",
"status": 200,
"cookies": [],
"userAgent": "...",
"turnstile_token": "..."
},
"duration_ms": 12345
}
GET/v1/tasks需要 API Key
获取任务列表
返回当前命名空间最近的任务列表,主要供控制台使用。
curl BASE_URL/v1/tasks \ -H "X-API-Key: 你的API_KEY"
GET/v1/stats需要 API Key
获取统计信息
返回任务总数、成功数、失败数和等待中数量。
curl BASE_URL/v1/stats \ -H "X-API-Key: 你的API_KEY"
状态说明
| 状态 | 说明 |
|---|---|
pending | 任务已提交,等待 worker 处理 |
running | 任务正在执行 |
completed | 任务完成,可读取 solution |
failed | 任务失败,查看 error 字段 |