API Reference

The Captureze API allows you to manage schedules, trigger screenshots, and access your data programmatically.

Note: API access is available on Starter and Pro plans.

Authentication

All API requests require authentication using an API key. You can create API keys in Settings → API Keys.

Using Your API Key

Include your API key in the X-API-Key header: 

curl -X GET https://captureze.com/api/schedules \
  -H "X-API-Key: your_api_key_here"

Endpoints

Base URL

https://captureze.com/api

Schedules

GET /schedules

List all schedules for your account.

GET /schedules/:id

Get a specific schedule by ID.

POST /schedules

Create a new schedule.

Request body 
{
  "url": "https://example.com",
  "name": "Example Monitor",
  "interval": "1h",
  "viewport": "desktop",
  "fullPage": true,
  "diffEnabled": true,
  "diffThreshold": 1
}
PUT /schedules/:id

Update an existing schedule.

DELETE /schedules/:id

Delete a schedule and all its screenshots.

POST /schedules/:id/screenshot

Trigger an immediate screenshot for a schedule.

Screenshots

GET /schedules/:id/screenshots

List all screenshots for a schedule.

GET /screenshots/:id

Get a specific screenshot by ID.

Response Format

All responses are in JSON format. Successful responses include the requested data: 

{
  "schedules": [
    {
      "id": "uuid",
      "name": "Example Monitor",
      "url": "https://example.com",
      "interval": "1h",
      "status": "active",
      "lastScreenshot": "2025-01-15T10:30:00Z"
    }
  ]
}

Error Handling

Errors return appropriate HTTP status codes with an error message: 

{
  "error": "Schedule not found"
}

Common Status Codes

  • 200 - Success
  • 201 - Created
  • 400 - Bad request (invalid parameters)
  • 401 - Unauthorized (invalid or missing API key)
  • 404 - Not found
  • 429 - Rate limited
  • 500 - Server error

Rate Limits

API requests are rate limited based on your plan:

  • Starter - 100 requests per minute
  • Pro - 500 requests per minute

Interactive API Docs

Explore the full API with our interactive documentation at /api/docs.