API reference

Monitoring Settings API

Read or change the monitoring digest schedule and delivery preferences. Reads with no parameters; writes with any supported setting. The legacy monthly_budget_credits field is ignored; account billing limits still apply.

Read as Markdown Use with an AI agent

Endpoint

GET/v1/monitors/settingslive · 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
`monthly_budget_credits`	no	Deprecated and ignored. No monthly monitor or account monitoring cap is enforced. Runs require sufficient available account funding; account billing limits still apply.	—
`digest_frequency`	no	off, daily or weekly Accepted values: off, daily, weekly. Case, spaces, hyphens and underscores are interchangeable.	`daily`
`digest_hour`	no	UTC hour the digest is assembled	`8`
`digest_email`	no	Send the digest by email	`true`
`digest_webhook`	no	Send the digest to subscribed webhooks	`false`
`digest_report`	no	Also save each digest as a research report	`false`
`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/monitors/settings" \
  -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/monitors/settings",
  { 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/monitors/settings",
    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": "monitors",
  "endpoint": "/v1/monitors/settings",
  "data": {
    "digest_frequency": null,
    "updated_at": null,
    "digest_hour": 0,
    "monthly_budget_credits": null,
    "digest_email": false,
    "digest_webhook": false,
    "digest_report": false
  },
  "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
`digest_frequency`	`string \| null`	digest frequency
`updated_at`	`string \| null`	updated at
`digest_hour`	`number \| null`	Nested response fields; optional unless explicitly documented.
`monthly_budget_credits`	`null`	Nested response fields; optional unless explicitly documented.
`digest_email`	`boolean \| null`	digest email
`digest_webhook`	`boolean \| null`	digest webhook
`digest_report`	`boolean \| null`	digest report

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

Monitoring Settings API

Query parameters

Make the request

Response fields and example

Useful next calls

First call in under a minute