1ms.tools
API

链接预览 API

通过 URL 获取网页链接预览信息，将标题、描述和分享图片等数据接入链接收藏、内容管理或消息展示。

成功任务 1 积分 / 次对外调用 10 次 / 分钟 / 账号
获取 API Key在线试用工具API 文档

适合怎样的系统接入

适合内容聚合、链接收藏和编辑审核。提交页面 URL 后获取预览信息，你的应用自行选择渲染样式，并按需要保留来源和检测记录。

请求示例

将示例密钥替换为控制台创建的密钥。输入仅作为接入示例，完整字段和校验规则见 API 文档。

POST /openapi/tools/link-preview/execute
curl 'https://1ms.tools/openapi/tools/link-preview/execute' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: YOUR_UNIQUE_REQUEST_ID' \
  -d '{"url":"https://example.com"}'
异步响应与结果获取

请求接受后返回 HTTP 202 和任务信息。此时任务尚未完成，示例只列出常用字段。

{
  "code": 0,
  "message": "ok",
  "data": {
    "id": "JOB_ID",
    "status": "queued",
    "result": null,
    "creditCost": 1,
    "pollAfterMs": 6000,
    "statusUrl": "/openapi/jobs/JOB_ID"
  }
}

至少等待 6 秒后使用同一密钥查询。状态为 succeeded 时读取 result；failed 或 canceled 时读取 error。

curl 'https://1ms.tools/openapi/jobs/JOB_ID' \
  -H 'Authorization: Bearer YOUR_API_KEY'

检测预览与第三方社交平台的最终渲染可能不同；平台缓存与抓取规则不由本接口控制。

API 接入常见问题

使用 Authorization: Bearer YOUR_API_KEY 或 X-API-Key 请求头。对外接口必须提供有效密钥，网页 Cookie 无法替代。请将密钥保存在服务器或可信应用环境中。

创建任务时预扣 1 积分，任务成功后完成计费。输入校验失败或积分不足时不创建任务；执行失败、超时或取消排队任务会退款。任务查询不扣积分，但计入调用次数。

本接口使用异步任务，先返回 HTTP 202 和 Job ID。通过返回的 statusUrl 获取状态，成功后读取 result。建议使用 Idempotency-Key 处理提交重试。

每个账号每自然分钟最多 10 次对外业务请求，所有 Key 共用额度，与网页请求计数分开。任务查询、上传和执行都计入额度；遇到 429 时遵守 Retry-After。