API Documentation

Screenshot capture, PDF generation, and AI design critique via REST API.

Authentication

For web app usage, authentication is handled via session cookies automatically. For API access, subscribe to Pro or Unlimited plan.

Screenshot Endpoint

GET /api/screenshot?url=https://example.com&width=1280&height=720

Parameter	Required	Description
url	Yes	URL to screenshot
width	No	Viewport width (default: 1280)
height	No	Viewport height (default: 720)
full_page	No	Capture full page (default: false)
format	No	png or jpeg (default: png)

PDF Endpoint

GET /api/pdf?url=https://example.com&format=A4

Parameter	Required	Description
url	Yes	URL to convert
format	No	A4, Letter, Legal (default: A4)
landscape	No	Landscape orientation (default: false)

Critique Endpoint

POST /api/critique
Content-Type: application/json

{
  "website_url": "https://example.com",
  "design_type": "landing_page",
  "focus_areas": ["visual_hierarchy", "typography", "color_scheme"]
}

You can provide website_url, image_url, or image_base64 (exactly one).

Combined Analyze Endpoint

POST /api/analyze
Content-Type: application/json

{
  "url": "https://example.com",
  "design_type": "landing_page"
}

Captures screenshot and runs AI critique in a single call.

Response Format

{
  "overall_score": 7,
  "summary": "Clean design with good hierarchy...",
  "scores": [
    {
      "category": "typography",
      "score": 8,
      "feedback": "Good font choices",
      "action": "Increase heading contrast"
    }
  ],
  "top_priorities": ["Improve CTA visibility", "Add more whitespace"]
}