API Reference - FixiWeb.AI

Authentication

API keys — the Agent API

Generate a key from Settings - API Keys. Keys begin with fixiweb_ and are shown once. A key authenticates the Agent API under https://api.fixiweb.ai/api/agent, sent in the X-API-Key header. GET /api/agent/openapi returns that API's machine-readable description (it needs a key too).

X-API-Key: fixiweb_xxxxxxxxxxxxxxxxxxxx

Dashboard endpoints

The endpoints documented below are the ones the FixiWeb dashboard itself calls. They authenticate with a signed-in dashboard session and do not accept an API key.

Base URL

Base URL for all requests:

https://api.fixiweb.ai

Typical flow

1. POST /api/scan
2. Wait for scan completion
3. GET /api/analyses/site/:domain

Start a Scan

Initiates a new scan and returns a scan ID.

POST /api/scan Trigger a new scan

Parameter	Type	Required	Description
url	string	Required	Full URL including protocol (https://example.com)
device	string	Optional	"desktop" or "mobile". Default: "desktop"

{
  "url": "https://example.com",
  "device": "desktop"
}

Response:

{
  "scanId": "scan_01j9x8z3k4m5n6p7q8r",
  "status": "queued",
  "estimatedTime": 30
}

Get Scan Results

Retrieve the latest completed scan results for a domain.

GET /api/analyses/site/:domain Latest scan results

Parameter	Type	Required	Description
domain	string (path)	Required	Domain without protocol (example.com)

GET /api/analyses/site/example.com

Response includes: overall score, issues by category, platform detected, AI fix suggestions, performance metrics, uptime status.

Note: this endpoint returns the latest completed analysis for the domain.

Health Check

GET /api/health Basic service health status

{
  "version": "12.79.0",
  "mongodb": "connected",
  "redis": "connected",
  "services": { "scanner": "ok", "worker": "ok" }
}

GET /api/health/detailed Detailed service diagnostics

Detailed service diagnostics including queue status, memory usage, and error rates.

List Plans

GET /api/billing/plans Available pricing plans

Returns available plans with limits, features, and pricing.

Subscription Info

GET /api/billing/subscription Current subscription details

Returns the authenticated user's current plan, usage, and billing information.

Security Deep Analysis

POST /api/security-analysis/deep/:scanId AI security report

Parameter	Type	Required	Description
scanId	string (path)	Required	Scan ID from a completed scan

Runs deep AI security analysis on a completed scan. Returns comprehensive vulnerability assessment, risk scores, and remediation priorities.

Error Codes

Code	Meaning
400	Bad Request - invalid parameters
401	Unauthorized - missing credentials (API key or dashboard session)
403	Forbidden - feature not available on your plan
404	Not Found - resource does not exist
429	Rate Limited - too many requests
500	Server Error - internal error