Screen API 接口文档

快速开始

先在产品页创建账号并在用户中心生成 API Token，再在请求头中携带 Bearer Token。

curl -X POST https://rustpoint.com/screen/api/markdown \
  -H "Authorization: Bearer sk_live_your_token" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com/article"}'

接口与鉴权

POSThttps://rustpoint.com/screen/api/markdown

Authorization：Bearer <API Token>

Content-Type：application/json

计费：每次成功处理或缓存命中调用扣减 1 次额度；失败请求退回额度。

请求参数

字段	类型	说明
url	string	必填，http 或 https 网页地址。
waitUntil	string	可选：load、domcontentloaded、networkidle，默认 networkidle。
timeoutMs	integer	可选，默认 30000，范围 1000–60000。
delayMs	integer	可选，额外等待页面渲染的毫秒数，范围 0–10000。
width / height	integer	可选，渲染视口；默认 1280×720。
deviceScaleFactor	integer	可选，默认 1，范围 1–3。

成功响应

HTTP 200 返回正文、页面元数据和调用后的用量信息。

{
  "ok": true,
  "markdown": {
    "url": "https://example.com/article",
    "title": "Article title",
    "markdown": "# Article title\\n\\n正文内容…",
    "textLength": 1280
  },
  "usage": {
    "totalQuota": 2500,
    "usedCalls": 1,
    "remainingCalls": 2499
  }
}

错误与支持

401 表示 Token 缺失或无效，402 表示额度不足，400 表示请求参数不正确，429 表示上游并发受限，5xx 表示服务处理失败。请不要在客户端代码、日志或公开仓库中保存 Token。

接口接入、账户、支付和故障问题请联系 [email protected]。