Sites in the Woods

Your team's website monitoring: uptime, incidents, speed, TLS and domain expiry.

Should I use this

Quality & Safety

A
Description quality
100%
Schema completeness
87%
Naming quality
77%
Poisoning risk
100%
Permission match
100%
Protocol compliance
100%

Findings (3)

  • LOWTool 'sites_by_slug_maintenance_start' name length outside 3-30 rangein sites_by_slug_maintenance_start
  • LOWTool 'sites_by_slug_journeys_by_journey_run' name length outside 3-30 rangein sites_by_slug_journeys_by_journey_run
  • LOWTool 'sites_by_slug_journeys_by_journey_requests_by_id' name length outside 3-30 rangein sites_by_slug_journeys_by_journey_requests_by_id

Based on automated analysis of tool definitions and protocol compliance.

Context Cost

~14,430Tokens (tool definitions)
~6.1 KBTypical response size
Significant attention impact (11.27% of 128k context)

This is the approximate number of tokens consumed each time the server's tools are loaded into a model's context. Higher counts reduce the attention available for other tasks.

Install

One-Click Install

Add this to your `claude_desktop_config.json` file:

{
  "mcpServers": {
    "monitor": {
      "command": "npx",
      "args": [
        "sites-in-the-woods"
      ]
    }
  }
}

Runnable packages

npmsites-in-the-woods0.1.0stdio

Remote endpoints

https://sitesinthewoods.com/mcpstreamable-http

What it can do

Tool inventory

Tools (22)

🟢 Read-only🟡 Write🔴 Delete⚪ Unknown
🟢status

Wraps GET /api/status. Every one of the team's sites: its status right now, and the open incidents. Call this first, or on a schedule (at most once a minute, as often as the checks run), to see whether anything is down or warning right now.

Input Schema

{
  "type": "object",
  "properties": {},
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Output Schema

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "sites": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "slug": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "status": {
                "type": "string"
              },
              "paused": {
                "type": "boolean"
              }
            },
            "additionalProperties": {}
          }
        },
        "openIncidents": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "kind": {
                "type": "string"
              },
              "severity": {
                "type": "string",
                "enum": [
                  "down",
                  "warning"
                ]
              },
              "site": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "startedAt": {
                "type": "string",
                "description": "ISO 8601, UTC (…Z)"
              },
              "cause": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "dismissed": {
                "type": "boolean"
              }
            },
            "additionalProperties": {}
          }
        }
      },
      "additionalProperties": {}
    },
    "next_steps": {
      "description": "calls that usually come next, each naming its tool",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "method": {
            "type": "string"
          },
          "path": {
            "type": "string"
          },
          "why": {
            "type": "string"
          },
          "tool": {
            "description": "the tool that makes this call",
            "type": "string"
          }
        },
        "additionalProperties": {}
      }
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": {}
}
🟢sites

Wraps GET /api/sites. The team's sites: status, homepage uptime over 1, 7 and 30 days, open incidents. Call this to compare sites or report on uptime over the last day, week or month. It also lists the slugs every other route takes.

Input Schema

{
  "type": "object",
  "properties": {},
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Output Schema

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "slug": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "project": {
            "type": "string"
          },
          "url": {
            "type": "string"
          },
          "status": {
            "type": "string"
          },
          "paused": {
            "type": "boolean"
          },
          "public": {
            "type": "boolean"
          },
          "checkFrom": {
            "type": "string",
            "enum": [
              "us-west",
              "us-east",
              "split"
            ],
            "description": "where the homepage, nav and newest-content checks run; a failure is checked again from the other location before it alerts or counts against uptime"
          },
          "uptime": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "d1": {
                    "type": "object",
                    "properties": {
                      "ok": {
                        "type": "integer",
                        "minimum": -9007199254740991,
                        "maximum": 9007199254740991
                      },
                      "total": {
                        "type": "integer",
                        "minimum": -9007199254740991,
                        "maximum": 9007199254740991
                      },
                      "percent": {
                        "description": "ok / total × 100, two decimals; null with no checks",
                        "type": [
                          "number",
                          "null"
                        ]
                      }
                    },
                    "additionalProperties": {}
                  },
                  "d7": {
                    "type": "object",
                    "properties": {
                      "ok": {
                        "type": "integer",
                        "minimum": -9007199254740991,
                        "maximum": 9007199254740991
                      },
                      "total": {
                        "type": "integer",
                        "minimum": -9007199254740991,
                        "maximum": 9007199254740991
                      },
                      "percent": {
                        "description": "ok / total × 100, two decimals; null with no checks",
                        "type": [
                          "number",
                          "null"
                        ]
                      }
                    },
                    "additionalProperties": {}
                  },
                  "d30": {
                    "type": "object",
                    "properties": {
                      "ok": {
                        "type": "integer",
                        "minimum": -9007199254740991,
                        "maximum": 9007199254740991
                      },
                      "total": {
                        "type": "integer",
                        "minimum": -9007199254740991,
                        "maximum": 9007199254740991
                      },
                      "percent": {
                        "description": "ok / total × 100, two decimals; null with no checks",
                        "type": [
                          "number",
                          "null"
                        ]
                      }
                    },
                    "additionalProperties": {}
                  }
                },
                "additionalProperties": {},
                "description": "the homepage's checks over the last 1, 7 and 30 days"
              },
              {
                "type": "null"
              }
            ]
          },
          "openIncidents": {
            "type": "integer",
            "minimum": -9007199254740991,
            "maximum": 9007199254740991
          },
          "dismissed": {
            "type": "integer",
            "minimum": -9007199254740991,
            "maximum": 9007199254740991,
            "description": "of those, how many the team dismissed"
          }
        },
        "additionalProperties": {}
      }
    },
    "next_steps": {
      "description": "calls that usually come next, each naming its tool",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "method": {
            "type": "string"
          },
          "path": {
            "type": "string"
          },
          "why": {
            "type": "string"
          },
          "tool": {
            "description": "the tool that makes this call",
            "type": "string"
          }
        },
        "additionalProperties": {}
      }
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": {}
}
🟢sites_by_slug(slug)

Wraps GET /api/sites/{slug}. One site: its last 7 days (as in the weekly brief), open incidents, domain and TLS expiry. Call this to answer questions about one site: how it did this week, what's wrong with it now, and when its domain or certificate runs out.

Input Schema

