DESPECKLE API Endpoint

Version 2.197 (Release Notes ↗)

Description

Optimize images by reducing speckle noise while preserving edges with the DESPECKLE API. Perfect for developers and creators looking to enhance image quality.

Reduces the speckle noise in a given image while preserving the edges of the original 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.
key String Your PixLab API Key ↗. Your free trial is available on your dashboard ↗. Alternatively, embed your key in the WWW-Authenticate: HTTP header to omit this parameter.

Optional

Fields Type Description
blob Boolean By default, returns a JSON Object with the output image link. Set to true to receive the image binary data directly.

POST Request Body

Use this if 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, ensure the image is already hosted elsewhere. Upload images first via the store endpoint if needed.

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 endpoint 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 not set. Otherwise, the image binary contents are returned directly.

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