Image palette

curl -X POST "$DOATHING_API/v1/imaging/image-palette" \
  -H "x-api-key: $DOATHING_KEY" \
  -H "content-type: application/json" \
  -d '{"file": {"filename": "photo.jpg", "content_type": "image/jpeg", "data_b64": "<base64>"}, "options": {"count": 5}}'

The dominant colours as hex codes with their proportions — a palette you can design against.

Extract a dominant colour palette from an image as hex values with per-colour coverage.

Input

Send a file object with base64 data_b64, its content_type and a filename. Accepted types: image/png, image/jpeg, image/webp, image/gif, image/tiff.

The declared type is not trusted — the bytes are sniffed and a contradiction is rejected rather than corrected.

Response

The result carries your remaining balance alongside it, so you can track spend without a second call.

{
  "palette": [
    {
      "hex": "#C15F3C",
      "rgb": [
        193,
        95,
        60
      ],
      "coverage": 0.41
    }
  ],
  "count": 5,
  "request_id": "37f01edb-0163-42a1-ac51-0acaef979800",
  "credits_remaining": 96
}

Cost

2 credits per call, whether it is run from the site or from the API — the credential differs, the price does not. A new account starts with 20 credits.

A rejected request still costs a credit: the authorizer decrements before the tool validates. A call rejected for a missing or invalid key is free.