RAISE API Endpoint

Version 2.197 (Release Notes ↗)

Description

Creates a 3D button effect by lightening and darkening image edges, with adjustable width and height for the vertical and horizontal edges.

Creates a simulated three-dimensional button-like effect by lightening and darkening the edges of the image. Members width and height define the width of the vertical and horizontal edge of the effect.

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.
width Integer Simulated 3d button width.
height Integer Simulated 3d button height.
raise Boolean Control edge effect.
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 return a JSON Object holding the link to the image output. But, if this parameter is set to true then the image binary contents is returned instead.
x Integer X coordinate.
y Integer Y coordinate.

POST Request Body

If you plan to use POST instead of a simple GET request:

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. If you are using JSON, then your image must be already uploaded somewhere. Call store if you want to upload an image 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 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 not set. Otherwise, the image binary contents are returned directly.

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