{
  "type": "object",
  "properties": {
    "slug": {
      "type": "string",
      "description": "site slug, as in /api/sites"
    }
  },
  "required": [
    "slug"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Output Schema

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "slug": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "project": {
          "type": "string"
        },
        "url": {
          "type": "string"
        },
        "status": {
          "type": "string"
        },
        "paused": {
          "type": "boolean"
        },
        "public": {
          "type": "boolean"
        },
        "checkFrom": {
          "type": "string",
          "enum": [
            "us-west",
            "us-east",
            "split"
          ],
          "description": "where the homepage, nav and newest-content checks run; a failure is checked again from the other location before it alerts or counts against uptime"
        },
        "week": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "from": {
                  "type": "string",
                  "description": "ISO 8601, UTC (…Z)"
                },
                "to": {
                  "type": "string",
                  "description": "ISO 8601, UTC (…Z)"
                },
                "uptime": {
                  "type": "object",
                  "properties": {
                    "ok": {
                      "type": "integer",
                      "minimum": -9007199254740991,
                      "maximum": 9007199254740991
                    },
                    "total": {
                      "type": "integer",
                      "minimum": -9007199254740991,
                      "maximum": 9007199254740991
                    },
                    "percent": {
                      "description": "ok / total × 100, two decimals; null with no checks",
                      "type": [
                        "number",
                        "null"
                      ]
                    }
                  },
                  "additionalProperties": {}
                },
                "typicalMs": {
                  "description": "median homepage response time (time to first byte); for a site checked from both locations, of their average, each location counted once",
                  "type": [
                    "number",
                    "null"
                  ]
                },
                "outages": {
                  "type": "integer",
                  "minimum": -9007199254740991,
                  "maximum": 9007199254740991
                },
                "longestOutageMs": {
                  "type": [
                    "number",
                    "null"
                  ]
                },
                "warnings": {
                  "type": "integer",
                  "minimum": -9007199254740991,
                  "maximum": 9007199254740991
                },
                "dismissed": {
                  "type": "integer",
                  "minimum": -9007199254740991,
                  "maximum": 9007199254740991
                },
                "readers": {
                  "anyOf": [
                    {
                      "type": "object",
                      "properties": {
                        "periodEnd": {
                          "type": "string"
                        },
                        "lcpP75": {
                          "type": [
                            "number",
                            "null"
                          ]
                        },
                        "inpP75": {
                          "type": [
                            "number",
                            "null"
                          ]
                        },
                        "clsP75": {
                          "type": [
                            "number",
                            "null"
                          ]
                        },
                        "ttfbP75": {
                          "type": [
                            "number",
                            "null"
                          ]
                        }
                      },
                      "additionalProperties": {}
                    },
                    {
                      "type": "null"
                    }
                  ],
                  "description": "real readers on phones (Chrome UX Report, 28 days); null when Chrome has too little data. Times in ms"
                },
                "htmlBytes": {
                  "type": "object",
                  "properties": {
                    "now": {
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "weekAgo": {
                      "type": [
                        "number",
                        "null"
                      ]
                    }
                  },
                  "additionalProperties": {}
                },
                "brokenLinkPages": {
                  "type": "integer",
                  "minimum": -9007199254740991,
                  "maximum": 9007199254740991
                },
                "pageErrors": {
                  "type": "boolean",
                  "description": "new errors from the site's own code right now"
                },
                "traffic": {
                  "anyOf": [
                    {
                      "type": "object",
                      "properties": {
                        "visits": {
                          "type": "number"
                        },
                        "weekBefore": {
                          "type": [
                            "number",
                            "null"
                          ]
                        },
                        "pages": {
                          "type": "number"
                        },
                        "cacheHits": {
                          "type": "number"
                        }
                      },
                      "additionalProperties": {}
                    },
                    {
                      "type": "null"
                    }
                  ]
                }
              },
              "additionalProperties": {}
            },
            {
              "type": "null"
            }
          ],
          "description": "the last 7 days, as in the weekly brief; null for paused sites"
        },
        "openIncidents": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "kind": {
                "type": "string"
              },
              "label": {
                "type": "string"
              },
              "severity": {
                "type": "string",
                "enum": [
                  "down",
                  "warning"
                ]
              },
              "site": {
                "description": "site slug",
                "type": [
                  "string",
                  "null"
                ]
              },
              "url": {
                "description": "the page or file it's about",
                "type": [
                  "string",
                  "null"
                ]
              },
              "domain": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "startedAt": {
                "type": "string",
                "description": "ISO 8601, UTC (…Z)"
              },
              "resolvedAt": {
                "anyOf": [
                  {
                    "type": "string",
                    "description": "ISO 8601, UTC (…Z)"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "cause": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "details": {
                "type": "object",
                "propertyNames": {
                  "type": "string"
                },
                "additionalProperties": {}
              },
              "dismissed": {
                "anyOf": [
                  {
                    "type": "object",
                    "properties": {
                      "by": {
                        "type": "string"
                      },
                      "at": {
                        "type": "string",
                        "description": "ISO 8601, UTC (…Z)"
                      }
                    },
                    "additionalProperties": {}
                  },
                  {
                    "type": "null"
                  }
                ],
                "description": "the team marked it as noise: still open, never alerts again"
              },
              "likelyCause": {
                "description": "open outages and slowdowns only: the monitor's rules, as in the alert",
                "anyOf": [
                  {
                    "type": "object",
                    "properties": {
                      "likely": {
                        "type": [
                          "string",
                          "null"
                        ]
                      },
                      "clues": {
                        "type": "array",
                        "items": {
                          "type": "string"
                        }
                      }
                    },
                    "additionalProperties": {}
                  },
                  {
                    "type": "null"
                  }
                ]
              }
            },
            "additionalProperties": {}
          }
        },
        "domain": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string"
                },
                "expiresAt": {
                  "anyOf": [
                    {
                      "type": "string",
                      "description": "ISO 8601, UTC (…Z)"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "daysLeft": {
                  "type": [
                    "number",
                    "null"
                  ]
                },
                "registrar": {
                  "type": [
                    "string",
                    "null"
                  ]
                }
              },
              "additionalProperties": {}
            },
            {
              "type": "null"
            }
          ]
        },
        "tls": {
          "type": "object",
          "properties": {
            "expiresAt": {
              "anyOf": [
                {
                  "type": "string",
                  "description": "ISO 8601, UTC (…Z)"
                },
                {
                  "type": "null"
                }
              ]
            },
            "daysLeft": {
              "type": [
                "number",
                "null"
              ]
            },
            "issuer": {
              "type": [
                "string",
                "null"
              ]
            }
          },
          "additionalProperties": {}
        }
      },
      "additionalProperties": {}
    },
    "next_steps": {
      "description": "calls that usually come next, each naming its tool",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "method": {
            "type": "string"
          },
          "path": {
            "type": "string"
          },
          "why": {
            "type": "string"
          },
          "tool": {
            "description": "the tool that makes this call",
            "type": "string"
          }
        },
        "additionalProperties": {}
      }
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": {}
}
🟢sites_by_slug_insights(slug)

Wraps GET /api/sites/{slug}/insights. One site's daily insights: page weight, security headers, prefetches, page errors, broken links, cache, dead ends. Call this when a site is slow or heavy, or to find what to fix: the daily browser load's page weight, missing security headers, JavaScript errors and broken links.

Input Schema

