EQUALIZE API Endpoint

Version 2.197 (Release Notes ↗)

Description

Equalize API endpoint adjusts image histogram for optimal visual quality, enhancing contrast and detail in your projects. Equalizes the image histogram.

HTTP Methods

GET, POST

HTTP Parameters

Required

Fields Type Description
img URL Input image URL. If you want to upload your image directly from your app, then submit a multipart/form-data POST request.
key String Your PixLab API Key ↗. You can also embed your key in the WWW-Authenticate: HTTP header and omit this parameter if you want to.

Optional

Fields Type Description
blob Boolean By default, this API endpoint returns a JSON Object holding the link to the image output. Set to true to return the raw image binary instead.

POST Request Body

Use when submitting POST requests instead of GET:

Allowed Content-Types:

  • multipart/form-data
  • application/json

To facilitate direct image uploads, utilize multipart/form-data. Please consult the REST API code samples for a functional implementation. For JSON requests, the image must be pre-uploaded. Call store first if you need to upload an image before processing.

HTTP Response

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.

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

This endpoint returns a JSON Object after each call only if the optional blob parameter is not set. Otherwise the image binary contents is returned instead.

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