REMAP API Endpoint

Version 2.197 (Release Notes ↗)

Description

REMAP API endpoint for developers and creators: Remaps image colors efficiently. Remaps image colors.

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.
dither Integer Dither method constant. Must be between 1-3.
key String Your PixLab API Key ↗. You can also embed your key in the WWW-Authenticate: HTTP header and omit this parameter.

Optional

Fields Type Description
blob Boolean Returns image binary contents when true. Default behavior returns JSON with output image URL.

POST Request Body

Use when making POST requests instead of GET

Allowed Content-Types:

  • multipart/form-data
  • application/json

Use multipart/form-data for direct image uploads (check the REST API code samples or The PixLab Github Repository↗ for implementation). For JSON, ensure your image is already hosted. Call store to upload images before invoking this endpoint.

HTTP Response

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

This API endpoint returns a JSON Object after each call only if the optional blob parameter is not set. Otherwise, the image binary contents are returned instead. The following are the JSON fields returned in the response body:

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.

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