Documentation
UWS Error Code API Manual
Learn how to integrate UWS Error Code API into your applications. Fast, affordable, and AI-friendly Web Debugging API.
API
MCP
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
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) |
proxy | Boolean | No | Set to true to route the request through a residential proxy IP. If residential proxy is disabled in system settings, the request automatically proceeds using a standard IP. (Default: false) |
captcha | Boolean | No | Set to true to enable automatic CAPTCHA solving (reCAPTCHA, Turnstile, etc.). If CAPTCHA solving is disabled in system settings, the request automatically proceeds without it. (Default: false) |
device | String | No | Specify the device viewport and User-Agent. Valid values: desktop, mobile, tablet. (Default: desktop) |
delay | Integer | No | Wait time in milliseconds before capturing the screenshot (Max: 15000). (Default: 0) |
fullPage | Boolean | No | Capture a full-page screenshot of the entire scrollable area. (Default: false) |
returnHtml | Boolean | No | Return the fully rendered HTML source code of the page. (Default: false) |
htmlLimit | Integer | No | Truncate the returned HTML to this maximum length. Highly recommended when integrating with LLMs to prevent context window overflow. Cannot exceed the system global limit. (Default: 0 / No limit) |
headers | Object | No | Inject custom HTTP headers (e.g., {"Authorization": "Bearer ...", "Cookie": "session=..."}) useful for testing authenticated pages. |
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, "proxy": true, "captcha": true, "fullPage": true, "headers": {"Cookie": "session_id=12345"}}'
Python Example (Requests)
import requests
import json
url = "https://uwserrorcode.com/api/analyze"
payload = json.dumps({
"url": "https://example.com",
"ai": True,
"proxy": True,
"captcha": True,
"fullPage": True,
"headers": { "Authorization": "Bearer YOUR_TOKEN" }
})
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, proxy: true, captcha: true, fullPage: true, headers: { "Authorization": "Bearer YOUR_TOKEN" } })
};
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. |
html | String (Nullable) | The fully rendered HTML source code of the page. |
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...