## utility/quickstart

`GET /v1/utility/quickstart`

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.

*Quickstart*

| Parameter | Required | Description |
| --- | --- | --- |
| `platform` | no | Platform to start with; omit for the cheapest live endpoint overall — e.g. `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. — e.g. `1` |

### 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.

**Cost:** free — 0 credits.

```bash
curl "https://www.monocrawl.com/v1/utility/quickstart" \
  -H "x-api-key: mn_your_key_here"
```

### Response data

Illustrative abbreviated data; documented core fields are optional and may be null. Additional source fields are allowed.

```json
{
  "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
  }
}
```

[Field reference](https://www.monocrawl.com/docs/endpoints/utility/quickstart#response) · [JSON Schema for response.data](https://www.monocrawl.com/schemas/utility/quickstart.json)