{
  "type": "object",
  "properties": {
    "slug": {
      "type": "string",
      "description": "site slug, as in /api/sites"
    }
  },
  "required": [
    "slug"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Output Schema

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "readers": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "periodEnd": {
                  "type": "string"
                },
                "lcpP75": {
                  "type": [
                    "number",
                    "null"
                  ]
                },
                "inpP75": {
                  "type": [
                    "number",
                    "null"
                  ]
                },
                "clsP75": {
                  "type": [
                    "number",
                    "null"
                  ]
                },
                "ttfbP75": {
                  "type": [
                    "number",
                    "null"
                  ]
                }
              },
              "additionalProperties": {}
            },
            {
              "type": "null"
            }
          ],
          "description": "real readers on phones (Chrome UX Report, 28 days); null when Chrome has too little data. Times in ms"
        },
        "pages": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "url": {
                "type": "string"
              },
              "latest": {
                "anyOf": [
                  {
                    "type": "object",
                    "properties": {
                      "day": {
                        "type": "string"
                      },
                      "measuredAt": {
                        "type": "string",
                        "description": "ISO 8601, UTC (…Z)"
                      },
                      "ok": {
                        "type": "boolean"
                      },
                      "error": {
                        "type": [
                          "string",
                          "null"
                        ]
                      },
                      "htmlBytes": {
                        "type": [
                          "number",
                          "null"
                        ]
                      },
                      "wireBytes": {
                        "type": [
                          "number",
                          "null"
                        ]
                      },
                      "scripts": {
                        "type": [
                          "number",
                          "null"
                        ]
                      },
                      "jsBytes": {
                        "type": [
                          "number",
                          "null"
                        ]
                      },
                      "cssBytes": {
                        "type": [
                          "number",
                          "null"
                        ]
                      },
                      "images": {
                        "type": [
                          "number",
                          "null"
                        ]
                      },
                      "frameworkBytes": {
                        "type": [
                          "number",
                          "null"
                        ]
                      },
                      "headers": {
                        "type": "object",
                        "properties": {
                          "grade": {
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "findings": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "id": {
                                  "type": "string"
                                },
                                "ok": {
                                  "type": "boolean"
                                },
                                "weight": {
                                  "type": "number"
                                },
                                "detail": {
                                  "type": "string"
                                }
                              },
                              "additionalProperties": {}
                            }
                          }
                        },
                        "additionalProperties": {}
                      },
                      "prefetches": {
                        "type": "object",
                        "properties": {
                          "requests": {
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "prefetches": {
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "pages": {
                            "type": [
                              "number",
                              "null"
                            ]
                          },
                          "uncached": {
                            "type": [
                              "number",
                              "null"
                            ]
                          }
                        },
                        "additionalProperties": {}
                      },
                      "pageErrors": {
                        "anyOf": [
                          {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "kind": {
                                  "type": "string",
                                  "enum": [
                                    "exception",
                                    "console",
                                    "asset"
                                  ]
                                },
                                "message": {
                                  "type": "string"
                                },
                                "source": {
                                  "type": [
                                    "string",
                                    "null"
                                  ]
                                },
                                "own": {
                                  "type": "boolean"
                                },
                                "count": {
                                  "type": "number"
                                }
                              },
                              "additionalProperties": {}
                            }
                          },
                          {
                            "type": "null"
                          }
                        ],
                        "description": "null when the browser view didn't run"
                      },
                      "badgeLinks": {
                        "anyOf": [
                          {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "href": {
                                  "type": "string"
                                },
                                "rel": {
                                  "type": "string",
                                  "description": "its rel tokens, \"\" when none"
                                }
                              },
                              "additionalProperties": {}
                            }
                          },
                          {
                            "type": "null"
                          }
                        ],
                        "description": "links on the page to our public status pages (an embedded badge, or a plain link); null when not looked for"
                      }
                    },
                    "additionalProperties": {}
                  },
                  {
                    "type": "null"
                  }
                ]
              }
            },
            "additionalProperties": {}
          },
          "description": "the homepage and the newest page, measured daily"
        },
        "cache": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "pages": {
                  "type": "integer",
                  "minimum": -9007199254740991,
                  "maximum": 9007199254740991
                },
                "ok": {
                  "type": "integer",
                  "minimum": -9007199254740991,
                  "maximum": 9007199254740991
                },
                "hits": {
                  "type": "integer",
                  "minimum": -9007199254740991,
                  "maximum": 9007199254740991
                },
                "least": {
                  "anyOf": [
                    {
                      "type": "object",
                      "properties": {
                        "path": {
                          "type": "string"
                        },
                        "ok": {
                          "type": "integer",
                          "minimum": -9007199254740991,
                          "maximum": 9007199254740991
                        },
                        "hits": {
                          "type": "integer",
                          "minimum": -9007199254740991,
                          "maximum": 9007199254740991
                        }
                      },
                      "additionalProperties": {}
                    },
                    {
                      "type": "null"
                    }
                  ]
                }
              },
              "additionalProperties": {}
            },
            {
              "type": "null"
            }
          ],
          "description": "Cloudflare cache over the last 24 hours, across the site's monitored pages"
        },
        "brokenLinks": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "page": {
                "type": "string"
              },
              "links": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "url": {
                      "type": "string"
                    },
                    "status": {
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "error": {
                      "type": [
                        "string",
                        "null"
                      ]
                    }
                  },
                  "additionalProperties": {}
                }
              }
            },
            "additionalProperties": {}
          }
        },
        "pageChecks": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "day": {
                  "type": "string"
                },
                "pagesSeen": {
                  "type": "integer",
                  "minimum": -9007199254740991,
                  "maximum": 9007199254740991
                },
                "pagesChecked": {
                  "type": "integer",
                  "minimum": -9007199254740991,
                  "maximum": 9007199254740991
                },
                "notFound": {
                  "anyOf": [
                    {
                      "type": "object",
                      "properties": {
                        "state": {
                          "type": "string",
                          "enum": [
                            "not_found",
                            "soft_404",
                            "login",
                            "redirect_off_host",
                            "blocked",
                            "error"
                          ]
                        },
                        "status": {
                          "type": [
                            "number",
                            "null"
                          ]
                        },
                        "wayOn": {
                          "type": "boolean",
                          "description": "a 404 or 410 that links anywhere on the site, or has a search form"
                        },
                        "unconfirmed": {
                          "type": "boolean",
                          "description": "a bad answer a second made-up path didn't repeat"
                        }
                      },
                      "additionalProperties": {}
                    },
                    {
                      "type": "null"
                    }
                  ],
                  "description": "the answer to one made-up path; null when it didn't run"
                },
                "navOnly": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  },
                  "description": "pages whose only links are the navigation"
                },
                "noWayBack": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "page": {
                        "type": "string"
                      },
                      "parent": {
                        "type": "string"
                      }
                    },
                    "additionalProperties": {}
                  },
                  "description": "pages with no link to their section"
                },
                "unclearLabels": {
                  "anyOf": [
                    {
                      "type": "integer",
                      "minimum": -9007199254740991,
                      "maximum": 9007199254740991
                    },
                    {
                      "type": "null"
                    }
                  ],
                  "description": "links whose label says nothing alone (links hidden from assistive technology aren't counted); null when the pages' language isn't covered"
                }
              },
              "additionalProperties": {}
            },
            {
              "type": "null"
            }
          ],
          "description": "where people find no way forward: the pages the daily run reads, and one made-up path (latest day of the last 3)"
        },
        "apiChecks": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "spec": {
                "type": "string",
                "description": "the OpenAPI file's URL"
              },
              "day": {
                "type": "string"
              },
              "notChecked": {
                "description": "why nothing was probed (YAML, another host…)",
                "type": [
                  "string",
                  "null"
                ]
              },
              "probes": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "kind": {
                      "type": "string",
                      "enum": [
                        "not_found",
                        "unauthorized",
                        "list"
                      ]
                    },
                    "url": {
                      "type": "string"
                    },
                    "state": {
                      "type": "string",
                      "enum": [
                        "answered",
                        "blocked",
                        "redirect",
                        "error"
                      ]
                    },
                    "status": {
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "recovers": {
                      "description": "errors: the body says how to recover",
                      "type": [
                        "boolean",
                        "null"
                      ]
                    },
                    "paging": {
                      "description": "lists: a next link and a way to stop",
                      "type": [
                        "boolean",
                        "null"
                      ]
                    }
                  },
                  "additionalProperties": {}
                }
              }
            },
            "additionalProperties": {}
          },
          "description": "where agents find no way forward: up to three keyless GETs a day to the site's own API (latest day of the last 3)"
        }
      },
      "additionalProperties": {}
    },
    "next_steps": {
      "description": "calls that usually come next, each naming its tool",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "method": {
            "type": "string"
          },
          "path": {
            "type": "string"
          },
          "why": {
            "type": "string"
          },
          "tool": {
            "description": "the tool that makes this call",
            "type": "string"
          }
        },
        "additionalProperties": {}
      }
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": {}
}
🟢sites_by_slug_scans(slug, limit, offset)

Wraps GET /api/sites/{slug}/scans. One site's API recovery scans, newest first: state, how each ended, and findings by weight. Call this to see whether a site has been scanned for dead ends (API errors that don't say how to recover, lists without paging, pages nothing links to) and how the last scan came out. Scans are started from the dashboard by an admin or owner.

Input Schema

{
  "type": "object",
  "properties": {
    "slug": {
      "type": "string",
      "description": "site slug, as in /api/sites"
    },
    "limit": {
      "description": "page size, clamped to 1–100",
      "default": 20,
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "offset": {
      "description": "rows to skip, at most 1000",
      "default": 0,
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    }
  },
  "required": [
    "slug"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Output Schema

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "state": {
            "type": "string",
            "enum": [
              "quoting",
              "quoted",
              "queued",
              "running",
              "paused",
              "done",
              "stopped",
              "failed"
            ]
          },
          "ending": {
            "description": "how it ended: complete, team_stopped, we_stopped, ownership_lost, plan_changed, site_removed, blocked, budget, error",
            "type": [
              "string",
              "null"
            ]
          },
          "startedAt": {
            "anyOf": [
              {
                "type": "string",
                "description": "ISO 8601, UTC (…Z)"
              },
              {
                "type": "null"
              }
            ]
          },
          "finishedAt": {
            "anyOf": [
              {
                "type": "string",
                "description": "ISO 8601, UTC (…Z)"
              },
              {
                "type": "null"
              }
            ]
          },
          "kind": {
            "type": "string",
            "enum": [
              "scan",
              "rescan",
              "rerun"
            ]
          },
          "findings": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "high": {
                    "type": "number"
                  },
                  "medium": {
                    "type": "number"
                  },
                  "light": {
                    "type": "number"
                  },
                  "warning": {
                    "type": "number"
                  }
                },
                "additionalProperties": {}
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "additionalProperties": {}
      }
    },
    "limit": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "has_more": {
      "type": "boolean"
    },
    "next_steps": {
      "description": "calls that usually come next, each naming its tool",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "method": {
            "type": "string"
          },
          "path": {
            "type": "string"
          },
          "why": {
            "type": "string"
          },
          "tool": {
            "description": "the tool that makes this call",
            "type": "string"
          }
        },
        "additionalProperties": {}
      }
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": {}
}
🟢sites_by_slug_scans_by_id(slug, id)

