BLACKTHRESHOLD API Endpoint

Version 2.197 (Release Notes ↗)

Description

API endpoint BLACKTHRESHOLD forces all pixels below the threshold color to black, ideal for image processing and manipulation tasks. Forces all pixels below the threshold color into black.

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.
color String Color threshold. A string representing the color for example: red, blue, yellow, etc or a color code like #fffeec, #e45cff, etc. This the threshold below which everything turns black.
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 return a JSON Object holding the link to the image output. But, if this parameter is set to true then the image binary contents is returned instead.

POST Request Body

This section details the requirements for using a POST request instead of a simple GET request.

Allowed Content-Types:

multipart/form-data
application/json

Use multipart/form-data if you want to upload your image directly. If you are using JSON, then your image must be already uploaded somewhere. Call store if you want to upload an image for example before invoking this endpoint.

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.
application/json if the optional blob parameter is not set.

This endpoint returns a JSON response unless the blob parameter is specified, in which case raw image binary is returned. The JSON response contains these fields:

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