Version 1.9.72 (Release Notes)


rotatehttps://api.pixlab.io/rotate

Description

Rotates an image the specified number of degrees. Note that empty spaces left over from rotating the image are filled with the background color.

HTTP Methods

GET, POST

Request Parameters

Required

FieldsTypeDescription
imgURLInput image URL. If you want to upload your image directly from your app, then submit a multipart/form-data POST request.
degreeFloatRotation angle, in degrees. The rotation angle is interpreted as the number of degrees to rotate the image clockwise.
keyStringYour PixLab API Key. You can also embed your key in the WWW-Authenticate: HTTP header and omit this parameter if you want to.

Optional
FieldsTypeDescription
blobBooleanBy default, this command 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.
colorStringA string representing the background color for example: red, blue, yellow, etc or a hex color code like #fffeec, #e45cff, etc. If this field is missing, then the background is marked as transparent.

POST Request Body (If you plan to use POST instead of a simple GET request)

Allowed Content-Type:

multipart/form-data
application/json

Use multipart/form-data if you want to upload your image directly (refer to the sample set 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.

Response

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

This command return a JSON object after each call only if the optional blob parameter is not set. Otherwise the image binary contents is returned instead. The following are the JSON fields returned in response body:

FieldsTypeDescription
statusIntegerStatus code 200 indicates success, any other code indicates failure.
linkURLLink 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).
idStringUnique image ID.
errorStringError message if status != 200.

Python Example


import requests
import json

# Rotate this image 180 degree clockwise.
img = 'https://www.allaboutbirds.org/guide/PHOTO/LARGE/blue_jay_8.jpg'

degree = 180

req = requests.get('https://api.pixlab.io/rotate',params={'img':img,'degree':degree,'key':'My_PixLab_Key'})
reply = req.json()
if reply['status'] != 200:
	print (reply['error'])
else:
print ("Link to the pic: "+ reply['link'])

See Also