搜索文档

搜索数据工具、API 接入和计费指南。

选择Enter 打开Esc 关闭
Agent、CLI 与 REST API 接入
开始使用

Agent、CLI 与 REST API 接入

通过三种方式使用相同的 Sorit API。

Agent Skill

将下面的指令发给 Agent:

text
请读取 https://sorit.dev/SKILL.md,安装 Sorit Skill。

查看 Skill。在 API Key 页面创建密钥,在 Agent 运行环境中配置 SORIT_API_KEY,再复制 API 详情 Agent 页签中的调用指令。Skill 包含发现 API、查看参数、调用和获取结果的步骤。

Bun CLI

@sorit/cli 安装包已准备首次发布。发布后可使用下方安装命令,目前可先通过 REST 接入。

bash
bun install --global @sorit/cli
export SORIT_API_KEY='<YOUR_API_KEY>'
sorit discover --tool tiktok
sorit inspect '<API_ID>'
export SORIT_REQUEST_KEY="$(bun -e 'console.log(crypto.randomUUID())')"
sorit run '<API_ID>' --input @input.json \
  --idempotency-key "$SORIT_REQUEST_KEY" --wait
sorit get '<REQUEST_ID>' --wait

需要 Bun 1.2+。CLI 默认连接正式 API https://sorit.dev,只需配置 SORIT_API_KEY。本地开发通过环境变量 SORIT_URL 覆盖,例如 SORIT_URL=http://localhost:3010 sorit tools。input.json 应符合所选 API 的 inputSchema。每个 API 详情提供包含当前 ID 和参数的命令。通过 sorit --help 查看命令列表,sorit run --help 查看子命令帮助,sorit balance 查看积分。

搜索只返回可调用 API。已停用、未配置凭证或未完成映射的 API 不会出现在 CLI、REST 搜索结果、数量和筛选项中,接入状态统一在管理后台维护。

REST API

直接使用 HTTP,通过 Authorization: Bearer <SORIT_API_KEY> 鉴权。每个 API 详情的 API 页签提供请求、轮询示例和参数 Schema。

请求用途
GET /api/tools发现平台工具。
GET /api/endpoints?tool=tiktok&status=available&page=1列出 API,每页 24 项。
GET /api/tools/{apiId}查看参数、可用状态、价格和限制。
POST /api/jobs提交 {"kind":"<apiId>","input":{...}}。
GET /api/jobs/{request_id}获取状态、业务数据和积分信息。

提交 API ID 作为 kind,父级 tool ID 用于发现。原生参数仅按 Schema 声明放入 body、query、path。详见请求与响应文档。

结果与重试

queued、running 时继续轮询。succeeded 时读取 data,failed、rejected 时读取 error。credits 包含累计扣费与退款。三种方式共用账户余额和可用规则。

提交结果不明确时,保留原幂等键和相同参数重试。轮询超时不会取消调用,使用原 request_id 继续获取结果。