EDGE API Endpoint

Version 2.197 (Release Notes ↗)

Description

Enhance image edges with the EDGE API using a customizable convolution filter for developers and creators.

Enhance edges within a given image with a convolution filter of the chosen radius.

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
radius Float The radius of the operation (Max value is set to 10.00). Use radius 0 or ignore this parameter and it will be auto-selected.
blob Boolean By default, this API endpoint returns a JSON Object holding the link to the image output. Set to true to return the raw image binary instead.

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 endpoint first if you need to upload an image before processing.

HTTP Response

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

This endpoint returns a JSON response when the blob parameter is omitted. When blob is enabled, the raw image binary is returned instead. The JSON response contains the following fields:
Fields Type Description
status Integer HTTP status code. 200 indicates success.
link URL Output image URL stored on pixlab.xyz CDN. Custom S3 storage can be configured via console.pixlab.io.
id String Unique identifier for processed image.
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