Skip to content
Color API

/v1/analyze/batch

POST
/v1/analyze/batch
 
curl --request POST \
  --url https://color.koval.tools/v1/analyze/batch \
  --header 'Content-Type: application/json' \
  --data '{ "pairs": [ { "color": "example", "foreground": "example", "background": "example", "canvas": "example", "compliance_mode": "wcag22", "include": { "wcag": true, "apca": true, "reverse_roles": false, "names": false, "palette": "complementary", "cvd": { "types": [ "protanopia" ] } }, "repair": { "target": "aa-normal-text", "change": "foreground", "max_candidates": 3, "preserve": "hue" } } ], "options": { "fail_fast": false } }'

Request Bodyrequired

Section titled “ Request Bodyrequired ”
Media type application/json
object
pairs
required
Array<object>
>= 1 items <= 50 items
object
color
string
>= 1 characters <= 500 characters
foreground
string
>= 1 characters <= 500 characters
background
string
>= 1 characters <= 500 characters
canvas
string
>= 1 characters <= 500 characters
compliance_mode
string
default: wcag22
Allowed values: wcag22 wcag3
include
object
wcag
boolean
default: true
apca
boolean
default: true
reverse_roles
boolean
names
boolean
palette
string
Allowed values: complementary analogous triadic tetradic monochromatic tints shades tones
cvd
object
types
required
Array<string>
>= 1 items
Allowed values: protanopia deuteranopia tritanopia
repair
object
target
required
string
Allowed values: aa-normal-text aa-large-text aaa-normal-text aaa-large-text non-text-ui apca-normal-text apca-large-text apca-non-text
change
required
string
Allowed values: foreground background either both
max_candidates
integer
default: 3 >= 1 <= 5
preserve
string
Allowed values: hue chroma
options
object
fail_fast
boolean

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Batch analysis result

Media type application/json
object
results
required
Array<object>
object
key
additional properties
nullable
summary
required
object
total
required
number
passed_aa
required
number
failed_aa
required
number
errors
required
number
version
required
string

Example generated

{
  "results": [
    {
      "additionalProperty": "example"
    }
  ],
  "summary": {
    "total": 1,
    "passed_aa": 1,
    "failed_aa": 1,
    "errors": 1
  },
  "version": "example"
}

400

Section titled “ 400 ”

Validation error

Media type application/json
object
error
required
object
code
required
string
message
required
string
details
required
Array<string>

Example generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": [
      "example"
    ]
  }
}