API Documentation

Complete reference for the Conrad AI Compliance API. Monitor WCAG, GDPR, and CCPA compliance programmatically.

Base URL All API requests should be made to: https://ewepip.com/api/conrad/api

Introduction

The Conrad AI API enables automated compliance monitoring for your websites. Scan pages for accessibility issues, privacy compliance, and generate detailed reports.

Quick Start

curl -X POST https://ewepip.com/api/conrad/api/scan \
  -H "X-API-Key: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com"}'

Authentication

All API requests require an API key passed in the X-API-Key header.

Header Value Required
X-API-Key Your API key from subscription Yes
Content-Type application/json For POST requests
Keep your API key secure Never expose your API key in client-side code or public repositories.

Rate Limits

API rate limits depend on your subscription plan:

Plan Requests/Month Burst Limit
Starter 100 10/minute
Business 1,000 60/minute
Enterprise Unlimited 300/minute

Compliance Scan

Scan a URL for compliance issues across WCAG, GDPR, and CCPA standards.

POST /api/scan

Performs a comprehensive compliance scan on the specified URL.

Request Body

Parameter Type Description
url string The URL to scan (required)

Example Request

curl -X POST https://ewepip.com/api/conrad/api/scan \
  -H "X-API-Key: conrad_abc123..." \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com"}'

Example Response

{
  "url": "https://example.com",
  "scannedAt": "2024-12-30T18:30:00.000Z",
  "score": 85,
  "status": "COMPLIANT",
  "summary": {
    "total": 10,
    "passed": 8,
    "failed": 2
  },
  "checks": [
    {
      "name": "Has skip links",
      "status": "PASS",
      "category": "WCAG"
    },
    {
      "name": "Has ARIA landmarks",
      "status": "FAIL",
      "category": "WCAG"
    }
  ]
}

Get Report

Retrieve a detailed compliance report for a domain.

GET /api/report/:domain

Returns a comprehensive compliance report for the specified domain.

Path Parameters

Parameter Description
domain The domain to get report for (e.g., example.com)

Query Parameters

Parameter Type Description
format string Response format: json or pdf

Example Request

curl https://ewepip.com/api/conrad/api/report/example.com \
  -H "X-API-Key: conrad_abc123..."

Example Response

{
  "domain": "example.com",
  "generatedAt": "2024-12-30T18:30:00.000Z",
  "format": "json",
  "compliance": {
    "wcag": { "score": 95, "level": "AA", "status": "COMPLIANT" },
    "gdpr": { "score": 90, "status": "COMPLIANT" },
    "ccpa": { "score": 88, "status": "COMPLIANT" }
  },
  "recommendations": [
    "Add skip links to all pages",
    "Ensure all images have descriptive alt text",
    "Add cookie consent banner"
  ]
}

List Plans

Get available subscription plans (public endpoint, no authentication required).

GET /api/plans

Example Request

curl https://ewepip.com/api/conrad/api/plans

Example Response

{
  "plans": [
    {
      "id": "starter",
      "name": "Starter",
      "price": 49,
      "currency": "USD",
      "interval": "month",
      "features": ["1 domain", "Daily scans", "Email alerts"]
    }
  ]
}

Error Handling

The API returns consistent error responses:

{
  "error": "Error message description",
  "code": "ERROR_CODE"
}

Status Codes

Code Description
200 Success
400 Bad Request - Invalid parameters
401 Unauthorized - Invalid or missing API key
429 Rate Limited - Too many requests
Need help? Contact us at support@ewepip.com or visit our homepage for more information.