API reference

Monitor API

One monitor with its target, schedule and the summary of its most recent run.

Read as Markdown Use with an AI agent

Endpoint

GET/v1/monitors/getlive · provenfree

Try in Playground

Monitor relevance

Optional filtering and saved matching results

Use relevance_enabled, relevance_prompt and exclusions on creation or update. Monitor reads return the settings; findings return retained matches and evidence; runs show processing and undecided counts. Dashboard, API and MCP share the same backend. Follow the setup and pagination examples, uncertainty guide or Claude/MCP example.

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
`id`	yes	Monitor id	`mon_0f2c8b1d4e6a7c9b0d1e2f3a`
`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/get?id=mon_0f2c8b1d4e6a7c9b0d1e2f3a" \
  -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/get?id=mon_0f2c8b1d4e6a7c9b0d1e2f3a",
  { 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/get?id=mon_0f2c8b1d4e6a7c9b0d1e2f3a",
    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/get",
  "data": {
    "id": null,
    "kind": null,
    "name": null,
    "description": null,
    "status": null,
    "workflow": null,
    "capped_reason": null,
    "target_label": null,
    "group_id": null,
    "last_run_at": null,
    "last_success_at": null,
    "next_run_at": null,
    "created_at": null,
    "schedule_minutes": 0,
    "estimated_credits_per_run": 0,
    "monthly_cap_credits": 0,
    "credits_spent_month": 0,
    "consecutive_failures": 0,
    "target": {},
    "subject": {},
    "delivery": {},
    "last_run": {}
  },
  "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
`kind`	`string \| null`	kind
`name`	`string \| null`	name
`description`	`string \| null`	description
`status`	`string \| null`	status
`workflow`	`string \| null`	workflow
`capped_reason`	`string \| null`	capped reason
`target_label`	`string \| null`	target label
`group_id`	`string \| null`	group id
`last_run_at`	`string \| null`	last run at
`last_success_at`	`string \| null`	last success at
`next_run_at`	`string \| null`	next run at
`created_at`	`string \| null`	created at
`schedule_minutes`	`number \| null`	schedule minutes
`estimated_credits_per_run`	`number \| null`	estimated credits per run
`monthly_cap_credits`	`number \| null`	monthly cap credits
`credits_spent_month`	`number \| null`	credits spent month
`consecutive_failures`	`number \| null`	consecutive failures
`target`	`object \| null`	Nested response fields; optional unless explicitly documented.
`subject`	`object \| null`	Nested response fields; optional unless explicitly documented.
`delivery`	`object \| null`	Nested response fields; optional unless explicitly documented.
`last_run`	`object \| null`	Nested response fields; optional unless explicitly documented.

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

Monitor API

Optional filtering and saved matching results

Query parameters

Make the request

Response fields and example

Useful next calls

First call in under a minute