API 参考
概览
所有接口都围绕异步 job 与 result 模型组织；创建型接口返回 job，对应结果通过 result 资源读取。
资源分组
请求模式
- 创建型接口：POST -> 返回 job 对象。
- 查询型接口：GET list / GET item / GET result。
- 控制型接口：PATCH 更新任务开关，DELETE 删除任务。
- 用量：使用单资源读取，不走 list envelope。
- 接入与鉴权：GET /whoami 读取当前身份，GET /keys 列出现有 Key，POST /keys 创建新 Key，POST /auth/rotate 与 /auth/revoke 管理当前 Token。
入口
POST
POST /community-discovery/jobs
创建一个新的找社区异步任务。
查看详情
GET
GET /community-discovery/jobs
读取当前账户下的找社区任务列表。
查看详情
GET
GET /community-discovery/jobs/{job_id}
读取单个找社区任务状态。
查看详情
GET
GET /community-discovery/jobs/{job_id}/result
读取找社区任务的最终结果。
查看详情
DELETE
DELETE /community-discovery/jobs/{job_id}
取消或删除一个找社区任务。
查看详情
POST
POST /community-overview/jobs
创建一个新的社区分析异步任务。
查看详情
GET
GET /community-overview/jobs
读取当前账户下的社区分析任务列表。
查看详情
GET
GET /community-overview/jobs/{job_id}
读取单个社区分析任务状态。
查看详情
GET
GET /community-overview/jobs/{job_id}/result
读取社区分析任务的最终结果。
查看详情
DELETE
DELETE /community-overview/jobs/{job_id}
取消或删除一个社区分析任务。
查看详情
POST
POST /monitoring/jobs
创建一个持续扫描 subreddit 或 search query 的监控任务。
查看详情
GET
GET /monitoring/jobs
列出当前账户下的监控任务。
查看详情
GET
GET /monitoring/jobs/{job_id}
读取单个监控任务及最近执行记录。
查看详情
PATCH
PATCH /monitoring/jobs/{job_id}
启停一个监控任务。
查看详情
DELETE
DELETE /monitoring/jobs/{job_id}
删除一个监控任务，并停止后续调度。
查看详情
GET
GET /monitoring/jobs/{job_id}/hits
读取某个监控任务最近命中的帖子及分析结果。
查看详情
GET
GET /usage
读取当前账户的积分余额与资源概览。
查看详情
GET
GET /keys
列出当前账户的 API Keys。
查看详情
POST
POST /keys
创建新的 API Key，并只返回一次明文 Token。
查看详情
POST
POST /keys/{key_id}/rotate
轮转指定 API Key，并返回新的明文 Token。
查看详情
POST
POST /keys/{key_id}/revoke
撤销指定 API Key。
查看详情
GET
GET /whoami
读取当前 Bearer Token 对应的身份与 API Key 摘要。
查看详情
POST
POST /auth/rotate
轮转当前 Bearer Token 对应的 API Key，并返回新的明文 Token。
查看详情
POST
POST /auth/revoke
撤销当前 Bearer Token 对应的 API Key。
查看详情
这个页面对你有帮助吗？