Cohorts API
Create a cohort
Save a set of up to 100 accounts, subreddits or handles as a cohort you can sweep with one keyword.
Endpoint
GET/v1/cohorts/createlive · proven1 creditParameters
Query parameters
| Name | Required | Description | Example |
|---|---|---|---|
name | yes | Human label for this cohort (max 200 characters) | Rust ecosystem |
members | yes | The accounts to sweep: a comma-separated platform:identifier list, or a JSON array of {"platform","identifier"} objects. 1-100 members; every platform must exist in the catalogue. | reddit:rust,hackernews:steveklabnik,github:rust-lang/rust,bluesky:rust-lang.bsky.social |
dry_run | no | Read a zero-credit estimate without fetching sources, running AI, or reserving credits. Cache status is a snapshot, not a guarantee at execution. | 1 |
Examples
Make the request
curl "https://www.monocrawl.com/v1/cohorts/create?name=Rust%20ecosystem&members=reddit%3Arust%2Chackernews%3Asteveklabnik%2Cgithub%3Arust-lang%2Frust%2Cbluesky%3Arust-lang.bsky.social" \ -H "x-api-key: mn_your_key_here"
TypeScript
const key = process.env.MONOCRAWL_API_KEY;
if (!key) throw new Error('Set MONOCRAWL_API_KEY on your server.');
const res = await fetch(
"https://www.monocrawl.com/v1/cohorts/create?name=Rust%20ecosystem&members=reddit%3Arust%2Chackernews%3Asteveklabnik%2Cgithub%3Arust-lang%2Frust%2Cbluesky%3Arust-lang.bsky.social",
{ headers: { "x-api-key": key } },
);
const body = await res.json();
if (!body.success) {
// one error shape for every endpoint — see /docs/errors
throw new Error(`${body.error.type}: ${body.error.message}`);
}
console.log(body.data, "credits left:", body.credits_remaining);Python
import os
import requests
res = requests.get(
"https://www.monocrawl.com/v1/cohorts/create?name=Rust%20ecosystem&members=reddit%3Arust%2Chackernews%3Asteveklabnik%2Cgithub%3Arust-lang%2Frust%2Cbluesky%3Arust-lang.bsky.social",
headers={"x-api-key": os.environ["MONOCRAWL_API_KEY"]},
timeout=60,
)
body = res.json()
if not body["success"]:
# one error shape for every endpoint — see /docs/errors
raise RuntimeError(f"{body['error']['type']}: {body['error']['message']}")
print(body["data"], "credits left:", body["credits_remaining"])Response
Response fields and example
This example is illustrative, not a captured live response. Variable-cost operations may settle a charge different from the list price below. A successful response puts the platform payload in data and reports the exact credits used, remaining balance, request id and cache status beside it.
{
"success": true,
"platform": "cohorts",
"endpoint": "/v1/cohorts/create",
"data": {
"id": "cohort_example",
"name": "Example cohort",
"members": []
},
"credits_used": 1,
"credits_remaining": 99,
"request_id": "req_…",
"cached": false
}The example is illustrative and shows a documented subset of data. The fields below are optional across supported sources; nullable fields can also be absent. Preserve unknown values and accept additional fields.
Schema basis: reviewed response shaper. See schema coverage and validation limits.
Download the data JSON Schema. Validate response.data, not the whole envelope. A valid shape does not establish that every field or source record was returned.
| Field inside data | Type | Meaning |
|---|---|---|
id | string | null | Exact source identifier; preserve it as a string. |
name | string | null | name |
created_at | string | null | created at |
members | array | Nested response fields; optional unless explicitly documented. |
members[].platform | string | null | platform |
members[].identifier | string | null | identifier |
member_count | number | null | member count; null is unknown. |
sweepable_count | number | null | sweepable count; null is unknown. |
Failures use the typed error envelope. A confirmed uncharged or refunded failure reports zero; a pending reconciliation can report an unknown charge. Read credits_used and error.details.billing_status, and keep request_id for recovery. Response contract · Error reference