borderhttps://api.pixlab.io/border
Description
Generate a border with a desired color for a given image.
HTTP Methods
GET, POST
Request 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. |
width | Integer | The width of the border (Max value is set to 300). |
height | Integer | The height of the border (Max value is set to 300). |
color | String | A string representing the color for example: red, blue, yellow, etc or a color code like #fffeec, #e45cff, etc. If this field is missing, then the default color is set to gray. |
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. |
Tip: If one of the height or width parameter is missing (but not both), then the available length is applied to the missing side. (See the python example below).
Optional
Fields | Type | Description |
---|---|---|
blob | Boolean | By 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. |
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:
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. |
Python Example
import requests
import json
req = requests.get('https://api.pixlab.io/border',params={'img':'http://www.allaboutbirds.org/guide/PHOTO/LARGE/blue_jay_8.jpg','width':20,'color':'yellow','key':'My_PixLab_Key'})
reply = req.json()
if reply['status'] != 200:
print (reply['error'])
else:
print ("Link to the pic: "+ reply['link'])
See Also
noise, blur, motionblur, gaussianblur, radialblur, blackthreshold, broder3d, charcoal, chop, despeckle, deskew, edge, emboss, equalize, extent, flatten, gamma, flip