COLORSPACE_HSL API Endpoint

Version 2.197 (Release Notes ↗)

Description

Change the colorspace of a given image to the HSL color model. Ideal for developers and creators looking to enhance image processing and manipulation capabilities.

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.
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 this parameter to true to receive the raw image binary data instead.

POST Request Body

Use when submitting POST requests instead of GET:

Allowed Content-Types:

  • multipart/form-data
  • application/json

Use multipart/form-data for direct image uploads. For JSON requests, the image must be pre-uploaded. Call store to upload images before invoking this endpoint.

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 API returns JSON (application/json) when the optional blob parameter is omitted. If blob is set, the endpoint returns raw image binary data instead. The JSON response structure is documented above.

Required

No required parameters for this endpoint.

Optional

Parameter Type Description
blob Boolean When true, returns raw image binary instead of JSON response.

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