Wraps GET /api/sites/{slug}/scans/{id}. One API recovery scan: what it saw, its findings, the fixes and what changed since the last scan. Call this for a scan's results: findings by weight with the places on the site, three to five fixes in words and as a block for a coding agent, and new, fixed and still-open findings since the previous scan. It never includes text from the scanned site.

Input Schema

{
  "type": "object",
  "properties": {
    "slug": {
      "type": "string",
      "description": "site slug, as in /api/sites"
    },
    "id": {
      "type": "string",
      "description": "scan id, as in /api/sites/{slug}/scans"
    }
  },
  "required": [
    "slug",
    "id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Output Schema

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "state": {
          "type": "string",
          "enum": [
            "quoting",
            "quoted",
            "queued",
            "running",
            "paused",
            "done",
            "stopped",
            "failed"
          ]
        },
        "ending": {
          "description": "how it ended: complete, team_stopped, we_stopped, ownership_lost, plan_changed, site_removed, blocked, budget, error",
          "type": [
            "string",
            "null"
          ]
        },
        "startedAt": {
          "anyOf": [
            {
              "type": "string",
              "description": "ISO 8601, UTC (…Z)"
            },
            {
              "type": "null"
            }
          ]
        },
        "finishedAt": {
          "anyOf": [
            {
              "type": "string",
              "description": "ISO 8601, UTC (…Z)"
            },
            {
              "type": "null"
            }
          ]
        },
        "kind": {
          "type": "string",
          "enum": [
            "scan",
            "rescan",
            "rerun"
          ]
        },
        "findings": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "high": {
                  "type": "number"
                },
                "medium": {
                  "type": "number"
                },
                "light": {
                  "type": "number"
                },
                "warning": {
                  "type": "number"
                }
              },
              "additionalProperties": {}
            },
            {
              "type": "null"
            }
          ]
        },
        "seen": {
          "anyOf": [
            {
              "type": "object",
              "propertyNames": {
                "type": "string"
              },
              "additionalProperties": {
                "type": "number"
              }
            },
            {
              "type": "null"
            }
          ],
          "description": "paths probed, pages read, requests…"
        },
        "items": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "check": {
                "type": "string"
              },
              "weight": {
                "type": "string",
                "enum": [
                  "high",
                  "medium",
                  "light",
                  "warning"
                ]
              },
              "count": {
                "type": "number"
              },
              "places": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "up to 50 paths on the site"
              }
            },
            "additionalProperties": {}
          }
        },
        "fixes": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "title": {
                "type": "string"
              },
              "text": {
                "type": "string"
              },
              "places": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "more": {
                "type": "number"
              }
            },
            "additionalProperties": {}
          }
        },
        "agentBlock": {
          "description": "the fixes for a coding agent, written by our code: no text from the site",
          "type": [
            "string",
            "null"
          ]
        },
        "compare": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "previous": {
                  "type": "string"
                },
                "fixed": {
                  "type": "number"
                },
                "added": {
                  "type": "number"
                },
                "open": {
                  "type": "number"
                },
                "notChecked": {
                  "type": "number"
                }
              },
              "additionalProperties": {}
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "additionalProperties": {}
    },
    "next_steps": {
      "description": "calls that usually come next, each naming its tool",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "method": {
            "type": "string"
          },
          "path": {
            "type": "string"
          },
          "why": {
            "type": "string"
          },
          "tool": {
            "description": "the tool that makes this call",
            "type": "string"
          }
        },
        "additionalProperties": {}
      }
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": {}
}
🟢sites_by_slug_maintenance(slug)

Wraps GET /api/sites/{slug}/maintenance. One site's maintenance windows: on now, scheduled, and the last 30 days. Call this to see whether a site is in a maintenance window (its alerts held, its uptime not counting that time) and when the next one is. Windows are started from the dashboard or a deploy calling the site's maintenance URL (POST <url>/start?minutes=30, POST <url>/end), which the dashboard shows to admins.

Input Schema

{
  "type": "object",
  "properties": {
    "slug": {
      "type": "string",
      "description": "site slug, as in /api/sites"
    }
  },
  "required": [
    "slug"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Output Schema

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "windows": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "startsAt": {
                "type": "string"
              },
              "endsAt": {
                "type": "string",
                "description": "at most 24 hours after startsAt; an early end shows here"
              },
              "state": {
                "type": "string",
                "enum": [
                  "scheduled",
                  "on",
                  "ended"
                ]
              },
              "scope": {
                "type": "string",
                "enum": [
                  "site",
                  "project"
                ],
                "description": "this site only, or every site in its project"
              },
              "reason": {
                "description": "the team's own words; never on the public page",
                "type": [
                  "string",
                  "null"
                ]
              },
              "createdBy": {
                "type": "string",
                "description": "a person, or \"maintenance URL\""
              },
              "endedBy": {
                "description": "who ended it early; null when it ran its course",
                "type": [
                  "string",
                  "null"
                ]
              }
            },
            "additionalProperties": {}
          },
          "description": "newest start first"
        }
      },
      "additionalProperties": {}
    },
    "next_steps": {
      "description": "calls that usually come next, each naming its tool",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "method": {
            "type": "string"
          },
          "path": {
            "type": "string"
          },
          "why": {
            "type": "string"
          },
          "tool": {
            "description": "the tool that makes this call",
            "type": "string"
          }
        },
        "additionalProperties": {}
      }
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": {}
}
🟢sites_by_slug_map(slug, range, section)

Wraps GET /api/sites/{slug}/map. One site's structure from its sitemaps: sections, new and removed pages, what fails. Call this to see where a site is changing or breaking without crawling it: every path with pages under it, with new and removed pages in the window, pages that fail, broken links and sitemaps that miss pages. Add ?section= for one section's pages. Our sites only (competitors' sitemaps aren't read).

Input Schema

{
  "type": "object",
  "properties": {
    "slug": {
      "type": "string",
      "description": "site slug, as in /api/sites"
    },
    "range": {
      "default": "7d",
      "description": "the window for new and removed pages",
      "type": "string",
      "enum": [
        "24h",
        "7d",
        "30d"
      ]
    },
    "section": {
      "description": "a section path such as \"/c\" to list its pages",
      "type": "string"
    }
  },
  "required": [
    "slug"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Output Schema

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "range": {
          "type": "string"
        },
        "sitemaps": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "firstFetchAt": {
          "anyOf": [
            {
              "type": "string",
              "description": "ISO 8601, UTC (…Z)"
            },
            {
              "type": "null"
            }
          ],
          "description": "pages listed then count as there from the start, never as new"
        },
        "pages": {
          "type": "number"
        },
        "newInWindow": {
          "type": "number"
        },
        "removedInWindow": {
          "type": "number"
        },
        "checked": {
          "type": "number",
          "description": "pages the monitor checks itself; the rest are known from the sitemap"
        },
        "linkChecked": {
          "description": "listed URLs link-checked in the last 7 days, when every sitemap URL is checked",
          "type": [
            "number",
            "null"
          ]
        },
        "history": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "day": {
                "type": "string",
                "description": "YYYY-MM-DD, a UTC day"
              },
              "pages": {
                "type": "number",
                "description": "pages listed at the day's end"
              },
              "new": {
                "type": "number"
              },
              "removed": {
                "type": "number"
              }
            },
            "additionalProperties": {}
          },
          "description": "the whole site's days in the window (at least two), oldest first; kept 400 days, since monitoring began"
        },
        "sections": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "path": {
                "type": "string",
                "description": "\"/c/alaska-news\" (no trailing slash)"
              },
              "depth": {
                "type": "number",
                "description": "1 for a top-level section"
              },
              "pages": {
                "type": "number",
                "description": "live pages at or under this path"
              },
              "newInWindow": {
                "type": "number",
                "description": "first seen in the window (not in the sitemap's first fetch)"
              },
              "removedInWindow": {
                "type": "number",
                "description": "dropped from every sitemap in the window (removed pages are kept 30 days)"
              },
              "newest": {
                "anyOf": [
                  {
                    "type": "string",
                    "description": "ISO 8601, UTC (…Z)"
                  },
                  {
                    "type": "null"
                  }
                ],
                "description": "newest page's content date, else first seen"
              },
              "tone": {
                "type": "string",
                "enum": [
                  "up",
                  "warn",
                  "down"
                ],
                "description": "up: no known problem; warn: warnings or more than 20% removed; down: a page fails"
              },
              "failing": {
                "type": "number",
                "description": "listed URLs that fail"
              },
              "brokenLinkPages": {
                "type": "number",
                "description": "pages with an open broken-links incident"
              },
              "checked": {
                "type": "number",
                "description": "pages the monitor checks itself"
              },
              "missingFrom": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "sitemap": {
                      "type": "string"
                    },
                    "count": {
                      "type": "number"
                    }
                  },
                  "additionalProperties": {}
                },
                "description": "sitemaps that list at least half the pages here but miss some, and how many they miss"
              },
              "history": {
                "anyOf": [
                  {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "day": {
                          "type": "string",
                          "description": "YYYY-MM-DD, a UTC day"
                        },
                        "pages": {
                          "type": "number",
                          "description": "pages listed at the day's end"
                        },
                        "new": {
                          "type": "number"
                        },
                        "removed": {
                          "type": "number"
                        }
                      },
                      "additionalProperties": {}
                    }
                  },
                  {
                    "type": "null"
                  }
                ],
                "description": "a top-level section's days in the window, oldest first; null below the top level"
              }
            },
            "additionalProperties": {}
          },
          "description": "every path with pages under it, largest first within each level; a lone page such as /about is a page, not a section"
        },
        "pagesShown": {
          "anyOf": [
            {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "url": {
                    "type": "string"
                  },
                  "path": {
                    "type": "string"
                  },
                  "title": {
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  "date": {
                    "type": "string",
                    "description": "content date (published, created, last modified), else first seen"
                  },
                  "isNew": {
                    "type": "boolean"
                  },
                  "checked": {
                    "type": "boolean"
                  },
                  "tone": {
                    "type": "string",
                    "enum": [
                      "up",
                      "warn",
                      "down"
                    ]
                  },
                  "fails": {
                    "type": "boolean"
                  },
                  "hasBrokenLinks": {
                    "type": "boolean"
                  },
                  "missingFrom": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  }
                },
                "additionalProperties": {}
              }
            },
            {
              "type": "null"
            }
          ],
          "description": "with ?section=: that section's pages, newest first, at most 1000"
        }
      },
      "additionalProperties": {}
    },
    "next_steps": {
      "description": "calls that usually come next, each naming its tool",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "method": {
            "type": "string"
          },
          "path": {
            "type": "string"
          },
          "why": {
            "type": "string"
          },
          "tool": {
            "description": "the tool that makes this call",
            "type": "string"
          }
        },
        "additionalProperties": {}
      }
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": {}
}
🟢sites_by_slug_events(slug, range, limit, offset)

Wraps GET /api/sites/{slug}/events. What changed on one site: incidents opened and resolved, code pushes, maintenance, new pages. Call this to find what changed before a number moved (clicks fell, pages got slower): the site's timeline, newest first, the same events the dashboard draws on its charts. Page through with limit and offset.

Input Schema

{
  "type": "object",
  "properties": {
    "slug": {
      "type": "string",
      "description": "site slug, as in /api/sites"
    },
    "range": {
      "default": "7d",
      "description": "the window",
      "type": "string",
      "enum": [
        "24h",
        "7d",
        "30d"
      ]
    },
    "limit": {
      "description": "page size, clamped to 1–200",
      "default": 50,
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "offset": {
      "description": "rows to skip, at most 1000",
      "default": 0,
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    }
  },
  "required": [
    "slug"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Output Schema

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "stable id: <source>:<row id>[:resolved]"
          },
          "at": {
            "type": "string",
            "description": "ISO 8601, UTC (…Z)"
          },
          "kind": {
            "type": "string",
            "enum": [
              "incident",
              "resolved",
              "push",
              "maintenance",
              "paused",
              "resumed",
              "published"
            ]
          },
          "incidentKind": {
            "description": "for incident and resolved events, as in /api/incidents",
            "type": "string"
          },
          "tone": {
            "type": "string",
            "enum": [
              "down",
              "warning",
              "change"
            ],
            "description": "a problem in its severity, or a change"
          },
          "glyph": {
            "type": "string",
            "enum": [
              "problem",
              "search",
              "config",
              "push",
              "published",
              "paused"
            ],
            "description": "what kind of change: drawn as the chart rail's shape"
          },
          "label": {
            "type": "string",
            "description": "one line in our words; for a push, its commit's first line"
          },
          "detail": {
            "description": "an incident's cause, a push's repo and author, a window's reason",
            "type": [
              "string",
              "null"
            ]
          },
          "before": {
            "type": "string"
          },
          "after": {
            "type": "string"
          },
          "href": {
            "description": "the commit, or the incident on the dashboard",
            "type": "string"
          },
          "targetId": {
            "type": [
              "string",
              "null"
            ]
          },
          "until": {
            "description": "a maintenance window's end",
            "type": "string"
          }
        },
        "additionalProperties": {}
      }
    },
    "limit": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "has_more": {
      "type": "boolean"
    },
    "next_steps": {
      "description": "calls that usually come next, each naming its tool",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "method": {
            "type": "string"
          },
          "path": {
            "type": "string"
          },
          "why": {
            "type": "string"
          },
          "tool": {
            "description": "the tool that makes this call",
            "type": "string"
          }
        },
        "additionalProperties": {}
      }
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": {}
}
🟢incidents(state, site, limit, offset)

Wraps GET /api/incidents. Incidents, open now or recent; open outages and slowdowns carry the likely cause. Call this to see what went wrong and why: open and recent incidents, newest first, with the likely cause on open outages and slowdowns. Page through with limit and offset.

Input Schema

{
  "type": "object",
  "properties": {
    "state": {
      "default": "open",
      "description": "open: open now; recent: newest first, open or closed",
      "type": "string",
      "enum": [
        "open",
        "recent"
      ]
    },
    "site": {
      "description": "site slug",
      "type": "string"
    },
    "limit": {
      "description": "page size, clamped to 1–100",
      "default": 20,
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "offset": {
      "description": "rows to skip, at most 1000",
      "default": 0,
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Output Schema

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "kind": {
            "type": "string"
          },
          "label": {
            "type": "string"
          },
          "severity": {
            "type": "string",
            "enum": [
              "down",
              "warning"
            ]
          },
          "site": {
            "description": "site slug",
            "type": [
              "string",
              "null"
            ]
          },
          "url": {
            "description": "the page or file it's about",
            "type": [
              "string",
              "null"
            ]
          },
          "domain": {
            "type": [
              "string",
              "null"
            ]
          },
          "startedAt": {
            "type": "string",
            "description": "ISO 8601, UTC (…Z)"
          },
          "resolvedAt": {
            "anyOf": [
              {
                "type": "string",
                "description": "ISO 8601, UTC (…Z)"
              },
              {
                "type": "null"
              }
            ]
          },
          "cause": {
            "type": [
              "string",
              "null"
            ]
          },
          "details": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {}
          },
          "dismissed": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "by": {
                    "type": "string"
                  },
                  "at": {
                    "type": "string",
                    "description": "ISO 8601, UTC (…Z)"
                  }
                },
                "additionalProperties": {}
              },
              {
                "type": "null"
              }
            ],
            "description": "the team marked it as noise: still open, never alerts again"
          },
          "likelyCause": {
            "description": "open outages and slowdowns only: the monitor's rules, as in the alert",
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "likely": {
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  "clues": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  }
                },
                "additionalProperties": {}
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "additionalProperties": {}
      }
    },
    "limit": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "has_more": {
      "type": "boolean"
    },
    "next_steps": {
      "description": "calls that usually come next, each naming its tool",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "method": {
            "type": "string"
          },
          "path": {
            "type": "string"
          },
          "why": {
            "type": "string"
          },
          "tool": {
            "description": "the tool that makes this call",
            "type": "string"
          }
        },
        "additionalProperties": {}
      }
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": {}
}
🟢domains

