COLORSPACE_GRAY API Endpoint

Version 2.197 (Release Notes ↗)

Description

Change the colorspace of a given image to the gray color model using the COLORSPACE_GRAY API endpoint. Ideal for developers and creators looking to modify image colors efficiently.

HTTP Methods

GET, POST

HTTP Parameters

Required

Fields Type Description
img URL Input image URL. For direct uploads, submit a multipart/form-data POST request.
key String Your PixLab API Key ↗. Alternatively, embed it in the WWW-Authenticate: header.

Optional

Fields Type Description
blob Boolean Returns image binary data when true. Default: JSON response with output URL.

POST Request Body

For POST requests instead of GET:

Allowed Content-Types:

  • multipart/form-data (direct upload)
  • application/json (pre-uploaded images)

Use store to upload images before invoking this endpoint with JSON.

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 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 omitted. Otherwise, the raw image binary is returned. The JSON response contains the following fields:

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