API Endpoint Access URL
https://api.pixlab.io/setorientation
Get Your API Key & Try SETORIENTATION Now ↗Description
Set the orientation of a given image using the SETORIENTATION API endpoint. Essential for developers and creators looking to manipulate image properties efficiently. Set the orientation of a given image.
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. |
orientation |
Integer | Orientation constant. See below for the list. |
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. |
Orientation Constants
Fields | Value |
---|---|
ORIENTATION_TOPLEFT |
1 |
ORIENTATION_TOPRIGHT |
2 |
ORIENTATION_BOTTOMRIGHT |
3 |
ORIENTATION_BOTTOMLEFT |
4 |
ORIENTATION_LEFTTOP |
5 |
ORIENTATION_RIGHTTOP |
6 |
ORIENTATION_RIGHTBOTTOM |
7 |
ORIENTATION_LEFTBOTTOM |
8 |
POST Request Body
(If you plan to use POST instead of a simple GET request)
Allowed Content-Types:
multipart/form-data
application/json
Use 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 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 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. When blob is set, the image binary data is returned directly. The response JSON contains the following fields:
Required
All parameters are required for this endpoint.
Optional
The blob
parameter is optional. When set, the API returns raw image data instead of JSON.
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, segment, favicon, quantize, randomthreshold, grayscale, raise, roundcorners, roll, shadow, sepia, transverse, transpose, reverse, reflect