Wraps GET /api/domains. The team's domains: registration expiry, registrar, nameservers, status. Call this to check renewals: which domains expire soon, who the registrar is, and whether nameservers or registry locks changed.

Input Schema

{
  "type": "object",
  "properties": {},
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Output Schema

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "expiresAt": {
            "anyOf": [
              {
                "type": "string",
                "description": "ISO 8601, UTC (…Z)"
              },
              {
                "type": "null"
              }
            ]
          },
          "daysLeft": {
            "type": [
              "number",
              "null"
            ]
          },
          "registrar": {
            "type": [
              "string",
              "null"
            ]
          },
          "nameservers": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "statusFlags": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "lastCheckedAt": {
            "anyOf": [
              {
                "type": "string",
                "description": "ISO 8601, UTC (…Z)"
              },
              {
                "type": "null"
              }
            ]
          },
          "sites": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "additionalProperties": {}
      }
    },
    "next_steps": {
      "description": "calls that usually come next, each naming its tool",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "method": {
            "type": "string"
          },
          "path": {
            "type": "string"
          },
          "why": {
            "type": "string"
          },
          "tool": {
            "description": "the tool that makes this call",
            "type": "string"
          }
        },
        "additionalProperties": {}
      }
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": {}
}
🟢public_sites

Wraps GET /api/public/sites. Every public site's status and uptime, no key needed. Call this to see the public status pages' sites right now, without a key: each one's status, typical response time and uptime, as the status page shows them.

Input Schema

{
  "type": "object",
  "properties": {},
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Output Schema

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "generatedAt": {
          "type": "string",
          "description": "ISO 8601, UTC (…Z)"
        },
        "overall": {
          "type": "object",
          "properties": {
            "state": {
              "type": "string",
              "description": "up, warning or down"
            },
            "sentence": {
              "type": "string"
            },
            "up": {
              "type": "integer",
              "minimum": -9007199254740991,
              "maximum": 9007199254740991
            },
            "down": {
              "type": "integer",
              "minimum": -9007199254740991,
              "maximum": 9007199254740991
            },
            "warnings": {
              "type": "integer",
              "minimum": -9007199254740991,
              "maximum": 9007199254740991
            }
          },
          "additionalProperties": {}
        },
        "lastCheckedAt": {
          "anyOf": [
            {
              "type": "string",
              "description": "ISO 8601, UTC (…Z)"
            },
            {
              "type": "null"
            }
          ]
        },
        "sites": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "slug": {
                "type": "string",
                "description": "the site's slug, for /api/public/sites/{slug}"
              },
              "name": {
                "type": "string"
              },
              "state": {
                "type": "string",
                "description": "its tone: up, warning, down or unknown"
              },
              "status": {
                "type": "string",
                "description": "\"Up\", \"Down for 4m\", or how overdue its checks are"
              },
              "project": {
                "type": "string"
              },
              "typicalFirstByteMs": {
                "type": [
                  "number",
                  "null"
                ]
              },
              "uptime": {
                "anyOf": [
                  {
                    "type": "object",
                    "properties": {
                      "ratio": {
                        "type": "number"
                      },
                      "period": {
                        "type": "string"
                      }
                    },
                    "additionalProperties": {}
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "statusPage": {
                "type": "string",
                "description": "its public status page"
              },
              "data": {
                "type": "string",
                "description": "its numbers as JSON"
              }
            },
            "additionalProperties": {}
          }
        }
      },
      "additionalProperties": {}
    },
    "next_steps": {
      "description": "calls that usually come next, each naming its tool",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "method": {
            "type": "string"
          },
          "path": {
            "type": "string"
          },
          "why": {
            "type": "string"
          },
          "tool": {
            "description": "the tool that makes this call",
            "type": "string"
          }
        },
        "additionalProperties": {}
      }
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": {}
}
🟢public_sites_by_slug(slug)

Wraps GET /api/public/sites/{slug}. One public site's 90 days: daily uptime, response time and outages, no key needed. Call this for a public site's history without a key: uptime over 1, 7, 30 and 90 days, one row per day and every outage, the same numbers as its status page (CC BY 4.0).

Input Schema

{
  "type": "object",
  "properties": {
    "slug": {
      "type": "string",
      "description": "site slug, as in /api/sites"
    }
  },
  "required": [
    "slug"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Output Schema

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "site": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string"
            },
            "url": {
              "type": "string"
            },
            "statusPage": {
              "type": "string"
            }
          },
          "additionalProperties": {}
        },
        "generatedAt": {
          "type": "string",
          "description": "ISO 8601, UTC (…Z)"
        },
        "timezone": {
          "type": "string"
        },
        "checkedFrom": {
          "type": "string",
          "description": "us-west, us-east or split"
        },
        "monitoringSince": {
          "description": "YYYY-MM-DD, the first day with checks in the last 90 days",
          "type": [
            "string",
            "null"
          ]
        },
        "license": {
          "type": "string"
        },
        "attribution": {
          "type": "string"
        },
        "uptime": {
          "type": "object",
          "properties": {
            "d1": {
              "anyOf": [
                {
                  "type": "object",
                  "properties": {
                    "ok": {
                      "type": "integer",
                      "minimum": -9007199254740991,
                      "maximum": 9007199254740991
                    },
                    "total": {
                      "type": "integer",
                      "minimum": -9007199254740991,
                      "maximum": 9007199254740991
                    },
                    "percent": {
                      "type": [
                        "number",
                        "null"
                      ]
                    }
                  },
                  "additionalProperties": {}
                },
                {
                  "type": "null"
                }
              ]
            },
            "d7": {
              "anyOf": [
                {
                  "type": "object",
                  "properties": {
                    "ok": {
                      "type": "integer",
                      "minimum": -9007199254740991,
                      "maximum": 9007199254740991
                    },
                    "total": {
                      "type": "integer",
                      "minimum": -9007199254740991,
                      "maximum": 9007199254740991
                    },
                    "percent": {
                      "type": [
                        "number",
                        "null"
                      ]
                    }
                  },
                  "additionalProperties": {}
                },
                {
                  "type": "null"
                }
              ]
            },
            "d30": {
              "anyOf": [
                {
                  "type": "object",
                  "properties": {
                    "ok": {
                      "type": "integer",
                      "minimum": -9007199254740991,
                      "maximum": 9007199254740991
                    },
                    "total": {
                      "type": "integer",
                      "minimum": -9007199254740991,
                      "maximum": 9007199254740991
                    },
                    "percent": {
                      "type": [
                        "number",
                        "null"
                      ]
                    }
                  },
                  "additionalProperties": {}
                },
                {
                  "type": "null"
                }
              ]
            },
            "d90": {
              "anyOf": [
                {
                  "type": "object",
                  "properties": {
                    "ok": {
                      "type": "integer",
                      "minimum": -9007199254740991,
                      "maximum": 9007199254740991
                    },
                    "total": {
                      "type": "integer",
                      "minimum": -9007199254740991,
                      "maximum": 9007199254740991
                    },
                    "percent": {
                      "type": [
                        "number",
                        "null"
                      ]
                    }
                  },
                  "additionalProperties": {}
                },
                {
                  "type": "null"
                }
              ]
            },
            "since": {
              "anyOf": [
                {
                  "type": "object",
                  "properties": {
                    "ok": {
                      "type": "integer",
                      "minimum": -9007199254740991,
                      "maximum": 9007199254740991
                    },
                    "total": {
                      "type": "integer",
                      "minimum": -9007199254740991,
                      "maximum": 9007199254740991
                    },
                    "percent": {
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "from": {
                      "type": "string"
                    }
                  },
                  "additionalProperties": {}
                },
                {
                  "type": "null"
                }
              ]
            }
          },
          "additionalProperties": {},
          "description": "a period watched in full, else null"
        },
        "days": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "date": {
                "type": "string"
              },
              "checks": {
                "type": "integer",
                "minimum": -9007199254740991,
                "maximum": 9007199254740991
              },
              "failed": {
                "type": "integer",
                "minimum": -9007199254740991,
                "maximum": 9007199254740991
              },
              "unconfirmed": {
                "type": "integer",
                "minimum": -9007199254740991,
                "maximum": 9007199254740991
              },
              "maintenance": {
                "type": "integer",
                "minimum": -9007199254740991,
                "maximum": 9007199254740991
              },
              "uptime": {
                "type": [
                  "number",
                  "null"
                ]
              },
              "ttfbMs": {
                "type": [
                  "number",
                  "null"
                ]
              },
              "totalMs": {
                "type": [
                  "number",
                  "null"
                ]
              }
            },
            "additionalProperties": {}
          }
        },
        "outages": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "start": {
                "type": "string",
                "description": "ISO 8601, UTC (…Z)"
              },
              "end": {
                "anyOf": [
                  {
                    "type": "string",
                    "description": "ISO 8601, UTC (…Z)"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "durationS": {
                "type": "integer",
                "minimum": -9007199254740991,
                "maximum": 9007199254740991
              }
            },
            "additionalProperties": {}
          }
        },
        "notes": {
          "type": "string"
        }
      },
      "additionalProperties": {}
    },
    "next_steps": {
      "description": "calls that usually come next, each naming its tool",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "method": {
            "type": "string"
          },
          "path": {
            "type": "string"
          },
          "why": {
            "type": "string"
          },
          "tool": {
            "description": "the tool that makes this call",
            "type": "string"
          }
        },
        "additionalProperties": {}
      }
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": {}
}
🟡incidents_by_id_dismiss(id)

