API overview
Reddit Community Playbook
reddit-community-playbook
Turn current subreddit rules, tone, content patterns, and participation risks into a separate go/no-go playbook for each selected community.
Pricing & runtime
- Current price
- 25 Credits per run
- Timeout
- up to 1800s
- Brand Context
- Optional — pass a brand_context_id
Prices are calibrated against real run costs and may change — the credit_cost returned when creating a run is authoritative.
Input parameters
Pass these under the input object of POST /api/v1/runs.
| Key | Type | Required | Label & description |
|---|---|---|---|
| product_description | long_text | Required | Product |
| target_audience | long_text | Required | Target audience |
| objective | select | Required | ObjectiveOptions: Listen and research, Contribute expertise, Prepare a launch, Support users |
| subreddits | long_text | Required | SubredditsEnter one subreddit per line, or separate items with commas. |
| planned_activity | long_text | Optional | Planned activity |
| constraints | long_text | Optional | Constraints |
| max_posts | number | Optional | Total post sample |
| max_comments_per_post | number | Optional | Comments per post |
| interaction_language | select | Optional | Report languageControls the language of the generated report.Options: English, Chinese |
Request example
Covers every required field. Optional fields follow the same pattern.
curl -X POST https://api.TODO-APP-DOMAIN/api/v1/runs \
-H "Authorization: Bearer $SUPAMARKETERS_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"app_slug": "reddit-community-playbook",
"input": {
"product_description": "example text",
"target_audience": "example text",
"objective": "option-id",
"subreddits": "example text"
}
}'What you get back
A 201 response returns run_no, credit_cost, stream_url and result_url (relative paths). Stream progress from stream_url and fetch the terminal result — summary and output — from result_url. Results stay available for the App's retention window (30 days by default).