API Endpoint Access URL
https://api.pixlab.io/segment
Get Your API Key & Try SEGMENT Now ↗Description
Segment a given image by analyzing and identifying units that are similar.
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. |
ct |
Float | A percentage describing minimum number of pixels contained in hexedra before it is considered valid. |
cs |
Integer | Color space. A value between 1..22. See bg-remove for additional information. |
st |
Float | Eliminates noise from the histogram. A value between 1..255. |
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
(If you plan to use POST 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 API returns a JSON response with application/json content type if the optional blob parameter is not set.
If the blob parameter is specified, the API returns the raw image binary data instead. The JSON response contains the following fields:
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
polaroid, posterize, roundcorners, favicon, randomthreshold, grayscale, raise, quantize, roll, shadow, sepia, transverse, transpose, reverse, reflect