Wraps POST /api/incidents/{id}/dismiss. Dismiss an open incident as noise. Hides it from the open lists for the whole team; it never alerts again and closes without a message. Not every kind can be dismissed (409). It acts for the whole team. Needs a Member or Admin key, on a team with 10 sites or more.

Input Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "incident id, as in /api/incidents"
    }
  },
  "required": [
    "id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Output Schema

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "kind": {
          "type": "string"
        },
        "site": {
          "description": "its site's slug",
          "type": [
            "string",
            "null"
          ]
        },
        "dismissed": {
          "type": "boolean"
        },
        "recheckRequested": {
          "type": "boolean"
        }
      },
      "additionalProperties": {}
    },
    "next_steps": {
      "description": "calls that usually come next, each naming its tool",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "method": {
            "type": "string"
          },
          "path": {
            "type": "string"
          },
          "why": {
            "type": "string"
          },
          "tool": {
            "description": "the tool that makes this call",
            "type": "string"
          }
        },
        "additionalProperties": {}
      }
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": {}
}
🟡incidents_by_id_undismiss(id)

Wraps POST /api/incidents/{id}/undismiss. Bring back a dismissed incident. Undoes a dismiss: the incident shows and alerts again. It acts for the whole team. Needs a Member or Admin key, on a team with 10 sites or more.

Input Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "incident id, as in /api/incidents"
    }
  },
  "required": [
    "id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Output Schema

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "kind": {
          "type": "string"
        },
        "site": {
          "description": "its site's slug",
          "type": [
            "string",
            "null"
          ]
        },
        "dismissed": {
          "type": "boolean"
        },
        "recheckRequested": {
          "type": "boolean"
        }
      },
      "additionalProperties": {}
    },
    "next_steps": {
      "description": "calls that usually come next, each naming its tool",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "method": {
            "type": "string"
          },
          "path": {
            "type": "string"
          },
          "why": {
            "type": "string"
          },
          "tool": {
            "description": "the tool that makes this call",
            "type": "string"
          }
        },
        "additionalProperties": {}
      }
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": {}
}
🟡incidents_by_id_recheck(id)

Wraps POST /api/incidents/{id}/recheck. Check an incident again now. The monitor checks it again within 30 seconds, after a fix, instead of waiting for the next scheduled check. Not every kind can be checked again (409). It acts for the whole team. Needs a Member or Admin key, on a team with 10 sites or more.

Input Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "incident id, as in /api/incidents"
    }
  },
  "required": [
    "id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Output Schema

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "kind": {
          "type": "string"
        },
        "site": {
          "description": "its site's slug",
          "type": [
            "string",
            "null"
          ]
        },
        "dismissed": {
          "type": "boolean"
        },
        "recheckRequested": {
          "type": "boolean"
        }
      },
      "additionalProperties": {}
    },
    "next_steps": {
      "description": "calls that usually come next, each naming its tool",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "method": {
            "type": "string"
          },
          "path": {
            "type": "string"
          },
          "why": {
            "type": "string"
          },
          "tool": {
            "description": "the tool that makes this call",
            "type": "string"
          }
        },
        "additionalProperties": {}
      }
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": {}
}
🟡sites_by_slug_maintenance_start(slug, minutes, reason)

Wraps POST /api/sites/{slug}/maintenance/start. Start a maintenance window on a site now. Call this before a deploy: alerts for the site are held (checks still run) until the window ends, after `minutes` (default 30, at most 24 hours) or when you end it. Starting again replaces the open window. It acts for the whole team. Needs a Member or Admin key, on a team with 10 sites or more.

Input Schema

{
  "type": "object",
  "properties": {
    "slug": {
      "type": "string",
      "description": "site slug, as in /api/sites"
    },
    "minutes": {
      "description": "how long, default 30",
      "type": "integer",
      "minimum": 1,
      "maximum": 1440
    },
    "reason": {
      "description": "the team's own words; never public",
      "type": "string",
      "maxLength": 200
    }
  },
  "required": [
    "slug"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Output Schema

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "startsAt": {
          "type": "string",
          "description": "ISO 8601, UTC (…Z)"
        },
        "endsAt": {
          "type": "string",
          "description": "ISO 8601, UTC (…Z)"
        },
        "reason": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "additionalProperties": {}
    },
    "next_steps": {
      "description": "calls that usually come next, each naming its tool",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "method": {
            "type": "string"
          },
          "path": {
            "type": "string"
          },
          "why": {
            "type": "string"
          },
          "tool": {
            "description": "the tool that makes this call",
            "type": "string"
          }
        },
        "additionalProperties": {}
      }
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": {}
}
🟡sites_by_slug_maintenance_end(slug)

Wraps POST /api/sites/{slug}/maintenance/end. End a site's maintenance windows now. Call this after a deploy: alerts for the site go out again from now. Ending with no window on answers `ended: 0`. It acts for the whole team. Needs a Member or Admin key, on a team with 10 sites or more.

Input Schema

{
  "type": "object",
  "properties": {
    "slug": {
      "type": "string",
      "description": "site slug, as in /api/sites"
    }
  },
  "required": [
    "slug"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Output Schema

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "ended": {
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991,
          "description": "windows ended"
        }
      },
      "additionalProperties": {}
    },
    "next_steps": {
      "description": "calls that usually come next, each naming its tool",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "method": {
            "type": "string"
          },
          "path": {
            "type": "string"
          },
          "why": {
            "type": "string"
          },
          "tool": {
            "description": "the tool that makes this call",
            "type": "string"
          }
        },
        "additionalProperties": {}
      }
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": {}
}
🔴sites_by_slug_pause(slug)

