Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion admin/team-management/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Each account has one Owner. The account creator is the Owner until they [transfe
| Access locked variables | ✓ | ✓ | ✓ | ✗ | ✗ |
| Manage team members (only below their current role. i.e. Owners can remove Admins, but Admins cannot remove Owners or other Admins.) | ✓ | ✓ | ✗ | ✗ | ✗ |
| Manage account settings | ✓ | ✓ | ✗ | ✗ | ✗ |
| Manage Private Locations | ✓ | ✓ | ✗ | ✗ | ✗ |
| Manage private locations | ✓ | ✓ | ✗ | ✗ | ✗ |
| Create service API keys | ✓ | ✓ | ✗ | ✗ | ✗ |
| Transfer ownership | ✓ | ✗ | ✗ | ✗ | ✗ |

Expand Down
14 changes: 7 additions & 7 deletions ai/ai-assistant.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ description: 'Plan monitoring and create checks and monitors with the Checkly AI
canonical: 'https://www.checklyhq.com/docs/ai/ai-assistant/'
---

The AI Assistant helps you turn a monitoring goal into a plan and create the checks you approve. It can create Browser, Multistep, and API Checks, as well as uptime and Heartbeat Monitors. It does not create Playwright Check Suites.
The AI Assistant helps you turn a monitoring goal into a plan and create the checks you approve. It can create Browser, Multistep, and API checks, as well as uptime and Heartbeat monitors. It does not create Playwright Check Suites.

Every check it creates includes an intent: the goal and required outcomes the check should prove. For Browser and Multistep Checks created in Checkly, [automatic repair](../resolve/automatic-check-repair) can use that intent when repairing the check's script.
Every check it creates includes an intent: the goal and required outcomes the check should prove. For Browser and Multistep checks created in Checkly, [automatic repair](../resolve/automatic-check-repair) can use that intent when repairing the check's script.

<Accordion title="Prerequisites">

Expand All @@ -21,15 +21,15 @@ Every check it creates includes an intent: the goal and required outcomes the ch

1. Open **AI Assistant** in the Checkly app and select **New**.
2. Describe the site, app, or API you want to monitor. Include the starting point, the journey, and the observable outcome that should pass.
3. Review the proposed monitoring plan and linked Test Session results. Ask the assistant to adjust the flow, assertions, frequency, locations, or alerting before you approve it.
3. Review the proposed monitoring plan and linked test session results. Ask the assistant to adjust the flow, assertions, frequency, locations, or alerting before you approve it.
4. Select the checks you want and choose **Create checks**.
5. Open each new check, run it, and review its behavior and settings. For Browser and Multistep Checks, also review the **Check intent** section in the check settings.
5. Open each new check, run it, and review its behavior and settings. For Browser and Multistep checks, also review the **Check intent** section in the check settings.

While preparing your plan, the Assistant tests Browser, Multistep, and API Checks in recorded Test Sessions. URL and Heartbeat Monitors are outside this testing step.
While preparing your plan, the Assistant tests Browser, Multistep, and API checks in recorded test sessions. URL and Heartbeat monitors are outside this testing step.

For a browser journey, ask for a Browser Check. For an API endpoint, ask for an API Check; for several related requests, ask for a Multistep Check. Use a URL Monitor for site availability or a Heartbeat Monitor for a scheduled job. If a journey has important negative cases or guardrails, describe them in your request and confirm they appear in the generated intent.
For a browser journey, ask for a Browser check. For an API endpoint, ask for an API check; for several related requests, ask for a Multistep check. Use a URL monitor for site availability or a Heartbeat monitor for a scheduled job. If a journey has important negative cases or guardrails, describe them in your request and confirm they appear in the generated intent.

The AI Assistant does not change a check's automatic repair setting when it creates the check. A Browser or Multistep Check inherits the account default until you [set automatic repair for that check](../resolve/automatic-check-repair#enable-automatic-repair). Review its intent and choose **On** if you want to enable repair explicitly.
The AI Assistant does not change a check's automatic repair setting when it creates the check. A Browser or Multistep check inherits the account default until you [set automatic repair for that check](../resolve/automatic-check-repair#enable-automatic-repair). Review its intent and choose **On** if you want to enable repair explicitly.

## Checks that need project files

Expand Down
2 changes: 1 addition & 1 deletion ai/mcp-server.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ https://api.checklyhq.com/mcp
Use it when your agent needs live Checkly account context, check status, check results, test sessions, root cause analyses,
result assets, status pages, incidents, account environment variables, or when it needs to trigger existing checks.

You can create and update standalone Browser and Multistep Checks through MCP using inline scripts. Use [Checkly Skills](/ai/skills) and the [Checkly CLI](/cli/overview) when your agent needs to work with local project files, bundle code, or deploy a project. The MCP server runs remotely and cannot access your local filesystem.
You can create and update standalone Browser and Multistep checks through MCP using inline scripts. Use [Checkly Skills](/ai/skills) and the [Checkly CLI](/cli/overview) when your agent needs to work with local project files, bundle code, or deploy a project. The MCP server runs remotely and cannot access your local filesystem.

<Note>
OAuth is the recommended way to connect. The OAuth flow only supports Checkly-approved clients listed in setup. User and service API keys are available for clients that can send custom headers when OAuth is unavailable or a workflow needs a stable service identity.
Expand Down
2 changes: 1 addition & 1 deletion ai/mcp-server/tools.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ The check write tools manage checks from a JSON configuration, without a local p

A typical create flow:

1. Call `get-check-type-schema` with the `checkType` to learn the `check` payload. Every check type takes different configuration, for example `request` for API checks and uptime monitors, `script` for browser checks, and `heartbeat` for heartbeat monitors.
1. Call `get-check-type-schema` with the `checkType` to learn the `check` payload. Every check type takes different configuration, for example `request` for API checks and uptime monitors, `script` for Browser checks, and `heartbeat` for Heartbeat monitors.
2. Optionally call `list-alert-channels` to pick specific alert channels, and `list-check-groups` to find a `groupId`.
3. Call `create-check` with `checkType` and the `check` payload. By default the new check is subscribed to all of the account's alert channels. Set `autoAssignAlerts` to `false` or pass `check.alertChannelSubscriptions` to change this.

Expand Down
2 changes: 1 addition & 1 deletion ai/mcp-server/troubleshooting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ Views do not refresh automatically. Use **Refresh** to request current data. If

### The MCP server cannot access or deploy my local project

You can create and update standalone Browser and Multistep Checks through MCP using inline scripts. The MCP server runs remotely and cannot access your local project files, bundle code, or deploy a project.
You can create and update standalone Browser and Multistep checks through MCP using inline scripts. The MCP server runs remotely and cannot access your local project files, bundle code, or deploy a project.

For local project authoring, use the [Checkly CLI](/cli/overview) in your project. To let your AI agent do this, install [Checkly Skills](/ai/skills).

Expand Down
2 changes: 1 addition & 1 deletion ai/rocky-ai.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Use the [AI Assistant](./ai-assistant) to plan monitoring and create checks and

### Automatic Check Repair

Set an intent and enable [automatic repair](../resolve/automatic-check-repair) for a Browser or Multistep Check.
Set an intent and enable [automatic repair](../resolve/automatic-check-repair) for a Browser or Multistep check.

### Root Cause and User Impact Analysis

Expand Down
4 changes: 2 additions & 2 deletions ai/skills.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ Using Checkly, you can now control your monitoring setup with AI agents without
**Example prompts:**

- "Create a URL monitor for api.example.com that checks every 5 minutes"
- "Set up a browser check that logs into my app and verifies the dashboard loads"
- "Set up a Browser check that logs into my app and verifies the dashboard loads"
- "Add a Slack alert channel for my production check group"

**CLI usage:**
Expand Down Expand Up @@ -106,7 +106,7 @@ Using Checkly, you can now control your monitoring setup with AI agents without
**Example prompts:**

- "Show me which checks are currently failing"
- "Investigate why the login browser check started failing yesterday"
- "Investigate why the login Browser check started failing yesterday"
- "Trigger an on-demand run of my API health check"

**CLI usage:**
Expand Down
2 changes: 1 addition & 1 deletion api-reference/heartbeats/create-a-heartbeat-check.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
openapi: post /v1/checks/heartbeat
title: Create a heartbeat monitor
title: Create a Heartbeat monitor
canonical: 'https://www.checklyhq.com/docs/api-reference/heartbeats/create-a-heartbeat-check/'
---
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
openapi: get /v1/checks/heartbeats/{checkId}/events
title: List all events for a heartbeat monitor
title: List all events for a Heartbeat monitor
canonical: 'https://www.checklyhq.com/docs/api-reference/heartbeats/get-a-list-of-events-for-a-heartbeat/'
---
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
openapi: get /v1/checks/heartbeats/{checkId}/events/{id}
title: List a specific event for a heartbeat monitor
title: List a specific event for a Heartbeat monitor
canonical: 'https://www.checklyhq.com/docs/api-reference/heartbeats/get-a-specific-heartbeat-event/'
---
2 changes: 1 addition & 1 deletion api-reference/heartbeats/get-heartbeat-availability.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
openapi: get /v1/checks/heartbeats/{checkId}/availability
title: Get heartbeat monitor availability
title: Get Heartbeat monitor availability
canonical: 'https://www.checklyhq.com/docs/api-reference/heartbeats/get-heartbeat-availability/'
---
2 changes: 1 addition & 1 deletion api-reference/heartbeats/update-a-heartbeat-check.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
openapi: put /v1/checks/heartbeat/{id}
title: Update a heartbeat monitor
title: Update a Heartbeat monitor
canonical: 'https://www.checklyhq.com/docs/api-reference/heartbeats/update-a-heartbeat-check/'
---
2 changes: 1 addition & 1 deletion api-reference/monitors/update-an-icmp-monitor.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
openapi: put /v1/checks/icmp/{id}
title: Update an ICMP Monitor
title: Update an ICMP monitor
canonical: 'https://www.checklyhq.com/docs/api-reference/monitors/update-an-icmp-monitor/'
---
2 changes: 1 addition & 1 deletion api-reference/usage/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Summary returns `totals.creditsUsed`, `breakdown`, and `coverage`. Each series r

Zero credits means calculated zero consumption. Null credits means the API cannot calculate the charge, for example because of uncovered dates or unavailable or incompatible pricing. A rule absent from an otherwise configured term contributes zero credits while retaining measured quantities.

Pricing quantities depend on the rule. API and browser checks use runs, Multistep checks use requests, and Playwright suites use metered 30-second intervals. V2 also prices recorded trace conditions, uptime, AI invocations, status pages, SMS, and phone alerts. Included allowances and conditional rates can change billable quantities and prices.
Pricing quantities depend on the rule. API and Browser checks use runs, Multistep checks use requests, and Playwright suites use metered 30-second intervals. V2 also prices recorded trace conditions, uptime, AI invocations, status pages, SMS, and phone alerts. Included allowances and conditional rates can change billable quantities and prices.

`include=runs` adds physical check-run counts: `totalRuns`, `finalRuns`, `retryRuns`, `cancelledRuns`, `degradedRuns`, `failedRuns`, `errorRuns`, `abortedRuns`, and `overMaxResponseTimeRuns`. Outcome flags can overlap. These counts are independent of billed quantities.

Expand Down
Loading
Loading