API Endpoint Access URL
https://api.pixlab.io/flatten
Get Your API Key & Try FLATTEN Now ↗Description
Merge multiple images into a single image using the FLATTEN API endpoint. Ideal for combining Photoshop PSD layers efficiently. Merges a sequence of images. This is useful for combining Photoshop (PSD) layers into a single image.
HTTP Methods
GET, POST
HTTP Parameters
Required
| Fields | Type | Description |
|---|---|---|
img |
URL | Input image URL (PSD & GIF files are accepted by this API endpoint). 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 |
|---|---|---|
blob |
Boolean | By default, this API endpoint returns a JSON Object holding the link to the image output. Set this parameter to true to receive the raw image binary data instead. |
export |
String (Image Format) | By default, the flattened image exports to PNG format. Override with any supported format. Call the extension API endpoint for supported formats (configurable via your dashboard ↗). |
POST Request Body
Use when submitting POST requests instead of GET:
Allowed Content-Types:
multipart/form-dataapplication/json
Use multipart/form-data for direct image uploads (see examples). For JSON requests, the image must be pre-uploaded. Use the store endpoint to upload images before invoking this API endpoint.
HTTP Response
The endpoint returns application/json if the optional blob parameter is not set.
This API endpoint returns a JSON Object after each call unless the blob parameter is specified, in which case the raw image binary is returned. The JSON response contains these fields:
| Fields | Type | Description |
|---|---|---|
status |
Integer | Status code 200 indicates success, any other code indicates failure. |
link |
URL | Link to the processed image stored on our servers unless custom S3 keys are configured (see your dashboard ↗ for S3 configuration). |
id |
String | Unique identifier for the processed image. |
error |
String | Error description when status ≠ 200. |
For more information about storage configuration, visit PixLab Console.
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
blackthreshold, border3d, border, charcoal, chop, despeckle, deskew, edge, emboss, equalize, extent, gamma, flip