Quickstart

Step 1: authenticate

Send your API key in the X-Access-Key header.

X-Access-Key: your-key

Step 2: capture a URL

curl -X POST https://api.ssapi.com/v1/capture \
  -H "Content-Type: application/json" \
  -H "X-Access-Key: your-key" \
  -d '{"url":"https://example.com","format":"png","full_page":true}'

Step 3: read the response

{
  "request_id": "...",
  "result": {
    "format": "png",
    "meta": { "width": 1440, "height": 3200 },
    "storage": { "stored": true, "url": "https://..." },
    "cache": { "hit": false }
  }
}

Step 4: store the asset

{
  "url": "https://example.com",
  "storage": {
    "store": true,
    "path": "captures/homepage"
  }
}

Step 5: choose a response type

• json: metadata + storage URL
• binary: raw bytes
• empty: no body (useful when storing)

Step 6: check usage

curl https://api.ssapi.com/v1/usage \
  -H "X-Access-Key: your-key"