API Reference

Integrate Plyxo directly into your CI/CD pipelines or custom dashboards using our REST API.

Authentication

All API requests require a Bearer token. You can generate an API key from your Developer Settings page.

Authorization: Bearer plyxo_live_xxxxxx

Endpoints

1. Trigger a New Scan

Initiates a new AI Vision Scan for a specific project. This is an asynchronous operation. You will receive a scan_id that can be used to poll for the results or you can provide a webhook URL.

Request Body

{
  "page_url": "https://example.com/pricing", // Optional. Defaults to project root.
  "webhook_url": "https://your-server.com/webhooks/plyxo" // Optional.
}

Response (202 Accepted)

{
  "scan_id": "scn_8f72h492",
  "status": "pending",
  "estimated_completion_time_seconds": 45
}

2. Retrieve Scan Results

Fetches the complete results of a scan, including all detected issues, scores, and visual heuristics.

Response (200 OK)

{
  "id": "scn_8f72h492",
  "status": "completed",
  "scores": {
    "seo": 95,
    "performance": 88,
    "ux": 72,
    "trust": 100
  },
  "issues": [
    {
      "category": "ux",
      "priority": "high",
      "title": "Low contrast on primary CTA",
      "description": "The button color (#333) against the background (#111) fails WCAG AA."
    }
  ]
}

Rate Limits

The API is rate limited to 60 requests per minute per IP address. Exceeding this limit will result in a 429 Too Many Requests response.