QUANTIZE API Endpoint

Version 2.197 (Release Notes ↗)

Description

QUANTIZE API: Analyzes colors within a reference image for developers and creators. Analyzes the colors within a reference image.

HTTP Methods

GET, POST

HTTP Parameters

Required

Fields Type Description
img URL Input image URL. For direct uploads, submit a multipart/form-data POST request.
nc Integer Number of colors (1-256 range).
cs Integer Color space (1-22 range).
td Integer Tree depth (1-255 range).
key String Your PixLab API Key ↗. Alternatively, embed your key in the WWW-Authenticate: header.

Optional

Fields Type Description
blob Boolean Returns image binary data when true (default: JSON response with output URL).
dither Boolean Enable dithering.

POST Request Body

Use when submitting POST requests instead of GET:

Allowed Content-Types:

multipart/form-data
application/json

Use multipart/form-data for direct image uploads (check the REST API code samples or The PixLab Github Repository↗ for implementation). For JSON, the image must be pre-uploaded. Call store to upload images before invoking this endpoint.

HTTP Response

The endpoint returns application/json if the optional blob parameter is not set.

This API endpoint returns a JSON Object after each call only if the optional blob parameter is not set. Otherwise, the image binary contents are returned instead. The following are the JSON fields returned in the response body:

Fields Type Description
status Integer Status code 200 indicates success, any other code indicates failure.
link URL Link to the image output which is usually stored on the pixlab.xyz storage server unless you set your own S3 keys (refer to your dashboard ↗ on how to do that).
id String Unique image ID.
error String Error message if status != 200.

Code Samples

# Refer to the PixLab Github Repository at: https://github.com/symisc/pixlab for the full list of production ready code samples...
← Return to API Endpoint Listing