ColrSkeww

API Documentation

ColrSkeww provides a simple HTTP API for programmatic color blindness simulation.

Endpoint

Request Format

Send a multipart/form-data request with the following fields:

• upload (required): Image file (PNG, JPEG, BMP, GIF, WebP)
• deficiency (optional): Simulation type, defaults to "deutan"

Supported Deficiency Types

• deutan or deuteranopia - Green color blindness (most common)
• protan or protanopia - Red color blindness
• tritan or tritanopia - Blue color blindness (rare)

Response

Returns a PNG image showing how the uploaded image would appear to someone with the specified color vision deficiency.

Example Usage

curl -X POST \
  -F "upload=@image.jpg" \
  -F "deficiency=deutan" \
  http://localhost:3000/upload \
  --output simulated.png

const formData = new FormData();
formData.append('upload', fileInput.files[0]);
formData.append('deficiency', 'protan');

fetch('/upload', {
  method: 'POST',
  body: formData
})
.then(response => response.blob())
.then(blob => {
  const url = URL.createObjectURL(blob);
  document.getElementById('result').src = url;
});

Error Responses

• 400 Bad Request: Invalid image format or missing upload field
• 400 Bad Request: Invalid deficiency type
• 500 Internal Server Error: Image processing error