API reference

Quickstart API

Get started in one call: the cheapest live endpoint for a platform, a copy-paste curl, and a sketch of the response envelope you will get back.

Read as Markdown Use with an AI agent

Endpoint

GET/v1/utility/quickstartlive · 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.

Name	Required	Description	Example
`platform`	no	Platform to start with; omit for the cheapest live endpoint overall	`reddit`
`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

curl "https://www.monocrawl.com/v1/utility/quickstart" \
  -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/quickstart",
  { 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/quickstart",
    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/quickstart",
  "data": {
    "platform": null,
    "endpoint": {
      "id": null,
      "platform": null,
      "endpoint": null,
      "name": null,
      "description": null,
      "credit_cost": 0,
      "params": [],
      "recommended_params": [],
      "related_endpoints": [],
      "live_proven": false,
      "production_available": false
    },
    "curl": null,
    "expected_envelope": {},
    "auth": {
      "header": null,
      "doc": 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
`platform`	`string \| null`	Nested response fields; optional unless explicitly documented.
`endpoint`	`object \| null`	Nested response fields; optional unless explicitly documented.
`endpoint.id`	`string \| null`	id
`endpoint.platform`	`string \| null`	platform
`endpoint.endpoint`	`string \| null`	endpoint
`endpoint.name`	`string \| null`	name
`endpoint.description`	`string \| null`	description
`endpoint.credit_cost`	`number \| null`	Nested response fields; optional unless explicitly documented.
`endpoint.params`	`array \| null`	Nested response fields; optional unless explicitly documented.
`endpoint.params[].name`	`string \| null`	name
`endpoint.params[].doc`	`string \| null`	doc
`endpoint.params[].required`	`boolean \| null`	Nested response fields; optional unless explicitly documented.
`endpoint.params[].example`		Operation-specific JSON value; inspect the status and requested operation before reading it.
`endpoint.recommended_params`	`array \| null`	Nested response fields; optional unless explicitly documented.
`endpoint.recommended_params[].name`	`string \| null`	name
`endpoint.recommended_params[].reason`	`string \| null`	reason
`endpoint.recommended_params[].cost_note`	`string \| null`	cost note
`endpoint.recommended_params[].description`	`string \| null`	description
`endpoint.recommended_params[].example`		Operation-specific JSON value; inspect the status and requested operation before reading it.
`endpoint.recommended_params[].allowed_values`	`array \| null`	Nested response fields; optional unless explicitly documented.
`endpoint.related_endpoints`	`array \| null`	Nested response fields; optional unless explicitly documented.
`endpoint.related_endpoints[].id`	`string \| null`	id
`endpoint.related_endpoints[].name`	`string \| null`	name
`endpoint.related_endpoints[].reason`	`string \| null`	reason
`endpoint.related_endpoints[].method`	`string \| null`	method
`endpoint.related_endpoints[].documentation`	`string \| null`	documentation
`endpoint.related_endpoints[].credit_cost`	`number \| null`	Nested response fields; optional unless explicitly documented.
`endpoint.related_endpoints[].production_available`	`boolean \| null`	Nested response fields; optional unless explicitly documented.
`endpoint.live_proven`	`boolean \| null`	live proven
`endpoint.production_available`	`boolean \| null`	production available
`curl`	`string \| null`	Nested response fields; optional unless explicitly documented.
`expected_envelope`	`object \| null`	Nested response fields; optional unless explicitly documented.
`auth`	`object \| null`	Nested response fields; optional unless explicitly documented.
`auth.header`	`string \| null`	header
`auth.doc`	`string \| null`	doc

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

Quickstart API

Query parameters

Make the request

Response fields and example

Useful next calls

First call in under a minute