# Utility API guide



## Choose a Utility operation



Start with the object your task needs. The groups below use the current catalogue; open an endpoint to check accepted identifiers, filters, price and availability before retrieving.



### Other operations



- [Parameter capabilities](https://www.monocrawl.com/docs/endpoints/utility/capabilities) — Accepted parameter capabilities from the current endpoint registry, with endpoint-specific descriptions, examples, prices and availability. Free metadata read; no suppliers are called. Filter by platform, endpoint/parameter search or HTTP method.

- [Endpoint documentation](https://www.monocrawl.com/docs/endpoints/utility/endpoint) — Full documentation for one endpoint — parameters, credit cost, auth header, and a ready-to-paste curl example.

- [Endpoint catalogue](https://www.monocrawl.com/docs/endpoints/utility/endpoints) — The live endpoint catalogue: every callable endpoint with its credit cost, parameters and description. Filter by platform, free-text search, or method.

- [LLM context payload](https://www.monocrawl.com/docs/endpoints/utility/llms) — Agent-ready context payload: base URL, auth header, envelope and error model, plus the compact endpoint catalogue grouped by platform.

- [Quickstart](https://www.monocrawl.com/docs/endpoints/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.



## Check fields and collection limits



Use the endpoint’s declared parameters and returned continuation. Filters from another platform do not automatically apply here. Preserve source identifiers, URLs and warnings; a successful page does not establish complete history. Published response schemas identify whether they come from a reviewed shaper or observed response shapes.



Agents can use `get_endpoint` for the current contract and `get_docs` with topic `platforms/utility` to read this page. The [coverage guide](https://www.monocrawl.com/docs/data-availability) explains nulls and partial results, and the [production guide](https://www.monocrawl.com/docs/production-checklist) covers budgets and recovery.



## Endpoint reference

## utility/capabilities

`GET /v1/utility/capabilities`

Accepted parameter capabilities from the current endpoint registry, with endpoint-specific descriptions, examples, prices and availability. Free metadata read; no suppliers are called. Filter by platform, endpoint/parameter search or HTTP method.

*Parameter capabilities*

| Parameter | Required | Description |
| --- | --- | --- |
| `param` | no | One accepted parameter name, such as date_posted, fit or dry_run. Omit for the complete index. — e.g. `date_posted` |
| `platform` | no | Only capabilities used by endpoints for this platform. — e.g. `instagram` |
| `search` | no | Literal case-insensitive match on endpoint identity, purpose, accepted parameter names and descriptions. — e.g. `date_posted` |
| `method` | no | HTTP method filter: GET, POST or DELETE. — e.g. `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. — 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/capabilities" \
  -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
{
  "items": [],
  "count": 0,
  "cursor": null,
  "has_more": false,
  "endpoint_count": 0,
  "filters": {
    "param": null
  },
  "semantics": null
}
```

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


## utility/endpoint

`GET /v1/utility/endpoint`

Full documentation for one endpoint — parameters, credit cost, auth header, and a ready-to-paste curl example.

*Endpoint documentation*

| Parameter | Required | Description |
| --- | --- | --- |
| `id` | no | Endpoint id as platform/endpoint (or a /v1 path) — e.g. `github/user` |
| `url` | no | Full endpoint URL as an alternative to id — e.g. `https://www.monocrawl.com/v1/github/user` |
| `method` | no | Ignored — all Monocrawl endpoints are GET — e.g. `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. — 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/endpoint?url=https%3A%2F%2Fwww.monocrawl.com%2Fv1%2Fgithub%2Fuser" \
  -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
{
  "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
}
```

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


## utility/endpoints

`GET /v1/utility/endpoints`

The live endpoint catalogue: every callable endpoint with its credit cost, parameters and description. Filter by platform, free-text search, or method.

*Endpoint catalogue*

| Parameter | Required | Description |
| --- | --- | --- |
| `platform` | no | Only endpoints for this platform — e.g. `reddit` |
| `search` | no | Literal case-insensitive match on endpoint identity, name, description, accepted parameter names and descriptions. — e.g. `comments` |
| `method` | no | HTTP method filter: GET, POST or DELETE. — e.g. `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. — 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/endpoints" \
  -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
{
  "items": [],
  "count": 0,
  "cursor": null,
  "has_more": false
}
```

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


## utility/llms

`GET /v1/utility/llms`

Agent-ready context payload: base URL, auth header, envelope and error model, plus the compact endpoint catalogue grouped by platform.

*LLM context payload*

| Parameter | Required | Description |
| --- | --- | --- |
| `platform` | no | Limit the catalogue to one platform — e.g. `reddit` |
| `format` | no | markdown (default) or json Accepted values: markdown, json. Case, spaces, hyphens and underscores are interchangeable. — e.g. `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. — 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/llms" \
  -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
{
  "format": null,
  "content": null,
  "base_url": null,
  "platforms": null,
  "endpoints": []
}
```

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


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