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

GET/v1/utility/llmslive · 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
platformnoLimit the catalogue to one platformreddit
formatnomarkdown (default) or json Accepted values: markdown, json. Case, spaces, hyphens and underscores are interchangeable.markdown
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/utility/llms" \
  -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/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
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.

200 · application/json
{
  "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 dataTypeMeaning
formatstring | nullformat
contentstring | nullcontent
base_urlstring | nullbase url
platformsOperation-specific JSON value; inspect the status and requested operation before reading it.
endpointsarray | nullNested response fields; optional unless explicitly documented.
endpoints[].idstring | nullid
endpoints[].platformstring | nullplatform
endpoints[].endpointstring | nullendpoint
endpoints[].namestring | nullname
endpoints[].descriptionstring | nulldescription
endpoints[].credit_costnumber | nullNested response fields; optional unless explicitly documented.
endpoints[].paramsarray | nullNested response fields; optional unless explicitly documented.
endpoints[].params[].namestring | nullname
endpoints[].params[].docstring | nulldoc
endpoints[].params[].requiredboolean | nullNested response fields; optional unless explicitly documented.
endpoints[].params[].exampleOperation-specific JSON value; inspect the status and requested operation before reading it.
endpoints[].recommended_paramsarray | nullNested response fields; optional unless explicitly documented.
endpoints[].recommended_params[].namestring | nullname
endpoints[].recommended_params[].reasonstring | nullreason
endpoints[].recommended_params[].cost_notestring | nullcost note
endpoints[].recommended_params[].descriptionstring | nulldescription
endpoints[].recommended_params[].exampleOperation-specific JSON value; inspect the status and requested operation before reading it.
endpoints[].recommended_params[].allowed_valuesarray | nullNested response fields; optional unless explicitly documented.
endpoints[].related_endpointsarray | nullNested response fields; optional unless explicitly documented.
endpoints[].related_endpoints[].idstring | nullid
endpoints[].related_endpoints[].namestring | nullname
endpoints[].related_endpoints[].reasonstring | nullreason
endpoints[].related_endpoints[].methodstring | nullmethod
endpoints[].related_endpoints[].documentationstring | nulldocumentation
endpoints[].related_endpoints[].credit_costnumber | nullNested response fields; optional unless explicitly documented.
endpoints[].related_endpoints[].production_availableboolean | nullNested response fields; optional unless explicitly documented.
endpoints[].live_provenboolean | nulllive proven
endpoints[].production_availableboolean | nullproduction 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

First call in under a minute

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