NOISE API Endpoint

Version 2.197 (Release Notes ↗)

Description

Add random noise to images with the NOISE API endpoint, perfect for developers and creators looking to enhance image processing capabilities. Add random noise to 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, then submit a multipart/form-data POST request.
noise Integer Noise type constant. A value between 1..7. (See below for noise constants).
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 command 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.
channel Integer Color channel constant. If this field is missing (Recommended), then all image channels will be affected (See below for the list of channels constant).

POST Request Body (If you plan to use POST instead of a simple GET request)

Allowed Content-Type:

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.

Noise Type Constants
Fields Value
UNIFORM 1
GAUSSIAN 2
MULTIPLICATIVE GAUSSIAN 3
IMPULSE 4
LAPLACIAN 5
POISSON 6
RANDOM 7

Channels Constant
We recommend that you always omit this parameter and let PixLab affect all image 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

Returns application/json if the optional blob parameter is not set.

This endpoint returns a JSON Object after each call unless the blob parameter is specified, in which case the image binary data is returned directly. The response JSON contains the following fields:

Fields Type Description
status Integer Status code 200 indicates success, any other code indicates failure.
link URL Link to the processed image stored on the pixlab.xyz CDN unless custom S3 keys are configured (see your console for configuration).
id String Unique identifier for the processed image.
error String Error description when 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