API reference
LLM Context Payload API
Agent-ready context payload: base URL, auth header, envelope and error model, plus the compact endpoint catalogue grouped by platform.
Endpoint
/v1/utility/llmslive · provenfreeParameters
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.
| Name | Required | Description | Example |
|---|---|---|---|
platform | no | Limit the catalogue to one platform | reddit |
format | no | markdown (default) or json Accepted values: markdown, json. Case, spaces, hyphens and underscores are interchangeable. | markdown |
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. Accepted values: 1, 0, true, false. Case, spaces, hyphens and underscores are interchangeable. | 1 |
Examples
Make the request
curl "https://www.monocrawl.com/v1/utility/llms" \ -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/utility/llms",
{ 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/utility/llms",
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": "utility",
"endpoint": "/v1/utility/llms",
"data": {
"format": null,
"content": null,
"base_url": null,
"platforms": null,
"endpoints": []
},
"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 data | Type | Meaning |
|---|---|---|
format | string | null | format |
content | string | null | content |
base_url | string | null | base url |
platforms | | Operation-specific JSON value; inspect the status and requested operation before reading it. |
endpoints | array | null | Nested response fields; optional unless explicitly documented. |
endpoints[].id | string | null | id |
endpoints[].platform | string | null | platform |
endpoints[].endpoint | string | null | endpoint |
endpoints[].name | string | null | name |
endpoints[].description | string | null | description |
endpoints[].credit_cost | number | null | Nested response fields; optional unless explicitly documented. |
endpoints[].params | array | null | Nested response fields; optional unless explicitly documented. |
endpoints[].params[].name | string | null | name |
endpoints[].params[].doc | string | null | doc |
endpoints[].params[].required | boolean | null | Nested response fields; optional unless explicitly documented. |
endpoints[].params[].example | | Operation-specific JSON value; inspect the status and requested operation before reading it. |
endpoints[].recommended_params | array | null | Nested response fields; optional unless explicitly documented. |
endpoints[].recommended_params[].name | string | null | name |
endpoints[].recommended_params[].reason | string | null | reason |
endpoints[].recommended_params[].cost_note | string | null | cost note |
endpoints[].recommended_params[].description | string | null | description |
endpoints[].recommended_params[].example | | Operation-specific JSON value; inspect the status and requested operation before reading it. |
endpoints[].recommended_params[].allowed_values | array | null | Nested response fields; optional unless explicitly documented. |
endpoints[].related_endpoints | array | null | Nested response fields; optional unless explicitly documented. |
endpoints[].related_endpoints[].id | string | null | id |
endpoints[].related_endpoints[].name | string | null | name |
endpoints[].related_endpoints[].reason | string | null | reason |
endpoints[].related_endpoints[].method | string | null | method |
endpoints[].related_endpoints[].documentation | string | null | documentation |
endpoints[].related_endpoints[].credit_cost | number | null | Nested response fields; optional unless explicitly documented. |
endpoints[].related_endpoints[].production_available | boolean | null | Nested response fields; optional unless explicitly documented. |
endpoints[].live_proven | boolean | null | live proven |
endpoints[].production_available | boolean | null | production available |
Core response fields reviewed from the public response shaper. Fields vary by requested options; additive fields remain allowed.
Markdown format returns content; JSON format returns structured catalogue fields.
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