COLORSPACE_TRANSPARENT API Endpoint

Version 2.197 (Release Notes ↗)

Description

Change the colorspace of a given image to the transparent color model using the COLORSPACE_TRANSPARENT API endpoint. Change the colorspace of a given image to the transparent color model.

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. If set to true, the image binary contents are returned 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, the image must be pre-uploaded. Call store to upload an image before invoking this endpoint.

HTTP Response

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

This endpoint returns a JSON response unless the blob parameter is specified, in which case raw image binary data 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. Custom S3 storage can be configured via console.pixlab.io.
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