Wraps POST /api/sites/{slug}/pause. Pause a site's checks. Stops every check of the site, keeping its history, until it's resumed. Nothing alerts while it's paused. It acts for the whole team. Needs an Admin key, on a team with 10 sites or more.

Input Schema

{
  "type": "object",
  "properties": {
    "slug": {
      "type": "string",
      "description": "site slug, as in /api/sites"
    }
  },
  "required": [
    "slug"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Output Schema

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "slug": {
          "type": "string"
        },
        "paused": {
          "type": "boolean"
        }
      },
      "additionalProperties": {}
    },
    "next_steps": {
      "description": "calls that usually come next, each naming its tool",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "method": {
            "type": "string"
          },
          "path": {
            "type": "string"
          },
          "why": {
            "type": "string"
          },
          "tool": {
            "description": "the tool that makes this call",
            "type": "string"
          }
        },
        "additionalProperties": {}
      }
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": {}
}
🟡sites_by_slug_resume(slug)

Wraps POST /api/sites/{slug}/resume. Resume a paused site's checks. Starts the site's checks again within a minute. It acts for the whole team. Needs an Admin key, on a team with 10 sites or more.

Input Schema

{
  "type": "object",
  "properties": {
    "slug": {
      "type": "string",
      "description": "site slug, as in /api/sites"
    }
  },
  "required": [
    "slug"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Output Schema

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "slug": {
          "type": "string"
        },
        "paused": {
          "type": "boolean"
        }
      },
      "additionalProperties": {}
    },
    "next_steps": {
      "description": "calls that usually come next, each naming its tool",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "method": {
            "type": "string"
          },
          "path": {
            "type": "string"
          },
          "why": {
            "type": "string"
          },
          "tool": {
            "description": "the tool that makes this call",
            "type": "string"
          }
        },
        "additionalProperties": {}
      }
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": {}
}
🟡sites_by_slug_journeys_by_journey_run(slug, journey)

Wraps POST /api/sites/{slug}/journeys/{journey}/run. Run a journey now, as a job. Queues one run of the journey on its own model, as the journey page's Run now does; the monitor starts it within a minute and a run takes from 15 seconds to a few minutes. Answers 202 with `Location`: poll it until `status` is `finished`. One run at a time per journey, 5 an hour per team; it spends from the team's journey cap. Asking again while one is open answers 409 with the open one's `Location`. It acts for the whole team. Needs an Admin key, on a team with 10 sites or more.

Input Schema

{
  "type": "object",
  "properties": {
    "slug": {
      "type": "string",
      "description": "site slug, as in /api/sites"
    },
    "journey": {
      "type": "string",
      "description": "the journey's slug, as in its page's address /sites/{slug}/journeys/{journey}"
    }
  },
  "required": [
    "slug",
    "journey"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Output Schema

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "the request's id"
        },
        "status": {
          "type": "string",
          "enum": [
            "queued",
            "running",
            "finished"
          ],
          "description": "queued until the monitor starts it (within a minute), then running, then finished"
        },
        "statusUrl": {
          "type": "string",
          "description": "where to check on it: GET this until status is finished"
        },
        "requestedAt": {
          "type": "string",
          "description": "ISO 8601, UTC (…Z)"
        },
        "startedAt": {
          "anyOf": [
            {
              "type": "string",
              "description": "ISO 8601, UTC (…Z)"
            },
            {
              "type": "null"
            }
          ]
        },
        "finishedAt": {
          "anyOf": [
            {
              "type": "string",
              "description": "ISO 8601, UTC (…Z)"
            },
            {
              "type": "null"
            }
          ]
        },
        "run": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "verdict": {
                  "type": "string",
                  "enum": [
                    "pass",
                    "fail",
                    "inconclusive"
                  ],
                  "description": "as the journey's page says"
                },
                "reached": {
                  "description": "whether the agent reached the goal",
                  "type": [
                    "boolean",
                    "null"
                  ]
                },
                "model": {
                  "type": "string"
                },
                "costUsd": {
                  "type": "number"
                },
                "startedAt": {
                  "type": "string",
                  "description": "ISO 8601, UTC (…Z)"
                },
                "finishedAt": {
                  "type": "string",
                  "description": "ISO 8601, UTC (…Z)"
                }
              },
              "additionalProperties": {}
            },
            {
              "type": "null"
            }
          ],
          "description": "the run it made, once finished; null before, or if it couldn't run (the journey spend cap, say)"
        },
        "page": {
          "type": "string",
          "description": "the journey's page on the dashboard"
        }
      },
      "additionalProperties": {}
    },
    "next_steps": {
      "description": "calls that usually come next, each naming its tool",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "method": {
            "type": "string"
          },
          "path": {
            "type": "string"
          },
          "why": {
            "type": "string"
          },
          "tool": {
            "description": "the tool that makes this call",
            "type": "string"
          }
        },
        "additionalProperties": {}
      }
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": {}
}
🟢sites_by_slug_journeys_by_journey_requests_by_id(slug, journey, id)

Wraps GET /api/sites/{slug}/journeys/{journey}/requests/{id}. A journey run asked for with Run now: queued, running or finished, and its verdict. Poll this after asking for a run (every few seconds, as Retry-After says): `status` goes from queued to running to finished, and `run` then has the verdict.

Input Schema

{
  "type": "object",
  "properties": {
    "slug": {
      "type": "string",
      "description": "site slug, as in /api/sites"
    },
    "journey": {
      "type": "string",
      "description": "the journey's slug, as in its page's address /sites/{slug}/journeys/{journey}"
    },
    "id": {
      "type": "string",
      "description": "the request's id, from the run's 202"
    }
  },
  "required": [
    "slug",
    "journey",
    "id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Output Schema

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "the request's id"
        },
        "status": {
          "type": "string",
          "enum": [
            "queued",
            "running",
            "finished"
          ],
          "description": "queued until the monitor starts it (within a minute), then running, then finished"
        },
        "statusUrl": {
          "type": "string",
          "description": "where to check on it: GET this until status is finished"
        },
        "requestedAt": {
          "type": "string",
          "description": "ISO 8601, UTC (…Z)"
        },
        "startedAt": {
          "anyOf": [
            {
              "type": "string",
              "description": "ISO 8601, UTC (…Z)"
            },
            {
              "type": "null"
            }
          ]
        },
        "finishedAt": {
          "anyOf": [
            {
              "type": "string",
              "description": "ISO 8601, UTC (…Z)"
            },
            {
              "type": "null"
            }
          ]
        },
        "run": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "verdict": {
                  "type": "string",
                  "enum": [
                    "pass",
                    "fail",
                    "inconclusive"
                  ],
                  "description": "as the journey's page says"
                },
                "reached": {
                  "description": "whether the agent reached the goal",
                  "type": [
                    "boolean",
                    "null"
                  ]
                },
                "model": {
                  "type": "string"
                },
                "costUsd": {
                  "type": "number"
                },
                "startedAt": {
                  "type": "string",
                  "description": "ISO 8601, UTC (…Z)"
                },
                "finishedAt": {
                  "type": "string",
                  "description": "ISO 8601, UTC (…Z)"
                }
              },
              "additionalProperties": {}
            },
            {
              "type": "null"
            }
          ],
          "description": "the run it made, once finished; null before, or if it couldn't run (the journey spend cap, say)"
        },
        "page": {
          "type": "string",
          "description": "the journey's page on the dashboard"
        }
      },
      "additionalProperties": {}
    },
    "next_steps": {
      "description": "calls that usually come next, each naming its tool",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "method": {
            "type": "string"
          },
          "path": {
            "type": "string"
          },
          "why": {
            "type": "string"
          },
          "tool": {
            "description": "the tool that makes this call",
            "type": "string"
          }
        },
        "additionalProperties": {}
      }
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": {}
}

Community

Rate this Server

Evidence

Recent observations

verifiedversion not recorded22 tools