Version 1.9.72 (Release Notes)


sketchhttps://api.pixlab.io/sketch

Description

Simulates a pencil sketch. The image is convolved with a Gaussian operator of the given radius and standard deviation sigma. For reasonable results, radius should be larger than sigma. Ignore the radius parameter and this command will select a suitable radius for you. Angle gives the angle of the blurring motion.

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.
radiusFloatThe radius of the Gaussian, in pixels, not counting the center pixel (Max value is set to 30.00).
sigmaFloatThe standard deviation of the Gaussian, in pixels. (Max value is set to 100.00).
angleFloatApply the effect along this angle. (Max value is set to 360.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.

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.

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

# Refer to https://github.com/symisc/pixlab for the full list of production ready code samples...

See Also