API reference
Endpoint Documentation API
Full documentation for one endpoint — parameters, credit cost, auth header, and a ready-to-paste curl example.
Endpoint
GET/v1/utility/endpointlive · 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 |
|---|---|---|---|
id | no | Endpoint id as platform/endpoint (or a /v1 path) | github/user |
url | no | Full endpoint URL as an alternative to id | https://www.monocrawl.com/v1/github/user |
method | no | Ignored — all Monocrawl endpoints are GET | GET |
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/endpoint?url=https%3A%2F%2Fwww.monocrawl.com%2Fv1%2Fgithub%2Fuser" \ -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/endpoint?url=https%3A%2F%2Fwww.monocrawl.com%2Fv1%2Fgithub%2Fuser",
{ 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/endpoint?url=https%3A%2F%2Fwww.monocrawl.com%2Fv1%2Fgithub%2Fuser",
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/endpoint",
"data": {
"id": null,
"platform": null,
"endpoint": null,
"name": null,
"description": null,
"credit_cost": 0,
"params": [],
"recommended_params": [],
"related_endpoints": [],
"live_proven": false,
"production_available": false,
"response_schema": null,
"examples": null
},
"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 |
|---|---|---|
id | string | null | id |
platform | string | null | platform |
endpoint | string | null | endpoint |
name | string | null | name |
description | string | null | description |
credit_cost | number | null | Nested response fields; optional unless explicitly documented. |
params | array | null | Nested response fields; optional unless explicitly documented. |
params[].name | string | null | name |
params[].doc | string | null | doc |
params[].required | boolean | null | Nested response fields; optional unless explicitly documented. |
params[].example | | Operation-specific JSON value; inspect the status and requested operation before reading it. |
recommended_params | array | null | Nested response fields; optional unless explicitly documented. |
recommended_params[].name | string | null | name |
recommended_params[].reason | string | null | reason |
recommended_params[].cost_note | string | null | cost note |
recommended_params[].description | string | null | description |
recommended_params[].example | | Operation-specific JSON value; inspect the status and requested operation before reading it. |
recommended_params[].allowed_values | array | null | Nested response fields; optional unless explicitly documented. |
related_endpoints | array | null | Nested response fields; optional unless explicitly documented. |
related_endpoints[].id | string | null | id |
related_endpoints[].name | string | null | name |
related_endpoints[].reason | string | null | reason |
related_endpoints[].method | string | null | method |
related_endpoints[].documentation | string | null | documentation |
related_endpoints[].credit_cost | number | null | Nested response fields; optional unless explicitly documented. |
related_endpoints[].production_available | boolean | null | Nested response fields; optional unless explicitly documented. |
live_proven | boolean | null | live proven |
production_available | boolean | null | production available |
response_schema | string | null | Nested response fields; optional unless explicitly documented. |
examples | | Operation-specific JSON value; inspect the status and requested operation before reading it. |
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