drawrectanglehttps://api.pixlab.io/drawrectangle
Description
Draw a single rectangle on a given image. This command is depreciated in favor of drawrectangles (with S) which permit drawing as much rectangles as desired on the input image especially if mixed with facedetect to mark detected faces.
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. |
| x | Integer | X coordinate of the top left corner. |
| y | Integer | Y coordinate of the top left corner. |
| width | Integer | Width of the desired rectangle. |
| height | Integer | Height of the desired rectangle. |
| 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 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. |
| color | String | Rectangle border color which default to white. Use hex color code such as #cef45f if you want to. |
| fillcolor | String | Rectangle fill color which default to none (Transparent). Use hex color code if you want to. |
| strokewidth | Float | Rectangle stroke (Border) width which default to 1.2. |
| strokeopacity | Float | Rectangle stroke opacity which default to 0.9. |
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.
Again, we advise to rely on drawrectangles for much more flexibility.
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
# Refer to https://github.com/symisc/pixlab for the full list of production ready code samples...