LINEARSTRETCH API Endpoint

Version 2.197 (Release Notes ↗)

Description

Stretch image intensity with saturation using the LINEARSTRETCH API endpoint. Optimize visual clarity and enhance image quality for developers and creators. Stretches with saturation the image intensity.

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.
blackpoint Float The image black point.
whitepoint Float The image white point.
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 returns a JSON Object holding the link to the image output. Set to true to receive the raw image binary data 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 for direct image uploads (see REST API code samples). For JSON, the image must be hosted externally. Upload images first via the store endpoint if needed.

HTTP Response

Required

Fields Type Description
img String URL or base64 encoded input image.

Optional

Fields Type Description
blob Boolean Return the image binary contents instead of JSON response.

This endpoint returns a JSON response with content type application/json if the optional blob parameter is not set.

The response is a JSON Object unless the blob parameter is specified, in which case the raw image binary is returned. The JSON response 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 console.pixlab.io 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