把数小探接进你自己的系统

控制台里能做的事,大多也能用接口做:注册与管理客户端、派发任务、读运行日志、订阅实时事件。鉴权用 API Key 换令牌。

先拿一把 API Key

登录后在「API 密钥」页创建,创建时必须勾选 agent scope —— 不勾这一项,换令牌那一步会直接 403。密钥只在创建时完整显示一次 —— 当场复制保存,之后只看得到前缀。

换令牌再调接口

把 API Key 发给 POST /api/v1/agents/auth 换取访问令牌,后续接口用该令牌调用。这一步存在的理由是让长期密钥不必出现在每一次请求里。

当前开放的能力

客户端注册与查询、任务派发(自动择机或指定客户端)、运行日志读取、任务历次运行查询,以及实时事件的 SSE 流。控制台的其余功能仍以网页端为准。

任务列表 GET /api/v1/sync-tasks

拿到你名下的全部同步任务。默认只返回自己的;团队主与团队 admin 可以传 scope=team 看整个团队,普通成员传了会被降回 mine(不报错,但也看不到别人的)。

任务详情 GET /api/v1/sync-tasks/{task_id}

单个任务的完整配置,字段与列表里的每一项一致。这一条对团队管理者只读放行 —— 队里成员的任务跑挂了,管理者点开失败通知能看到详情,但改、删、运行、停止仍然只有归属人自己能做。

手动运行 POST /api/v1/sync-tasks/{task_id}/run

立刻派发一次执行,不等定时。服务端只负责派发,真正跑采集的是你本机的桌面客户端 —— 所以「没有在线客户端」是一种正常返回而不是错误:HTTP 仍是 200,靠 dispatched 字段判断。

停止运行 POST /api/v1/sync-tasks/{task_id}/stop

给你所有在线客户端广播一条取消指令,同时把该任务下 pending / running / accepted 的运行记录就地标记为 cancelled —— 不必等客户端回报,控制台和接口读到的状态立刻一致。

读取结果 GET /api/v1/data-records

任务跑出来的数据行。按 task_id 查,可以再按某一次执行(task_run_id)或同步状态过滤。这是「不接飞书也能把数据取走」的那条路。

结果统计 GET /api/v1/data-records/stats

不想把几千行拉下来只为看一眼跑没跑完时用这条。四个计数口径固定:写出成功的算 synced,写出报错的算 failed,其余都算 pending。

错误码

所有错误都是标准 HTTP 状态码 + JSON 体里的 detail。有一类例外要特别注意:手动运行「没有在线客户端」返回的是 200 而不是错误码,判断要看 dispatched 字段。

边界说明

接口面正在按需扩展,本页只列**当前真实可用**的部分 —— 没有「即将开放」的占位。需要的能力不在其中,欢迎通过数据服务页告诉我们。

建密钥

控制台 → API 密钥 → 新建,当场保存完整密钥

换令牌

POST /api/v1/agents/auth,请求头带 X-API-Key

调用接口

用返回的令牌访问客户端与任务相关接口

订阅事件

需要实时性时用 SSE 流,避免轮询

有 SDK 吗?

暂时没有。接口是标准 HTTP + JSON,用任意语言的 HTTP 客户端即可;有 SDK 需求欢迎告诉我们,会按呼声排期。

密钥泄露了怎么办?

在「API 密钥」页停用即可立即失效。密钥在服务端只存哈希,我们也看不到明文,所以无法帮你找回 —— 只能重建。

接口调用算配额吗?

派发任务最终会产生任务运行,按套餐的月度任务运行次数计费;查询类接口不额外计费。