API Reference

Authorization: Bearer YOUR_API_KEY

https://api.screenshot.example.com/v1

POST /capture

Captures a screenshot of a specified URL or element.

Request Body

{
  "url": "https://example.com",
  "viewport": {
    "width": 1920,
    "height": 1080
  },
  "fullPage": false,
  "format": "png"
}

Response

{
  "id": "screenshot_123",
  "url": "https://cdn.screenshot.example.com/abc123.png",
  "createdAt": "2026-08-25T12:00:00Z",
  "metadata": {
    "width": 1920,
    "height": 1080,
    "format": "png",
    "size": 245678
  }
}

GET /screenshots/:id

Retrieves a previously captured screenshot by its ID.

Parameters

• id (required) - The screenshot ID

Response

{
  "id": "screenshot_123",
  "url": "https://cdn.screenshot.example.com/abc123.png",
  "createdAt": "2026-08-25T12:00:00Z",
  "metadata": {
    "width": 1920,
    "height": 1080,
    "format": "png",
    "size": 245678
  }
}

GET /screenshots

Lists all screenshots for your account.

Query Parameters

• limit - Number of results (default: 20)
• offset - Pagination offset (default: 0)
• sort - Sort order (createdAt, size)

Response

{
  "data": [
    {
      "id": "screenshot_123",
      "url": "https://cdn.screenshot.example.com/abc123.png",
      "createdAt": "2026-08-25T12:00:00Z"
    }
  ],
  "total": 42,
  "limit": 20,
  "offset": 0
}

DELETE /screenshots/:id

Deletes a screenshot permanently.

Parameters

• id (required) - The screenshot ID

Response

{
  "success": true,
  "message": "Screenshot deleted successfully"
}