UWS Error Code - API Documentation

Authentication

To authenticate your API requests, you must include your API key in the HTTP headers. You can find or generate your API key in the API Keys menu.

Header Name	Description
`X-API-KEY`	Your unique secret API key.

Rate Limits

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

Analyze Endpoint

Perform headless browser analysis. We fully support both standard GET and POST (JSON Body) requests.

GET /api/analyze
POST /api/analyze

Parameters (Query or JSON Body)

Parameter	Type	Required	Description
`url`	String	Yes	The target URL to analyze (e.g., "https://example.com").
`ai`	Boolean	No	Set to `true` to enable UWS AI analysis of the detected errors. (Default: `false`)

cURL Example (POST - JSON Body)

curl -X POST "https://uwserrorcode.com/api/analyze" \
     -H "X-API-KEY: YOUR_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{"url": "https://example.com", "ai": true}'

Python Example (Requests)

import requests
import json

url = "https://uwserrorcode.com/api/analyze"
payload = json.dumps({
  "url": "https://example.com",
  "ai": True
})
headers = {
  "X-API-KEY": "YOUR_API_KEY",
  "Content-Type": "application/json"
}

response = requests.request("POST", url, headers=headers, data=payload)
print(response.json())

Node.js Example (Fetch)

const fetch = require('node-fetch');

const url = 'https://uwserrorcode.com/api/analyze';
const options = {
  method: 'POST',
  headers: {
    'X-API-KEY': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({ url: 'https://example.com', ai: true })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Response Format

Loading response format...

Response Schema

Field	Type	Description
`targetUrl`	String	The exact URL that was analyzed.
`consoleLogs`	Array of Objects	Captured console messages. Contains `type` ("error", "warning") and `text`.
`pageErrors`	Array of Strings	Uncaught exceptions and runtime errors thrown by the page.
`networkFailures`	Array of Objects	Failed network requests. Contains `url` and `errorText` (e.g., "net::ERR_NAME_NOT_RESOLVED").
`screenshotUrl`	String (Nullable)	A public Google Cloud Storage URL of the captured page screenshot.
`aiAnalysis`	String (Nullable)	AI-generated summary and solution for the detected errors (Only included if `ai=true`).
`analyzedAt`	String (ISO Date)	Timestamp of when the analysis was completed.

Example Response

Loading...

UWS Error Code API Manual