Skip to main content
RedditFind Open API
API Reference

Create Community Overview Job

Create a new Community Overview async job.

POST/api/open/v1/community-overview/jobs

Endpoint Overview

201community_overview:write

Create a new Community Overview async job.

Authentication

Use this request header: Authorization: Bearer <token>
Required scopes for this endpoint:community_overview:write
Pass Idempotency-Key on create-like requests to make retries safe.

Request Body

subreddit
stringRequired

The subreddit to analyze, for example saas.

include_about
boolean

Whether to include the about section.

include_rules
boolean

Whether to include rules.

hot_limit
integer

hot 帖子采样数，0-40。

new_limit
integer

new 帖子采样数，0-40。

best_limit
integer

best 帖子采样数，0-40。

top_limit
integer

top 帖子采样数，0-40。

rising_limit
integer

rising 帖子采样数，0-40。

force_refresh
boolean

Whether to bypass cache and force recomputation.

language
enum<string>

Language preference to return.

zhen

Response

201 - application/json
id
string

Community Overview job ID.

object
string

Always community_overview.job.

subreddit
string

Target subreddit.

status
string

Job status.

progress
number

Job progress from 0 to 100.

stage_message
string | null

Current analysis stage description.

result_id
string | null

Result object ID available after completion.

created_at
string

Job creation time (ISO 8601).

updated_at
string

Last updated time (ISO 8601).

result_url
string

Result URL returned when the result is available.

reused
boolean

Returns true when the same idempotency key is reused.

Common Errors

UNAUTHORIZED
error_code

Missing or invalid Bearer token.

FORBIDDEN
error_code

The current token is missing the required scope.

RATE_LIMITED
error_code

The current token hit a rate limit.

INVALID_ARGUMENT
error_code

Request parameters do not satisfy the schema constraints.

NOT_FOUND
error_code

The target resource does not exist or does not belong to the current account.

INSUFFICIENT_CREDITS
error_code

The account does not have enough credits to create a new job.

Notes

  • Write endpoints should always include Idempotency-Key to avoid duplicate billing or duplicate jobs during retries.
Was this page helpful?

Search API Docs

Full-text search across pages, sections, endpoints, and fields

Agent entry

If you are an agent, do not look for a separate manual first. RedditFind now keeps one shortest discovery index, one routing contract, and one API contract.

Use llms-index.txt to discover the stack quickly, agent-overview.json to route the job, and the OpenAPI spec when the workflow needs authenticated programmatic access.

Public demos still matter, but only for validating result shapes after the contracts are clear.

Why this stack is stronger now

  • Semantic detection layers Reddit discussions by demand, complaints, comparisons, and opportunities instead of relying on keywords alone.
  • The Reddit assistant connects discovery, analysis, monitoring, and next actions so agents do less manual orchestration.
  • With the Open API, agents can create jobs, read results, and plug RedditFind into their own workflows through a formal contract instead of guessing UI behavior.

Route by user objective

  • Community discovery — Use when the user still does not know where demand, competitors, or relevant communities live. Open feature page
  • Subreddit analysis — Use when target communities are already known and the user needs rules, tone, content patterns, and risks. Open feature page
  • Post monitoring — Use when the user needs an ongoing queue of new opportunities, feedback signals, or high-intent threads. Open feature page
  • Reddit assistant — Use when discovery, analysis, or monitoring context already exists and the user needs the next best action with lower execution risk. Open feature page

Core contracts and validation

Boundaries and non-goals

  • RedditFind does not auto-post to Reddit.
  • Human review is required before any public reply or post.
  • RedditFind does not support bulk direct-message automation.
  • It is not a generic web search engine or an autonomous posting bot that bypasses human oversight.
  • The Open API creates RedditFind jobs and reads results. It does not bypass human review for public Reddit engagement.