Cohorts API
Submit a cohort query
Run one keyword across every member of a cohort. Asynchronous: returns a query id to poll.
Endpoint
GET/v1/cohorts/querieslive · proven10 creditsParameters
Query parameters
| Name | Required | Description | Example |
|---|---|---|---|
cohort_id | yes | Cohort id (the {cohortId} path segment) | coh_0f2c8b1d4e6a7c9b0d1e2f3a |
keyword | yes | The keyword swept across every member of the cohort (max 200 characters) | async runtime |
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/queries?cohort_id=coh_0f2c8b1d4e6a7c9b0d1e2f3a&keyword=async%20runtime" \ -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/queries?cohort_id=coh_0f2c8b1d4e6a7c9b0d1e2f3a&keyword=async%20runtime",
{ 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/queries?cohort_id=coh_0f2c8b1d4e6a7c9b0d1e2f3a&keyword=async%20runtime",
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/queries",
"data": {
"id": "query_example",
"status": "queued"
},
"credits_used": 10,
"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. |
cohort_id | string | null | cohort id |
keyword | string | null | keyword |
status | string | null | status |
job_id | string | null | job id |
check | string | null | check |
results_path | string | null | results path |
member_count | number | null | Members in the requested sweep. |
Poll the query for completion; enqueue success is not a completed collection.
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