开始使用
Revor AI API v2 提供 Connect 账号查询、单条触达、积分余额查询、Target 目标公司发现、企业研究和海关贸易数据查询。耗时操作采用异步任务,客户端提交后使用统一任务接口查询结果。
Base URL
https://revor.ai/api/v2
API v1 的 Connect 和 Outreach 接口暂时保留兼容。两个版本可以使用同一套 API Key,但新接入应使用 v2 路径,并确保 Key 具有对应接口权限。
鉴权
推荐使用 Authorization: Bearer header:
cURLcurl "https://revor.ai/api/v2/credits" \ -H "Authorization: Bearer sk-revor-REPLACE_ME"
也可以使用 x-api-key:
cURLcurl "https://revor.ai/api/v2/credits" \ -H "x-api-key: sk-revor-REPLACE_ME"
不要把 API Key 放在 URL、前端代码、公开仓库或日志中。
通用返回结构
成功响应包含 ok: true 和 request_id。列表通常返回 items,单个资源和异步任务通常返回 item。
JSON{ "ok": true, "request_id": "req_xxx", "item": {} }
错误响应包含稳定的公开错误码。联系支持或排查问题时请保留 request_id。
JSON{ "ok": false, "error": { "code": "invalid_request", "message": "invalid_request", "request_id": "req_xxx" } }
幂等键
Idempotency-Key 是可选的可靠重试能力。普通请求可以不发送;如果调用方可能在网络超时后自动重试,建议为同一次业务操作生成一个唯一值:
HttpIdempotency-Key: 2d1ed06a-4e63-4e36-9e88-53784bb61b0b
- 同一路径、同一 Key、相同请求体:返回第一次请求的结果,不重复创建任务。
- 同一路径、同一 Key、不同请求体:返回
409。 - 一次新的真实操作应生成新的幂等键;网络超时重试应复用原键。
- 不发送 Key:每次
POST都视为独立操作;相同请求被重复提交时会创建多个任务,并可能分别执行和计费。
异步任务与 Prefer wait
研究和海关接口通常返回 HTTP 202 Accepted。保存 item.id,然后轮询:
HttpGET /api/v2/jobs/{id}
如果调用方愿意短暂等待,可以在创建请求中加入:
HttpPrefer: wait=20
任务在等待时间内结束时,创建接口返回 HTTP 200 和终态任务;否则仍返回 HTTP 202。超时不代表任务失败,继续使用任务 ID 轮询即可。
接口列表
详细草稿:
推荐流程
单条触达
GET /connect/accounts?can_send=true取得可发送账号的account_id。- 调用
POST /outreach/dispatches或 LinkedIn 点赞接口;需要安全重试时可发送Idempotency-Key。 - 保存响应中的
item.id,轮询GET /jobs/{id}。 - 状态为
succeeded时读取item.result;状态为failed时读取item.error.code。
Target 目标公司发现
GET /credits确认可用积分。POST /websets创建 Target,保存响应中的webset.id。- 轮询
GET /websets/{id},直到completed、failed或cancelled。 - 使用
GET /websets/{id}/items?detail=compact&limit=10分页读取结果。
preparation_job.id 只用于确认 Target 是否成功启动,不代表目标公司发现已经完成。
研究和海关任务
- 提交创建请求;需要安全重试时可发送
Idempotency-Key。 - 读取响应中的
item.id。 - 如果
item.status不是终态,轮询GET /jobs/{id}。 - 当状态为
succeeded时读取item.result和item.billing。