Skip to content

Repository files navigation

Visualping API

Documentation for API plus a skill that lets you interact with the Visualping API directly from LLMs — create monitors, list jobs, check change history, and more.

What the skill does

  • Generate code snippets (curl, Python, JavaScript) for any Visualping API call
  • Execute API calls directly when running in an environment with terminal access
  • Automatically resolves your workspace ID
  • Uses sensible defaults so you can create monitors with minimal configuration

Installation

Option 1: Download the .skill file

  1. Download visualping-api.skill from the Releases page
  2. In Claude, go to Settings → Skills (similar process should be available for other desktop LLM apps)
  3. Upload the .skill file

Option 2: Clone this repo

  1. Clone the repository:
    git clone https://github.com/webmonitoring/visualping-api-skill.git
  2. Point LLM at the skill folder in your project settings

Prerequisites

You'll need a Visualping API key. Get one from your Developer settings (up to 5 active keys).

Usage examples

Once installed, just talk to LLMs naturally:

  • "Monitor https://example.com for changes"
  • "List all my active monitors"
  • "Show me the change history for job 12345"
  • "Pause my monitor on google.com"
  • "Set up a Slack notification for my monitor"
  • "Create a monitor that checks every hour"
  • "Create a monitor with my saved settings"
  • "Bulk import these 50 URLs"
  • "Run my monitor right now"
  • "Show me recent activity across all my monitors"
  • "Create a label called 'Competitors' and tag these jobs"

LLM will ask for your API key if you haven't provided one, then either generate a code snippet or execute the call directly — your choice.

API coverage

ActionEndpoint
AuthenticatePOST /v2/token
Get account infoGET /describe-user
List jobsGET /v2/jobs
Create jobPOST /v2/jobs
Create job from saved settingsPOST /v2/jobs/from-saved-settings
Bulk create jobsPUT /v2/jobs/bulk
Get job details & historyGET /v2/jobs/{jobId}
Update jobPUT /v2/jobs/{jobId}
Delete jobDELETE /v2/jobs/{jobId}
Activity feed (all jobs)POST /v2/jobs/report-page
Run job immediatelyPOST /v2/jobs/launch
List labelsGET /v2/jobs/labels
Create labelsPOST /v2/jobs/labels
Update labelsPUT /v2/jobs/labels
Delete labelDELETE /v2/jobs/labels
Assign/unassign labels on jobsPUT /v2/jobs/joblabels

Direct execution

The skill can execute API calls directly (instead of just generating snippets) when Claude has terminal access. This works out of the box in Claude Code and Cowork.

In Claude.ai with an organization account, your org owner needs to add these domains to the network allowlist:

  • account.api.visualping.io
  • job.api.visualping.io
  • api.visualping.io

Without these domains, the skill still works — it generates ready-to-run code snippets you can copy and execute in your own environment.

Defaults

When creating a monitor, the skill uses these defaults unless you specify otherwise:

SettingDefaultNotes
Check frequencyDaily (1440 min)Common: 5m, 15m, 30m, 1h, 6h, 12h, 1d, 1w
ActivetrueStarts monitoring immediately

For preset-based creation (POST /v2/jobs/from-saved-settings), the saved settings determine defaults (including frequency) unless you explicitly override them.

Support

About

No description, website, or topics provided.

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors