HALDCLUT API Endpoint

Version 2.197 (Release Notes ↗)

Description

Replaces image colors using the built-in Hald lookup table. Ideal for developers and creators seeking advanced color manipulation. Replaces colors in the image using the built-in Hald lookup table.

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.

Optional

Fields Type Description
blob Boolean Returns image binary contents when true. Default behavior returns JSON with output image URL.
channel Integer Color channel constant. Omit to affect all channels (See channel constants below).

POST Request Body

Allowed Content-Types:

multipart/form-data
application/json

Use multipart/form-data for direct image uploads (see REST API code samples). For JSON, ensure your image is pre-uploaded. Call store to upload images before invoking this endpoint.

Channels Constant

Recommended to omit this parameter for full channel processing.

Fields Value
CHANNEL_RED 1
CHANNEL_GRAY 1
CHANNEL_CYAN 1
CHANNEL_GREEN 2
CHANNEL_MAGENTA 2
CHANNEL_BLUE 4
CHANNEL_YELLOW 4
CHANNEL_ALPHA 8
CHANNEL_OPACITY 8
CHANNEL_MATTE 8
CHANNEL_BLACK 32
CHANNEL_INDEX 32
CHANNEL_ALL 134217727

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 HALDCLUT 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.

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