API reference

Replace a Cohort's Members API

Replace a cohort's member list in one call. Sweeps already completed keep the results they produced.

Endpoint

GET/v1/cohorts/memberslive · provenfree
Try in Playground

Parameters

Query parameters

Useful optional inputs

  • dry_run — Read a free estimate before fetching sources or scheduling paid work.

    Zero credits; cache status and availability are snapshots rather than guarantees.

NameRequiredDescriptionExample
cohort_idyesCohort id (the {cohortId} path segment)coh_0f2c8b1d4e6a7c9b0d1e2f3a
membersyesThe new member list, replacing the old one entirely: 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
dry_runnoRead a zero-credit estimate without fetching sources, running AI, or reserving credits. Cache status is a snapshot, not a guarantee at execution. Accepted values: 1, 0, true, false. Case, spaces, hyphens and underscores are interchangeable.1

Examples

Make the request

curl
curl "https://www.monocrawl.com/v1/cohorts/members?cohort_id=coh_0f2c8b1d4e6a7c9b0d1e2f3a&members=reddit%3Arust%2Chackernews%3Asteveklabnik%2Cgithub%3Arust-lang%2Frust" \
  -H "x-api-key: mn_your_key_here"
TypeScript
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/members?cohort_id=coh_0f2c8b1d4e6a7c9b0d1e2f3a&members=reddit%3Arust%2Chackernews%3Asteveklabnik%2Cgithub%3Arust-lang%2Frust",
  { 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
python
import os
import requests

res = requests.get(
    "https://www.monocrawl.com/v1/cohorts/members?cohort_id=coh_0f2c8b1d4e6a7c9b0d1e2f3a&members=reddit%3Arust%2Chackernews%3Asteveklabnik%2Cgithub%3Arust-lang%2Frust",
    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.

200 · application/json
{
  "success": true,
  "platform": "cohorts",
  "endpoint": "/v1/cohorts/members",
  "data": {
    "id": null,
    "name": null,
    "created_at": null,
    "member_count": 0,
    "sweepable_count": 0,
    "members": [],
    "replaced": false
  },
  "credits_used": 0,
  "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 dataTypeMeaning
idstring | nullid
namestring | nullname
created_atstring | nullcreated at
member_countnumber | nullmember count
sweepable_countnumber | nullsweepable count
membersarray | nullNested response fields; optional unless explicitly documented.
members[].platformstring | nullplatform
members[].identifierstring | nullidentifier
members[].labelstring | nulllabel
replacedboolean | nullNested response fields; optional unless explicitly documented.

Core response fields reviewed from the public response shaper. Fields vary by requested options; additive fields remain allowed.

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

First call in under a minute

150 free credits and a ready-made key the moment you sign up. No card.