Version 1.9.72 (Release Notes)


blurhttps://api.pixlab.io/blur

Description

Adds blur filter to image. This command is useful if mixed with some media analysis endpoints such as nsfw to censure (i.e. filter) offensive contents.

HTTP Methods

GET, POST

Request Parameters

Required

FieldsTypeDescription
imgURLInput image URL. If you want to upload your image directly from your app, then submit a multipart/form-data POST request.
radiusFloatBlur radius (Max value is set to 100.00).
sigmaFloatStandard deviation (Max value is set to 200.00).
keyStringYour PixLab API Key. You can also embed your key in the WWW-Authenticate: HTTP header and omit this parameter if you want to.


Optional
FieldsTypeDescription
blobBooleanBy 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.
channelIntegerColor 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 (refer to the sample set for a working example). 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.

Channels Constant
We recommend that you always omit this parameter and let PixLab affect all image channels.
FieldsValue
CHANNEL_RED1
CHANNEL_GRAY1
CHANNEL_CYAN1
CHANNEL_GREEN2
CHANNEL_MAGENTA2
CHANNEL_BLUE4
CHANNEL_YELLOW4
CHANNEL_ALPHA8
CHANNEL_OPACITY8
CHANNEL_MATTE8
CHANNEL_BLACK32
CHANNEL_INDEX32
CHANNEL_ALL134217727

Response

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

This command return a JSON object after each call only if the optional blob parameter is not set. Otherwise the image binary contents is returned instead. The following are the JSON fields returned in response body:

FieldsTypeDescription
statusIntegerStatus code 200 indicates success, any other code indicates failure.
linkURLLink 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).
idStringUnique image ID.
errorStringError message if status != 200.

Python Example

import requests
import json
# Censure the bird picture
req = requests.get('https://api.pixlab.io/blur',params={'img':'https://www.allaboutbirds.org/guide/PHOTO/LARGE/blue_jay_8.jpg','radius':50,'sigma':30,'key':'My_PixLab_Key'})
reply = req.json()
if reply['status'] != 200:
    print (reply['error'])
else:
    print ("Link to the Blurred picture: "+ reply['link'])

See Also