modulatehttps://api.pixlab.io/modulate
Description
Control the brightness, saturation, and hue. Hue is the percentage of absolute rotation from the current position. For example 50 results in a counter-clockwise rotation of 90 degrees, 150 results in a clockwise rotation of 90 degrees, with 0 and 200 both resulting in a rotation of 180 degrees.
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. |
| brightness | Float | Desired brightness (Max value is set to 500.00). |
| saturation | Float | Desired saturation (Max value is set to 500.00). |
| hue | Float | percentage of absolute rotation from the current position. (Max value is set to 360.00). |
| 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. |
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
# Refer to https://github.com/symisc/pixlab for the full list of production ready code samples...See Also
enhance, haldclut, implode, medianfilter, implode, scale, linearstretch, shade, negate, separate, sketch, normalize, oilpaint, orderedposterize