EMBOSS API Endpoint

Version 2.197 (Release Notes ↗)

Description

EMBOSS API endpoint creates a grayscale image with a 3D effect by convolving the image with a Gaussian operator. Adjust the radius and sigma for optimal results, or set radius to 0 for automatic selection. Ideal for developers and creators looking to enhance image effects.

Returns a grayscale image with a three-dimensional effect. The image is convolved with a Gaussian operator of the given radius and standard deviation (sigma). For reasonable results, radius should be larger than sigma. Use radius 0 or ignore this parameter and it will be auto chosen for you.

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.
sigma Float The sigma of the effect (Max value: 100.00).
key String Your PixLab API Key ↗. Alternatively, embed your key in the WWW-Authenticate: HTTP header to omit this parameter.

Optional

Fields Type Description
radius Float The operation radius (Max value: 40.00). Set to 0 or omit for auto-selection.
blob Boolean Returns JSON with output image link by default. Set to true for direct binary output.

POST Request Body

Use when submitting a POST request instead of GET.

Allowed Content-Types:

  • multipart/form-data
  • application/json

Use multipart/form-data for direct image uploads (see REST API code samples for examples). For JSON, ensure the image is already hosted—invoke store to upload before calling 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 omitted. Otherwise, the raw image binary is returned directly. The JSON response structure is documented above.

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