NEGATE API Endpoint

Version 2.197 (Release Notes ↗)

Description

Negate API endpoint inverts colors in images, ideal for developers and creators seeking advanced image manipulation. Negates the colors in a given image.

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, submit a multipart/form-data POST request.
gray Boolean Whether to only negate grayscale pixels within the image.
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 By default, returns a JSON Object with the output image link. Set to true to return the image binary contents directly.
channel Integer Color channel constant. If omitted (recommended), all image channels will be affected (see channel constants below).

POST Request Body

Use when submitting a POST request instead of GET.

Allowed Content-Types:

multipart/form-data
application/json

Use multipart/form-data for direct image uploads. For JSON, the image must be pre-uploaded (use the store endpoint if needed).

Channels Constant

Recommended to omit this parameter and let PixLab process all channels.

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 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 omitted. Otherwise, the raw image binary is returned. The JSON response structure is documented above.

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