The Pixel House

Getting Started

Get your first screenshot in under 60 seconds.

1. Create an account

Sign up at thepixelhouse.co.uk/register. The free tier includes 5,000 screenshots per month, 3 projects, and 1 monitor schedule. No credit card required.

2. Create an API key

Go to Settings and create an API key. Copy the key — it will only be shown once.

3. Capture a screenshot

Use cURL, the TypeScript SDK, or any HTTP client:

curl -X POST https://api.thepixelhouse.co.uk/v1/screenshots \
  -H "Authorization: Bearer ph_live_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com",
    "viewport": "desktop",
    "projectId": "prj_your_project_id"
  }'

4. Create a baseline

Promote your screenshot to a baseline. Future screenshots will be compared against it.

curl -X POST https://api.thepixelhouse.co.uk/v1/baselines \
  -H "Authorization: Bearer ph_live_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "screenshotId": "ss_from_step_3",
    "projectId": "prj_your_project_id",
    "url": "https://example.com",
    "viewport": "desktop"
  }'

5. Run a visual regression test

Capture a new screenshot and compare it against the baseline in a single call:

curl -X POST https://api.thepixelhouse.co.uk/v1/tests/run \
  -H "Authorization: Bearer ph_live_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com",
    "baselineId": "bl_from_step_4",
    "viewport": "desktop",
    "threshold": 1.0
  }'

The response includes a pass/fail status, diff percentage, and a URL to the diff overlay image.

Next steps