Overview
All endpoints are organized around async jobs and results: write calls return a job, and the corresponding result is fetched through a result resource.
Resource Groups
Create, list, retrieve, and cancel Community Discovery jobs.
Create, list, retrieve, and cancel Community Overview jobs.
Create, retrieve, enable/disable, delete monitoring jobs, and inspect hits.
Read credits and resource overview.
读取当前身份、管理当前凭证,并List、Create、轮转或撤销 API Keys。
Request Patterns
- Write operations: POST -> returns a job object.
- Read operations: GET list / GET item / GET result.
- Control operations: PATCH toggles jobs, DELETE removes jobs.
- Usage uses a single-resource response instead of the list envelope.
- Access & Auth:GET /whoami 读取当前身份,GET /keys List现有 Key,POST /keys Create新 Key,POST /auth/rotate 与 /auth/revoke 管理当前 Token。
Entry Points
Create a new Community Discovery async job.
List Community Discovery jobs for the current account.
Retrieve a single Community Discovery job status.
Retrieve Community Discovery final result.
Cancel or delete a Community Discovery job.
Create a new Community Overview async job.
List Community Overview jobs for the current account.
Retrieve a single Community Overview job status.
Retrieve Community Overview final result.
Cancel or delete a Community Overview job.
Create a monitoring job that continuously scans a subreddit or search query.
List monitoring jobs under the current account.
Retrieve a monitoring job and its recent execution history.
Enable or disable a monitoring job.
Delete a monitoring job and stop future scheduling.
Retrieve recent hit posts and analysis results for a monitoring job.
Retrieve the current account credit balance and resource overview.
List the API keys for the current account.
Create新的 API Key,并只返回一次明文 Token。
轮转指定 API Key,并返回新的明文 Token。
撤销指定 API Key。
Read the identity and API key summary for the current Bearer token.
轮转当前 Bearer Token 对应的 API Key,并返回新的明文 Token。
撤销当前 Bearer Token 对应的 API Key。