REFLECT API Endpoint

Version 2.197 (Release Notes ↗)

Description

Create a reflection or mirror-like effect on the bottom of any given image using the REFLECT API endpoint. Perfect for developers and creators looking to enhance visual content.

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 to true to receive the raw image binary instead.
size Integer Reflection size in pixels. Defaults to 1024 if omitted.

POST Request Body

Use when submitting POST requests instead of GET:

Allowed Content-Types:

multipart/form-data
application/json

To facilitate direct image uploads, utilize multipart/form-data. Please consult the REST API code samples for a functional implementation. For JSON requests, the image must be pre-uploaded. Call store first to upload images before invoking this endpoint.

HTTP Response

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

This endpoint returns a JSON Object after each call 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 pixlab.xyz storage unless custom S3 keys are configured (see console.pixlab.io for configuration).
id String Unique image identifier.
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