hyreflow-ai Monitors API
The Monitors API from hyreflow-ai — 4 operation(s) for monitors.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/hyreflow-ai:hyreflow-ai-monitors-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: hyreflow engine (local) Monitors API
version: 0.1.0
tags:
- name: Monitors
paths:
/api/v2/monitors:
get:
summary: Monitors List
description: 'The workspace''s monitors, each with its most recent check (`last_check`, null before the first), and the
workspace''s `timezone`, the zone their schedules are read in.'
operationId: monitors_list_api_v2_monitors_get
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
security:
- HTTPBearer: []
tags:
- Monitors
post:
summary: Monitors Create
description: 'Create a monitor. Body: {type (a key of monitors.TYPES), config (shaped by the type), name?, schedule?:
{every, unit, days, day_of_month, time}, in the workspace''s time zone, daily 09:00 by default}. Nothing runs
when it''s saved: its first check, the baseline, waits for the schedule''s next fire, or for a PATCH with
`check_now`.'
operationId: monitors_create_api_v2_monitors_post
requestBody:
content:
application/json:
schema:
additionalProperties: true
type: object
title: Body
default: {}
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
tags:
- Monitors
/api/v2/monitors/estimate:
get:
summary: Monitors Estimate
description: 'What a monitor of `type` (a key of monitors.TYPES) checking on `schedule` (JSON, daily 09:00 by default)
would cost, and its `next_check_at` (its first check, in the workspace''s time zone), before it''s saved,
or a 422 saying why the type or schedule is refused. `config`, JSON, is the config so far (a form being
filled in): its settings that set the price, like `max_pages`, are priced, and the rest is ignored.
Declared before /{monitor_id}, which would take `estimate` for an id.'
operationId: monitors_estimate_api_v2_monitors_estimate_get
security:
- HTTPBearer: []
parameters:
- name: type
in: query
required: true
schema:
type: string
title: Type
- name: schedule
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Schedule
- name: config
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Config
- name: monitor_id
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Monitor Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Monitors
/api/v2/monitors/{monitor_id}:
get:
summary: Monitors Get
description: A monitor with its 20 most recent checks and its credit estimate.
operationId: monitors_get_api_v2_monitors__monitor_id__get
security:
- HTTPBearer: []
parameters:
- name: monitor_id
in: path
required: true
schema:
type: string
title: Monitor Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Monitors
patch:
summary: Monitors Update
description: 'Change a monitor. Body: any of {name, config (replaces it whole: a different config clears the items
found so far and the next check is a new baseline), schedule, status: active|paused, check_now: true}. A
config or schedule returns the new estimate.'
operationId: monitors_update_api_v2_monitors__monitor_id__patch
security:
- HTTPBearer: []
parameters:
- name: monitor_id
in: path
required: true
schema:
type: string
title: Monitor Id
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
default: {}
title: Body
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Monitors
delete:
summary: Monitors Delete
description: Delete a monitor with its checks and the items it found.
operationId: monitors_delete_api_v2_monitors__monitor_id__delete
security:
- HTTPBearer: []
parameters:
- name: monitor_id
in: path
required: true
schema:
type: string
title: Monitor Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Monitors
/api/v2/monitors/{monitor_id}/items:
get:
summary: Monitors Items
description: 'What the monitor found, newest first. `since` keeps the items first seen after it. `baseline: true`
marks those already listed when the monitor started, or when its config last changed.'
operationId: monitors_items_api_v2_monitors__monitor_id__items_get
security:
- HTTPBearer: []
parameters:
- name: monitor_id
in: path
required: true
schema:
type: string
title: Monitor Id
- name: since
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Since
- name: limit
in: query
required: false
schema:
type: integer
default: 100
title: Limit
- name: offset
in: query
required: false
schema:
type: integer
default: 0
title: Offset
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Monitors
components:
schemas:
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
securitySchemes:
HTTPBearer:
type: http
scheme: bearer