Captures

What a capture is

A capture renders one URL from a chosen region and stores the screenshot, HTML, cookies, headers, and network log. Status moves from pending to captured when the render succeeds.

Request fields

curl -sS -X POST "https://api.efflux.io/v3/captures" \
  -H "Authorization: Bearer $EFFLUX_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com",
    "callback": {
      "success": { "url": "https://example.com/hook/$job_id", "method": "POST" }
    }
  }'

The response data includes capture_id, url, status, timestamps, cookie_count, network_log_count, header_count, screenshot_size, and the region you asked for. links points at the screenshot variants, HTML, network logs, and cookies.

Read the artifacts

Poll GET /captures/{capture_id} until the capture has finished, then fetch the artifacts.

The image route accepts variant:

curl -sS -L "https://api.efflux.io/v3/captures/$CAPTURE_ID/image?variant=viewport" \
  -H "Authorization: Bearer $EFFLUX_TOKEN" \
  -o viewport.png

Network logs and cookies default to limit 500 (max 1000). The capture list defaults to 100 (max 1000).