FounderMCPDocs

API reference

Get a monitor

One keyword monitor: schedule, cap, next run and credits charged.

GEThttps://foundermcp.dev/api/v1/monitors/{monitor_id}
View Markdown

One keyword monitor: schedule, cap, next run and credits charged.

Authentication

Send Authorization: Bearer gtk_…. Create the key under API Access → API Keys. A missing, invalid or revoked key is 401, including while this API is closed. A valid key while the API is closed for your organization answers 404, the same body as an unknown path. Every response includes FounderMCP-Api-Version and FounderMCP-Request-Id.

Path parameters

  • monitor_id string · required — A monitor id (mon_…).

Response

  • id string · required — Monitor id, mon_….
  • object string · required — Always monitor. One of: monitor.
  • name string · required — The name you gave it.
  • status string · required — active or paused. One of: active, paused.
  • schedule string · required — daily. hourly is not available yet. One of: daily, hourly.
  • keywords object[] · required — Each keyword with its context, tag, include and exclude lists, and paused.
  • min_relevance string · required — high, medium or low. One of: high, medium, low.
  • max_credits_per_day integer | null — Daily cap, or null for none.
  • credits_charged integer · required — Credits charged so far.
  • next_run_at string · required — When the next run starts.

Credits

Free.

Errors

  • 401 authentication_error — The Authorization header is missing, or the key is unknown or revoked.
  • 403 permission_error — API access is not part of your plan, or your account is suspended.
  • 404 not_found — The endpoint does not exist.
  • 429 rate_limit_error — More than 60 requests per minute, or more than 3 at the same time, on one key. Wait for the Retry-After header.
  • 500 internal_error — Something went wrong on our side.

Example

cURL

curl "https://foundermcp.dev/api/v1/monitors/mon_01J9Z6P8C8V0K3W6T2N8R5M1XF" \
  -H "Authorization: Bearer $FOUNDERMCP_API_KEY"

JavaScript

const response = await fetch('https://foundermcp.dev/api/v1/monitors/mon_01J9Z6P8C8V0K3W6T2N8R5M1XF', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.FOUNDERMCP_API_KEY}`
  }
});
const body = await response.json();

Python

import json
import os
import urllib.request

request = urllib.request.Request(
    "https://foundermcp.dev/api/v1/monitors/mon_01J9Z6P8C8V0K3W6T2N8R5M1XF",
    headers={
    "Authorization": f"Bearer {os.environ['FOUNDERMCP_API_KEY']}"
    },
    method="GET",
)
with urllib.request.urlopen(request) as response:
    body = json.load(response)

Example response

{
  "id": "mon_01J9Z6P8C8V0K3W6T2N8R5M1XF",
  "object": "monitor",
  "status": "active",
  "credits_charged": 15
}