开发者资源 / API

通过 API 连接你的工作空间。

通过 Octrieve 客户 API 创建任务、查询进度、读取结果和导出 CSV,沿用网站账户的积分与套餐限制。

所有注册账户均可使用客户 API 和 API Key MCP。

客户 API + MCP

从密钥到真实结果。

创建有权限范围的密钥

登录后创建密钥,保存到 MCP 客户端或服务器的密钥存储中,并查询可用模式与积分。

01
按预算运行任务

确认目标和 maxCredits,使用 UUID 创建任务并轮询任务 ID,重试时保留相同 UUID。

02
读取或下载结果

分页读取 JSON 结果,或在任务结束后导出 CSV;MCP 会提供短时下载链接。

03

连接到你的工作空间。

创建密钥并查询可用能力,再用 UUID 和明确积分预算启动任务。轮询返回的任务 ID,完成后导出。

REST 快速开始

curl 'https://octrieve.com/api/v1/capabilities' \
  -H "Authorization: Bearer $OCTRIEVE_API_KEY"

curl 'https://octrieve.com/api/v1/jobs' \
  -H "Authorization: Bearer $OCTRIEVE_API_KEY" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: 5f91520e-3e40-4f72-80e8-e559a5e3c1a0' \
  -d '{"platform":"x","direction":"followers",
       "target":"example","maxCredits":10}'

轮询、读取与导出

# Replace JOB_ID with the returned data.id.
curl 'https://octrieve.com/api/v1/jobs/JOB_ID' \
  -H "Authorization: Bearer $OCTRIEVE_API_KEY"

curl 'https://octrieve.com/api/v1/jobs/JOB_ID/results?pageSize=20' \
  -H "Authorization: Bearer $OCTRIEVE_API_KEY"

curl 'https://octrieve.com/api/v1/jobs/JOB_ID/export' \
  -H "Authorization: Bearer $OCTRIEVE_API_KEY" \
  -o results.csv

错误与限流

HTTP/1.1 409 Conflict
X-Request-Id: <request UUID>
{"code":-1,"message":"insufficient_credits"}

HTTP/1.1 429 Too Many Requests
Retry-After: 2
X-Request-Id: <request UUID>
{"code":-1,"message":"rate_limited"}

凭证请存入客户端的安全环境。读取返回 JSON,CSV 使用流式下载。超时后用相同 UUID 和输入重试,不要盲目创建替代任务。限流返回 429 和 Retry-After,业务冲突返回 409。

开发者资源 / API

统一流程,共用账户额度。

版本化 REST 接口

使用客户 Bearer 密钥调用 /api/v1,先查询可用能力与账户当前额度。

异步执行,安全重试

创建后返回任务 ID;遇到不确定响应时,使用相同 Idempotency-Key 和输入重试。

JSON 结果与 CSV 导出

每页读取最多 100 条记录,或在任务结束后流式导出 CSV。

从授权开始,到结果交付。

读取已有数据可使用只读密钥;需要 AI 助手创建任务时再选择读写权限。

  1. 01

    创建有权限范围的密钥

    登录后创建密钥,保存到 MCP 客户端或服务器的密钥存储中,并查询可用模式与积分。

  2. 02

    按预算运行任务

    确认目标和 maxCredits,使用 UUID 创建任务并轮询任务 ID,重试时保留相同 UUID。

  3. 03

    读取或下载结果

    分页读取 JSON 结果,或在任务结束后导出 CSV;MCP 会提供短时下载链接。

开发者资源 / API

给助手一个可靠的起点。

先阅读当前文档,再确认权限和用户预算,然后创建任务。

阅读 agents.md

你可能想了解。

现在可以通过 API 或 MCP 连接吗?

可以。注册账户可创建客户 API 密钥,通过 REST、支持 Bearer 请求头的 MCP 客户端或独立 stdio 桥接连接。网站管理员可关闭访问。

支持仅使用 OAuth 的 MCP 客户端吗?

本版本使用预先创建的 API 密钥,不提供 OAuth 登录和授权流程。请使用支持 Bearer 请求头或本地 stdio 进程的客户端。

API 或 MCP 必须购买付费套餐吗?

不需要。Free、Pro 和 Max 沿用网站相同的额度和模式限制,年付套餐仍按月发放积分。创建任务需要读写密钥和明确预算。

可以让 AI 补全缺失的联系信息吗?

请让助手标注缺失信息,而不是猜测。采集到的邮箱不代表一定可投递,导出文件也不应被视为已通过验证的证明。