POST color

is_accessible

1 credit

Check if two colors pass WCAG AA and AAA contrast requirements

Endpoint

POST /api/v1/tools/color/is_accessible

Body Parameters

color_a string required

color_b string required

Example

input Request

{
    "color_a": "#000000",
    "color_b": "#ffffff"
}

output Response

{
    "ratio": 21,
    "aa_large": true,
    "aa_normal": true,
    "aaa_large": true,
    "aaa_normal": true
}

Response Format

HTTP/1.1 200 OK SUCCESS

{
  "success": true,
  "data": {
    "ratio": 21,
    "aa_large": true,
    "aa_normal": true,
    "aaa_large": true,
    "aaa_normal": true
},
  "meta": {
    "tool": "is_accessible",
    "credits_consumed": 1
  }
}

HTTP/1.1 422 Unprocessable Entity ERROR

{
  "success": false,
  "data": null,
  "error": {
    "code": "validation_error",
    "message": "The given data was invalid."
  }
}

Code Examples

Request Example

lightbulb Developer Tip

Credits are deducted before execution. If the upstream tool fails, credits are automatically refunded to your account.