API Endpoint Access URL
https://api.pixlab.io/implode
Get Your API Key & Try IMPLODE Now ↗Description
IMPLODE API endpoint creates a new image with pixels imploded by a specified percentage, ideal for developers and creators looking to enhance image effects. Creates a new image that is a copy of an existing one with the image pixels "imploded" by the specified percentage.
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. |
radius |
Float | The radius of the implode (Max value is set to 10.00). |
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. |
POST Request Body
This section details the requirements for using a POST request instead of a simple GET request.
Allowed Content-Types:
multipart/form-dataapplication/jsonUse multipart/form-data if you want to upload your image directly (refer to the REST API code samples or The PixLab Github Repository↗ for a working example). If you are using JSON, then your image must be already uploaded somewhere. Call store if you want to upload an image for example 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 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.
Code Samples
# Refer to the PixLab Github Repository at: https://github.com/symisc/pixlab for the full list of production ready code samples...// Refer to the PixLab Github Repository at: https://github.com/symisc/pixlab for the full list of production ready code samples...# Refer to the PixLab Github Repository at: https://github.com/symisc/pixlab for the full list of production ready code samples...# Refer to the PixLab Github Repository at: https://github.com/symisc/pixlab for the full list of production ready code samples...Similar API Endpoints
enhance, haldclut, implode, linearstretch, medianfilter, scale, modulate, shade, negate, separate, sketch, normalize, oilpaint, orderedposterize