Aviator logo

Getting Started Edit

Welcome to imager200 API docs. You can find detailed specification of each endpoint and usage examples.

All endpoints have synchronous (/{endpoint}/sync) and asynchronous (/{endpoint}) versions. Synchronous endpoints returns the result image in the body of the response (and thus the response is suspended until the processing is finished). The asynchronous endpoint returns immediately and processes the image asap. The image is stored according to the provided post operation configuration or stored in our temporary storage where the Location header specifies the exact location. More details on post operations can be found on the getting started guides

Most endpoints (except /draw, /blend, /concat) allows also to send the image either in the body of the request (POST endpoints) or send only the url of the image (GET endpoints) to be downloaded and processed by the API.

Therefore there are 4 possibilities for most endpoints GET /{endpoint}?url={imageUrl}, GET /{endpoint}/sync?url={imageUrl}, POST /{endpoint}/sync, POST /{endpoint}

If you find some inacurate information. Please let us know anytime at contact@imager200.io

Authentication Edit

All API requests need to have an X-Imager-Key header with your provided API key as a value otherwise 401 will be returned.

Your API key can be obtained from the control panel once you sign up. More details can be found on the getting started guides.

 curl -H "X-Imager-Key: YOUR_API_KEY" https://api.imager200.io/grayscale?url=http://image.com/image.jpeg

Common headers Edit

Name Description
X-Imager-Key Contains the API key. should be part of every request
X-PostOp-Id Optional. Only used in async endpoints. It contains the post operation id that should be applied after processing the image
X-Upload-File-Name Optional. Can be used to give the stored image a name instead of a random / the configured one. The value in this header takes precedence over the file naming convention configured in the post operation. The value should contain the file name only without extension.

Common Responses Edit

Status Description
402 indicates that something is wrong with your subscription: either your subscription payment is past due or you have exceeded the maximum allowed requests by your plan.
503 error that indicates an unreachable service (usually the authentication server)
401 indicates that your API key is wrong or missing
400 validation error specific to the endpoint parameters. Can also indicate that the X-PostOp-Id value is not found or the image format is not valid or unsupported
201 returned by async endpoints to indicate that requests has been received and being processed. It does not necessarily mean the success of the operation.
200 returned by sync endpoints. Means that the request has succeeded and the result is in the response body.

All errors will return JSON in the following format:

{
    "message": "Subscription Inactive",
    "details": "Your subscription seems to be past due because you have not yet paid your monthly fee. You can use the control panel to pay the current month."
}
{
    "message": "Subscription Inactive",
    "details": "Your subscription seems to be pending because you exceeded the number of allowed operations. You can use the control panel to either upgrade or wait until next month."
}
{
    "message": "Unknown Error",
    "details": "Authentication could not be performed. Please try later or contact support"
}
{
    "message": "Unauthorized",
    "details": "Invalid authorization. Your key is missing or invalid"
}
{
    "message": "Unknown post-operation invocation id",
    "details": "The X-PostOp-Id value was not found for the api-key, please check and try again, or create a new post-operation from the control panel."
}
{
    "message": "Invalid parameters",
    "details": "unsupported image type"
}

Limits Edit

For security measures and for avoiding server overload, endpoints have the following limits:

  • Max image width: 4096 pixels
  • Max image height: 4096 pixels
  • Max image size: 20MB
  • Requests per second: 15
  • Max connections from one host: 10

If you need an increase in the limits, please let us know by creating a ticket from the control panel.

/blend/sync Edit

Blends two images into one synchronously

Supported image types: jpeg, png, bmp

Payload (json object)
image1

The first image url

image2

The second image url

alpha

value between 0 and 1 that defines which image will be more visible (0 means only image 1 one will be visible, 1 the opposite), 0.5 means that both images will have the same weight. Default value: 0.5

targetFormat

output image format.Possible values:jpeg, png, bmp. Default:jpeg

mode

The blending mode. Possible values:rts (resize to smallest) or rtl (resize to largest). Defines whether the result image will be resized to the smaller one or the larger one in case both images have different dimensions. It has not effect if images have the same dimensions. Default value: rts

Headers
Content-Type

application/json

Response Statuses
200

Images will be blended and returned immediately in the response body.

400

Some field is missing or has invalid value.

  • Example Payload:
    {
        "image1": "http://image.com/image1.jpeg",
        "image2": "http://image.com/image2.jpeg",
        "alpha": 0.5,
        "targetFormat": "bmp",
        "mode": "rtl"
    }
    
curl -o blend_example.png -H "Content-Type: application/json" -H "X-Imager-Key: YOUR_API_KEY" -d '{"image1":"https://i.pinimg.com/originals/6f/55/ff/6f55ff285bb934b6fdbd237f654c10c8.jpg","image2":"https://upload.wikimedia.org/wikipedia/commons/6/67/Facebook_logo_thumbs_up_like_transparent.png","alpha":0.5,"targetFormat":"png","mode":"rtl"}' https://api.imager200.io/blend/sync
{
  "message": "Invalid parameters",
  "details": "invalid alpha value",
  "requestId": "95158dd31d304bc5925af8cf673c5596"
}

Original

Processed

/blend Edit

Blends two images into one asychronously

Supported image types: jpeg, png, bmp

Payload (json object)
image1

The first image url

image2

The second image url

alpha

value between 0 and 1 that defines which image will be more visible (0 means only image 1 one will be visible, 1 the opposite), 0.5 means that both images will have the same weight. Default value: 0.5

targetFormat

output image format.Possible values:jpeg, png, bmp. Default:jpeg

mode

The blending mode. Possible values:rts (resize to smallest) or rtl (resize to largest). Defines whether the result image will be resized to the smaller one or the larger one in case both images have different dimensions. It has not effect if images have the same dimensions. Default value: rts

Headers
Content-Type

application/json

Response Statuses
201

Images will be blended asynchronously and stored according to the post operation configuration or in a temporary storage (in this case the Location header contains where the image is stored)

400

Some field or header is missing or has invalid value.

  • Example Payload:
    {
        "image1": "http://image.com/image1.jpeg",
        "image2": "http://image.com/image2.jpeg",
        "alpha": 0.5,
        "targetFormat": "bmp",
        "mode": "rtl"
    }
    
curl -H "Content-Type: application/json" -H "X-Imager-Key: YOUR_API_KEY" -d '{"image1":"https://i.pinimg.com/originals/6f/55/ff/6f55ff285bb934b6fdbd237f654c10c8.jpg","image2":"https://upload.wikimedia.org/wikipedia/commons/6/67/Facebook_logo_thumbs_up_like_transparent.png","alpha":0.5,"targetFormat":"png","mode":"rtl"}' https://api.imager200.io/blend
{
  "message": "Invalid parameters",
  "details": "invalid alpha value",
  "requestId": "95158dd31d304bc5925af8cf673c5596"
}

Original

Processed

/blur/sync Edit

Blurs an image synchronously

Supported image types: jpeg, png, bmp

Query Parameters
sigma

optional decimal value between 0 and 100 that controls the strenght of the blur. Default Value is 10

Payload
image

image as bytes

Headers
Content-Type

application/x-www-form-urlencoded

Response Statuses
200

Image will be blured and returned immediately in the response body.

400

Some field or header is missing or has invalid value.

curl -v -o blur_example.jpeg -H "X-Imager-Key: YOUR_API_KEY" --data-binary @jpeg_image.jpg 'https://api.imager200.io/blur/sync?sigma=25.75'
{
  "message": "Invalid parameters",
  "details": "invalid sigma value",
  "requestId": "95158dd31d304bc5925af8cf673c5596"
}

Original

Processed

/blur Edit

Blurs an image asynchronously

Supported image types: jpeg, png, bmp

Query Parameters
sigma

optional decimal value between 0 and 100 that controls the strenght of the blur. Default Value is 10

Payload
image

image as bytes

Headers
Content-Type

application/x-www-form-urlencoded

Response Statuses
201

Image will be blured asynchronously and stored according to the post operation configuration or in a temporary storage (in this case the Location header contains where the image is stored)

400

Some field or header is missing or has invalid value.

curl -v -H "X-Imager-Key: YOUR_API_KEY" --data-binary @jpeg_image.jpg 'https://api.imager200.io/blur/sync?sigma=25.75'
{
  "message": "Invalid parameters",
  "details": "invalid sigma value",
  "requestId": "95158dd31d304bc5925af8cf673c5596"
}

Original

Processed

/blur/sync Edit

Blurs an image from a remote url synchronously

Supported image types: jpeg, png, bmp

Query Parameters
sigma

optional decimal value between 0 and 100 that controls the strenght of the blur. Default Value is 10

url

required url of the image to download

Response Statuses
201

Image will be downloaded, blured, and returned in the response body

400

Some field or header is missing or has invalid value.

curl -v -o blur_partial_example.jpeg -H "X-Imager-Key: YOUR_API_KEY" 'https://api.imager200.io/blur/sync?url=http://api-docs.imager200.io/images/examples/jpeg_image.jpg'
{
  "message": "Invalid parameters",
  "details": "invalid sigma value",
  "requestId": "95158dd31d304bc5925af8cf673c5596"
}

Original

Processed

/blur Edit

Blurs an image from a remote url asynchronously

Supported image types: jpeg, png, bmp

Query Parameters
sigma

optional decimal value between 0 and 100 that controls the strenght of the blur. Default Value is 10

url

required url of the image to download

Response Statuses
201

Image will be downloaded, blured asynchronously, and stored according to the post operation configuration or in a temporary storage (in this case the Location header contains where the image is stored)

400

Some field or header is missing or has invalid value.

curl -v -H "X-Imager-Key: YOUR_API_KEY" 'https://api.imager200.io/blur?url=http://api-docs.imager200.io/images/examples/jpeg_image.jpg'
{
  "message": "Invalid parameters",
  "details": "invalid sigma value",
  "requestId": "95158dd31d304bc5925af8cf673c5596"
}

Original

Processed

/blur-partial Edit

Blurs a fraction of the image defined by the rectangle (x0, y0, x1, y1) asynchronously

Supported image types: jpeg, png, bmp

Query Parameters
sigma

optional a decimal value between 0 and 100 that controls the strenght of the blur. Default Value is 10

x0

a number that defines the x coordinate of the first point of the rectangle to blur. Should be within the image width bound.

y0

a number that defines the y coordinate of the first point of the rectangle to blur. Should be within the image height bound.

x1

a number that defines the x coordinate of the second point of the rectangle to blur. Should be within the image width bound.

y1

a number that defines the y coordinate of the second point of the rectangle to blur. Should be within the image height bound.

Payload
image

image as bytes

Headers
Content-Type

application/x-www-form-urlencoded

Response Statuses
201

Image will be blured asynchronously and stored according to the post operation configuration or in a temporary storage (in this case the Location header contains where the image is stored).

400

Some field or header is missing or has invalid value.

curl -v -H "X-Imager-Key: YOUR_API_KEY" --data-binary @jpeg_image.jpg 'https://api.imager200.io/blur/partial?x0=50&y0=100&x1=500&y1=300'
{
  "message": "Invalid parameters",
  "details": "invalid x1 value",
  "requestId": "95158dd31d304bc5925af8cf673c5596"
}

Original

Processed

/blur-partial/sync Edit

Blurs a fraction of the image defined by the rectangle (x0, y0, x1, y1) synchronously

Supported image types: jpeg, png, bmp

Query Parameters
sigma

optional decimal value between 0 and 100 that controls the strenght of the blur. Default Value is 10

x0

a number that defines the x coordinate of the first point of the rectangle to blur. Should be within the image width bound.

y0

a number that defines the y coordinate of the first point of the rectangle to blur. Should be within the image height bound.

x1

a number that defines the x coordinate of the second point of the rectangle to blur. Should be within the image width bound.

y1

a number that defines the y coordinate of the second point of the rectangle to blur. Should be within the image height bound.

Payload
image

image as bytes

Headers
Content-Type

application/x-www-form-urlencoded

Response Statuses
200

Image will be blured and returned immediately in the response body.

400

Some field or header is missing or has invalid value.

curl -v -o blur_partial_example.jpeg -H "X-Imager-Key: YOUR_API_KEY" --data-binary @jpeg_image.jpg 'https://api.imager200.io/blur/partial/sync?x0=50&y0=100&x1=500&y1=300'
{
  "message": "Invalid parameters",
  "details": "invalid x1 value",
  "requestId": "95158dd31d304bc5925af8cf673c5596"
}

Original

Processed

/blur-partial Edit

Blurs a fraction of the image defined by the rectangle (x0, y0, x1, y1) asynchronously from a given remote url

Supported image types: jpeg, png, bmp

Query Parameters
url

required url of the image to download

sigma

optional decimal value between 0 and 100 that controls the strenght of the blur. Default Value is 10

x0

a number that defines x coordinate of the first point of the rectangle to blur. Should be within the image width bound.

y0

a number that defines y coordinate of the first point of the rectangle to blur. Should be within the image height bound.

x1

a number that defines x coordinate of the second point of the rectangle to blur. Should be within the image width bound.

y1

a number that defines y coordinate of the second point of the rectangle to blur. Should be within the image height bound.

Response Statuses
201

Image will be downloaded, blured asynchronously, and stored according to the post operation configuration or in a temporary storage (in this case the Location header contains where the image is stored)

400

Some field or header is missing or has invalid value.

curl -v -H "X-Imager-Key: YOUR_API_KEY" 'https://api.imager200.io/blur/partial?x0=50&y0=100&x1=500&y1=300&url=http://api-docs.imager200.io/images/examples/jpeg_image.jpg'
{
  "message": "Invalid parameters",
  "details": "invalid x1 value",
  "requestId": "95158dd31d304bc5925af8cf673c5596"
}

Original

Processed

/blur-partial/sync Edit

Blurs a fraction of the image defined by the rectangle (x0, y0, x1, y1) synchronously from a given remote url

Supported image types: jpeg, png, bmp

Query Parameters
url

required url of the image to download

sigma

optional decimal value between 0 and 100 that controls the strenght of the blur. Default Value is 10

x0

a number that defines x coordinate of the first point of the rectangle to blur. Should be within the image width bound.

y0

a number that defines y coordinate of the first point of the rectangle to blur. Should be within the image height bound.

x1

a number that defines x coordinate of the second point of the rectangle to blur. Should be within the image width bound.

y1

a number that defines y coordinate of the second point of the rectangle to blur. Should be within the image height bound.

Response Statuses
200

Image will be downloaded, blured and returned in the response body

400

Some field or header is missing or has invalid value.

curl -v -o blur_partial_example.jpeg -H "X-Imager-Key: YOUR_API_KEY" 'https://api.imager200.io/blur/partial/sync?x0=50&y0=100&x1=500&y1=300&url=http://api-docs.imager200.io/images/examples/jpeg_image.jpg'
{
  "message": "Invalid parameters",
  "details": "invalid x1 value",
  "requestId": "95158dd31d304bc5925af8cf673c5596"
}

Original

Processed

/brightness/sync Edit

Changes the brightness of an image synchronously

Supported image types: jpeg, png, bmp, gif

Query Parameters
percentage

decimal value between -100 and 100 that controls the brightness level. Default: 0

Payload
image

image as bytes

Headers
Content-Type

application/x-www-form-urlencoded

Response Statuses
200

Image brightness will be adjusted according to percentage value and returned immediately in the response body.

400

Some field or header is missing or has invalid value.

curl -O result.bmp -H "X-Imager-Key: YOUR_API_KEY" --data-binary @file.jpeg https://api.imager200.io/brightness/sync?percentage=25
{
  "message": "Invalid parameters",
  "details": "invalid percentage value",
  "requestId": "95158dd31d304bc5925af8cf673c5596"
}

Original

Processed

/brightness Edit

Changes the brightness of an image asynchronously

Supported image types: jpeg, png, bmp, gif

Query Parameters
percentage

decimal value between -100 and 100 that controls the brightness level. Default: 0

Payload
image

image as bytes

Headers
Content-Type

application/x-www-form-urlencoded

Response Statuses
201

Image brightness will be adjusted according to percentage value and stored according to the post operation configuration or in a temporary storage (in this case the Location header contains where the image is stored)

400

Some field or header is missing or has invalid value.

curl -v -H "X-Imager-Key: YOUR_API_KEY" --data-binary @jpeg_image.jpg 'https://api.imager200.io/brightness?percentage=50'
{
  "message": "Invalid parameters",
  "details": "invalid percentage value",
  "requestId": "95158dd31d304bc5925af8cf673c5596"
}

Original

Processed

/brightness Edit

Changes the brightness of a remote image asynchronously

Supported image types: jpeg, png, bmp, gif

Query Parameters
percentage

decimal value between -100 and 100 that controls the brightness level. Default: 0

url

required url of the image to download

Response Statuses
201

Image will be downloaded and its brightness will be adjusted according to percentage value, and stored according to the post operation configuration or in a temporary storage (in this case the Location header contains where the image is stored)

400

Some field or header is missing or has invalid value.

curl -v -H "X-Imager-Key: YOUR_API_KEY" 'https://api.imager200.io/brightness?percentage=50&url=http://api-docs.imager200.io/images/examples/jpeg_image.jpg'
{
  "message": "Invalid parameters",
  "details": "invalid percentage value",
  "requestId": "95158dd31d304bc5925af8cf673c5596"
}

Original

Processed

/brightness/sync Edit

Changes the brightness of a remote image asynchronously

Supported image types: jpeg, png, bmp, gif

Query Parameters
percentage

decimal value between -100 and 100 that controls the brightness level. Default: 0

url

required url of the image to download

Response Statuses
200

Image will be downloaded and its brightness will be adjusted according to percentage value, and returned in the response body.

400

Some field or header is missing or has invalid value.

curl -v -o brightness_example.jpeg -H "X-Imager-Key: YOUR_API_KEY" 'https://api.imager200.io/brightness/sync?percentage=50&url=http://api-docs.imager200.io/images/examples/jpeg_image.jpg'
{
  "message": "Invalid parameters",
  "details": "invalid percentage value",
  "requestId": "95158dd31d304bc5925af8cf673c5596"
}

Original

Processed

/compress/sync Edit

Compresses the image according to the parameters

Supported image types: jpeg, png

Query Parameters
jpegQuality

optional integer value between 0 and 100 that defines the jpeg quality level (the higher is the value, the better quality of the image is). Only applied if the image is of type jpeg. Default value is 95.

pngCompression

optional integer value between 0 and 9 that defines the png compression level (higher value means a smaller size and longer compression time). Only applied if image is of type png. Default value is 3.

Payload
image

image as bytes

Headers
Content-Type

application/x-www-form-urlencoded

Response Statuses
200

Image will be compressed and returned in the request body.

400

Some field or header is missing or has invalid value.

curl -v -o compress_example.png -H "X-Imager-Key: YOUR_API_KEY" --data-binary @png_image.png 'https://api.imager200.io/compress/sync?pngCompression=9'
{
  "message": "Invalid parameters",
  "details": "jpegQuality should be between 0 and 100",
  "requestId": "95158dd31d304bc5925af8cf673c5596"
}

/compress Edit

Compresses the image asynchronously according to the parameters

Supported image types: jpeg, png

Query Parameters
jpegQuality

optional integer value between 0 and 100 that defines the jpeg quality level (the higher is the value, the better quality of the image is). Only applied if the image is of type jpeg. Default value is 95.

pngCompression

optional integer value between 0 and 9 that defines the png compression level (higher value means a smaller size and longer compression time). Only applied if the image is of type png. Default value is 3.

Payload
image

image as bytes

Headers
Content-Type

application/x-www-form-urlencoded

Response Statuses
200

Image will be compressed and stored according to the post operation configuration or in a temporary storage (in this case the Location header contains where the image is stored)

400

Some field or header is missing or has invalid value.

curl -v -H "X-Imager-Key: YOUR_API_KEY" --data-binary @png_image.png 'https://api.imager200.io/compress?pngCompression=9'
{
  "message": "Invalid parameters",
  "details": "jpegQuality should be between 0 and 100",
  "requestId": "95158dd31d304bc5925af8cf673c5596"
}

/compress/sync Edit

Compresses a remote image according to the parameters

Supported image types: jpeg, png

Query Parameters
jpegQuality

optional integer value between 0 and 100 that defines the jpeg quality level (the higher is the value, the better quality of the image is). Only applied if the image is of type jpeg. Default value is 95.

pngCompression

optional integer value between 0 and 9 that defines the png compression level (higher value means a smaller size and longer compression time). Only applied if the image is of type png. Default value is 3.

url

required url of the image to download

Response Statuses
200

Image will be downloaded, compressed and returned in the response body.

400

Some field or header is missing or has invalid value.

curl -v -o compress_example.png -H "X-Imager-Key: YOUR_API_KEY" 'https://api.imager200.io/compress/sync?pngCompression=9&url=http://api-docs.imager200.io/images/examples/jpeg_image.jpg'
{
  "message": "Invalid parameters",
  "details": "jpegQuality should be between 0 and 100",
  "requestId": "95158dd31d304bc5925af8cf673c5596"
}

/compress Edit

Compresses a remote image according to the parameters

Supported image types: jpeg, png

Query Parameters
jpegQuality

optional integer value between 0 and 100 that defines the jpeg quality level (the higher is the value, the better quality of the image is). Only applied if the image is of type jpeg. Default value is 95.

pngCompression

optional integer value between 0 and 9 that defines the png compression level (higher value means a smaller size and longer compression time). Only applied if the image is of type png. Default value is 3.

url

required url of the image to download

Response Statuses
200

Image will be downloaded, compressed, and stored according to the post operation configuration or in a temporary storage (in this case the Location header contains where the image is stored)

400

Some field or header is missing or has invalid value.

curl -v -H "X-Imager-Key: YOUR_API_KEY" 'https://api.imager200.io/compress?pngCompression=9&url=http://api-docs.imager200.io/images/examples/jpeg_image.jpg'
{
  "message": "Invalid parameters",
  "details": "jpegQuality should be between 0 and 100",
  "requestId": "95158dd31d304bc5925af8cf673c5596"
}

/concat Edit

Concats two images into one asynchronously

Supported image types: jpeg, png, bmp, gif

Payload (json object)
sourceUrl

The first image url

candidateUrl

The second image url

direction

The concat direction. Possible values:hor for horizontal, ver vertical. This parameter defines how the images will be concatenated. horizontal means that the images will concatenated one beside the other from left to right (source then candidate). vertical means that images will be concatenated one on the top of the other from top to bottom (source then candidate). Default: hor

targetFormat

output image format. Possible values:jpeg, png, bmp. Default:jpeg

concatMode

the concatenation mode. Possible values:rts (resize to smallest) or rtl (resize to largest), or none. Defines whether the result image will be resized to the smaller one or the larger one in case both images have different dimensions. It has not effect if images have the same dimensions. If none is used, the result will keep images original sizes. Default: none

Headers
Content-Type

application/json

Response Statuses
201

Images will be concatenated and stored according to the post operation configuration or in a temporary storage (in this case the Location header contains where the image is stored)

400

Some field or header is missing or has invalid value.

  • Example Payload:
       {
            "sourceUrl": "https://images.com/image.jpeg",
            "candidateUrl": "https://images.com/image2.png",
            "direction": "hor",
            "targetFormat": "bmp",
            "concatMode": "rts"
        }
    
curl -v -H "Content-Type: application/json" -H "X-Imager-Key: YOUR_API_KEY" -d '{"sourceUrl":"https://i.pinimg.com/originals/6f/55/ff/6f55ff285bb934b6fdbd237f654c10c8.jpg","candidateUrl":"https://lemarocguide.com/wp-content/themes/maroc/img/provinces/chefchaouen/targha-small.png","direction":"hor","targetFormat":"jpeg","concatMode":"rts"}' https://api.imager200.io/concat
{
  "message": "Invalid parameters",
  "details": "Invalid Content-Type value",
  "requestId": "95158dd31d304bc5925af8cf673c5596"
}

Original

Processed

/concat/sync Edit

Concats two images into one synchronously

Supported image types: jpeg, png, bmp, gif

Payload (json object)
sourceUrl

The first image url

candidateUrl

The second image url

direction

The concat direction. Possible values:hor for horizontal, ver vertical. This parameter defines how the images will be concatenated. horizontal means that the images will concatenated one beside the other from left to right (source then candidate). vertical means that images will be concatenated one on the top of the other from top to bottom (source then candidate). Default: hor

targetFormat

output image format. Possible values:jpeg, png, bmp. Default:jpeg

concatMode

the concatenation mode. Possible values:rts (resize to smallest) or rtl (resize to largest), or none. Defines whether the result image will be resized to the smaller one or the larger one in case both images have different dimensions. It has not effect if images have the same dimensions. If none is used, the result will keep images original sizes. Default: none

Headers
Content-Type

application/json

Response Statuses
200

Images will be concatenated and returned in the response body

400

Some field or header is missing or has invalid value.

  • Example Payload:
       {
            "sourceUrl": "https://images.com/image.jpeg",
            "candidateUrl": "https://images.com/image2.png",
            "direction": "hor",
            "targetFormat": "bmp",
            "concatMode": "rts"
        }
    
curl -v -o concat_example2.jpeg -H "Content-Type: application/json" -H "X-Imager-Key: YOUR_API_KEY" -d '{"sourceUrl":"https://i.pinimg.com/originals/6f/55/ff/6f55ff285bb934b6fdbd237f654c10c8.jpg","candidateUrl":"https://lemarocguide.com/wp-content/themes/maroc/img/provinces/chefchaouen/targha-small.png","direction":"hor","targetFormat":"jpeg","concatMode":"rts"}' https://api.imager200.io/concat/sync
{
  "message": "Invalid parameters",
  "details": "Invalid Content-Type value",
  "requestId": "95158dd31d304bc5925af8cf673c5596"
}

Original

Processed

/contrast/sync Edit

Changes the contrast of an image synchronously

Supported image types: jpeg, png, bmp, gif

Query Parameters
percentage

decimal value between -100 and 100 that controls the contrast level. Default value: 0

Payload
image

image as bytes

Headers
Content-Type

application/x-www-form-urlencoded

Response Statuses
200

Image contrast will be adjusted according to the percentage value and returned immediately in the response body.

400

Some field or header is missing or has invalid value.

curl -v -o contrast_example.jpeg -H "X-Imager-Key: YOUR_API_KEY" --data-binary @jpeg_image.jpg 'https://api.imager200.io/contrast/sync?percentage=50'
{
  "message": "Invalid parameters",
  "details": "invalid percentage value",
  "requestId": "95158dd31d304bc5925af8cf673c5596"
}

Original

Processed

/contrast Edit

Changes the contrast of an image asynchronously

Supported image types: jpeg, png, bmp, gif

Query Parameters
percentage

decimal value between -100 and 100 that controls the contrast level. Default value: 0

Payload
image

image as bytes

Headers
Content-Type

application/x-www-form-urlencoded

Response Statuses
201

Image contrast will be adjusted according to the percentage value and stored according to the post operation configuration or in a temporary storage (in this case the Location header contains where the image is stored)

400

Some field or header is missing or has invalid value.

curl -v -H "X-Imager-Key: YOUR_API_KEY" --data-binary @jpeg_image.jpg 'https://api.imager200.io/contrast?percentage=50'
{
  "message": "Invalid parameters",
  "details": "invalid percentage value",
  "requestId": "95158dd31d304bc5925af8cf673c5596"
}

Original

Processed

/contrast/sync Edit

Changes the contrast of a remote image synchronously

Supported image types: jpeg, png, bmp, gif

Query Parameters
percentage

decimal value between -100 and 100 that controls the contrast level. Default value: 0

url

required url of the image to download

Response Statuses
200

Image contrast will be downloaded, its contrast adjusted according to the percentage value and returned in the response body.

400

Some field or header is missing or has invalid value.

curl -v -o contrast_example.jpeg -H "X-Imager-Key: YOUR_API_KEY" 'https://api.imager200.io/contrast/sync?percentage=50&url=http://api-docs.imager200.io/images/examples/jpeg_image.jpg'
{
  "message": "Invalid parameters",
  "details": "invalid percentage value",
  "requestId": "95158dd31d304bc5925af8cf673c5596"
}

Original

Processed

/contrast Edit

Changes the contrast of a remote image asynchronously

Supported image types: jpeg, png, bmp, gif

Query Parameters
percentage

decimal value between -100 and 100 that controls the contrast level. Default value: 0

url

required url of the image to download

Response Statuses
201

Image contrast will be downloaded, its contrast adjusted according to the percentage value and stored according to the post operation configuration or in a temporary storage (in this case the Location header contains where the image is stored)

400

Some field or header is missing or has invalid value.

curl -v -H "X-Imager-Key: YOUR_API_KEY" 'https://api.imager200.io/contrast?percentage=50&url=http://api-docs.imager200.io/images/examples/jpeg_image.jpg'
{
  "message": "Invalid parameters",
  "details": "invalid percentage value",
  "requestId": "95158dd31d304bc5925af8cf673c5596"
}

Original

Processed

/crop/sync Edit

Crops an image synchronously

Supported image types: jpeg, png, bmp, gif

Query Parameters
x0

a number that defines the x coordinate of the first point of the rectangle to crop. Should be within the image width bound.

y0

a number that defines the y coordinate of the first point of the rectangle to crop. Should be within the image height bound.

x1

a number that defines the x coordinate of the second point of the rectangle to crop. Should be within the image width bound.

y1

a number that defines the y coordinate of the second point of the rectangle to crop. Should be within the image height bound.

Payload
image

image as bytes

Headers
Content-Type

application/x-www-form-urlencoded

Response Statuses
200

Image will be cropped and returned in the response body.

400

Some field or header is missing or has invalid value.

curl -v -o crop_example.jpeg -H "X-Imager-Key: YOUR_API_KEY" --data-binary @jpeg_image.jpg 'https://api.imager200.io/crop/sync?x0=100&y0=150&x1=350&y1=400'
{
  "message": "Invalid parameters",
  "details": "Invalid x0 value",
  "requestId": "95158dd31d304bc5925af8cf673c5596"
}

Original

Processed

/crop Edit

Crops an image asynchronously

Supported image types: jpeg, png, bmp, gif

Query Parameters
x0

a number that defines the x coordinate of the first point of the rectangle to crop. Should be within the image width bound.

y0

a number that defines the y coordinate of the first point of the rectangle to crop. Should be within the image height bound.

x1

a number that defines the x coordinate of the second point of the rectangle to crop. Should be within the image width bound.

y1

a number that defines the y coordinate of the second point of the rectangle to crop. Should be within the image height bound.

Payload
image

image as bytes

Headers
Content-Type

application/x-www-form-urlencoded

Response Statuses
201

Image will be cropped and stored according to the post operation configuration or in a temporary storage (in this case the Location header contains where the image is stored)

400

Some field or header is missing or has invalid value.

curl -v -H "X-Imager-Key: YOUR_API_KEY" --data-binary @jpeg_image.jpg 'https://api.imager200.io/crop?x0=100&y0=150&x1=350&y1=400'
{
  "message": "Invalid parameters",
  "details": "Invalid x0 value",
  "requestId": "95158dd31d304bc5925af8cf673c5596"
}

Original

Processed

/crop/sync Edit

Crops a remote image synchronously

Supported image types: jpeg, png, bmp, gif

Query Parameters
x0

a number that defines the x coordinate of the first point of the rectangle to crop. Should be within the image width bound.

y0

a number that defines the y coordinate of the first point of the rectangle to crop. Should be within the image height bound.

x1

a number that defines the x coordinate of the second point of the rectangle to crop. Should be within the image width bound.

y1

a number that defines the y coordinate of the second point of the rectangle to crop. Should be within the image height bound.

url

required url of the image to download

Response Statuses
200

Image will be downloaded, cropped and returned in the response body.

400

Some field or header is missing or has invalid value.

curl -v -o crop_example.jpeg -H "X-Imager-Key: YOUR_API_KEY" 'https://api.imager200.io/crop/sync?x0=100&y0=150&x1=350&y1=400&url=http://api-docs.imager200.io/images/examples/jpeg_image.jpg'
{
  "message": "Invalid parameters",
  "details": "Invalid x0 value",
  "requestId": "95158dd31d304bc5925af8cf673c5596"
}

Original

Processed

/crop Edit

Crops a remote image asynchronously

Supported image types: jpeg, png, bmp, gif

Query Parameters
x0

a number that defines the x coordinate of the first point of the rectangle to crop. Should be within the image width bound.

y0

a number that defines the y coordinate of the first point of the rectangle to crop. Should be within the image height bound.

x1

a number that defines the x coordinate of the second point of the rectangle to crop. Should be within the image width bound.

y1

a number that defines the y coordinate of the second point of the rectangle to crop. Should be within the image height bound.

url

required url of the image to download

Response Statuses
201

Image will be downlaoded,cropped and stored according to the post operation configuration or in a temporary storage (in this case the Location header contains where the image is stored)

400

Some field or header is missing or has invalid value.

curl -v -H "X-Imager-Key: YOUR_API_KEY" 'https://api.imager200.io/crop?x0=100&y0=150&x1=350&y1=400&url=http://api-docs.imager200.io/images/examples/jpeg_image.jpg'
{
  "message": "Invalid parameters",
  "details": "Invalid x0 value",
  "requestId": "95158dd31d304bc5925af8cf673c5596"
}

Original

Processed

/equalize/sync Edit

Performs histogram equalization to improve image contrast

Supported image types: jpeg, png, bmp

Payload
image

image as bytes

Headers
Content-Type

application/x-www-form-urlencoded

Response Statuses
200

The histogram equalization will be performed and the image will returned in the response body.

400

invalid image format.

curl -v -o equalize_example.jpeg -H "X-Imager-Key: YOUR_API_KEY" --data-binary @jpeg_image.jpg 'https://api.imager200.io/equalize/sync'
{
  "message": "Invalid parameters",
  "details": "unsupported image type",
  "requestId": "95158dd31d304bc5925af8cf673c5596"
}

Original

Processed

/equalize Edit

Performs histogram equalization to improve image contrast asynchronously.

Supported image types: jpeg, png, bmp

Payload
image

image as bytes

Headers
Content-Type

application/x-www-form-urlencoded

Response Statuses
201

The histogram equalization will be performed and the image will be stored according to the post operation configuration or in a temporary storage (in this case the Location header contains where the image is stored)

400

invalid image format.

curl -v -H "X-Imager-Key: YOUR_API_KEY" --data-binary @jpeg_image.jpg 'https://api.imager200.io/equalize'
{
  "message": "Invalid parameters",
  "details": "unsupported image type",
  "requestId": "95158dd31d304bc5925af8cf673c5596"
}

Original

Processed

/equalize/sync Edit

Performs histogram equalization to improve the remote image

Supported image types: jpeg, png, bmp

Query Parameters
url

required url of the image to download.

Headers
Content-Type

application/x-www-form-urlencoded

Response Statuses
200

The histogram equalization will be performed on the downloaded image and it will returned in the response body

400

invalid image format.

curl -v -o equalize_example.jpeg -H "X-Imager-Key: YOUR_API_KEY" 'https://api.imager200.io/equalize/sync?url=http://api-docs.imager200.io/images/examples/jpeg_image.jpg'
{
  "message": "Invalid parameters",
  "details": "unsupported image type",
  "requestId": "95158dd31d304bc5925af8cf673c5596"
}

Original

Processed

/equalize Edit

Performs histogram equalization to improve the remote image contrast asyncronously.

Supported image types: jpeg, png, bmp

Query Parameters
url

required url of the image to download.

Headers
Content-Type

application/x-www-form-urlencoded

Response Statuses
201

The histogram equalization will be performed on the downloaded image and it will be stored according to the post operation configuration or in a temporary storage (in this case the Location header contains where the image is stored)

400

invalid image format.

curl -v -H "X-Imager-Key: YOUR_API_KEY" 'https://api.imager200.io/equalize?url=http://api-docs.imager200.io/images/examples/jpeg_image.jpg'
{
  "message": "Invalid parameters",
  "details": "unsupported image type",
  "requestId": "95158dd31d304bc5925af8cf673c5596"
}

Original

Processed

/grayscale/sync Edit

Transforms colors in an image to grayscale.

Supported image types: jpeg, png, bmp, gif

Payload
image

image as bytes

Headers
Content-Type

application/x-www-form-urlencoded

Response Statuses
200

The grayscale will be applied and the image will returned in the response body.

400

invalid image format.

curl -v -o grayscale_example.jpeg -H "X-Imager-Key: YOUR_API_KEY" --data-binary @jpeg_image.jpg 'https://api.imager200.io/grayscale/sync'
{
  "message": "Invalid parameters",
  "details": "unsupported image type",
  "requestId": "95158dd31d304bc5925af8cf673c5596"
}

Original

Processed

/grayscale Edit

Transforms colors in an image to grayscale asynchronously.

Supported image types: jpeg, png, bmp, gif

Payload
image

image as bytes

Headers
Content-Type

application/x-www-form-urlencoded

Response Statuses
201

The grayscale will be applied and the image will returned in the response body.

400

invalid image format.

curl -v -H "X-Imager-Key: YOUR_API_KEY" --data-binary @jpeg_image.jpg 'https://api.imager200.io/grayscale'
{
  "message": "Invalid parameters",
  "details": "unsupported image type",
  "requestId": "95158dd31d304bc5925af8cf673c5596"
}

Original

Processed

/grayscale/sync Edit

Transforms colors in the downloaded image to grayscale.

Supported image types: jpeg, png, bmp, gif

Query Parameters
url

required url of the image to download.

Response Statuses
200

The image will be downloaded, grayscale applied and returned in the response body.

400

invalid image format.

curl -v -o grayscale_example.jpeg -H "X-Imager-Key: YOUR_API_KEY" 'https://api.imager200.io/grayscale/sync?url=http://api-docs.imager200.io/images/examples/jpeg_image.jpg'
{
  "message": "Invalid parameters",
  "details": "unsupported image type",
  "requestId": "95158dd31d304bc5925af8cf673c5596"
}

Original

Processed

/grayscale Edit

Transforms colors in the downloaded image to grayscale asynchronously.

Supported image types: jpeg, png, bmp, gif

Query Parameters
url

required url of the image to download.

Response Statuses
201

The image will be downloaded, grayscale applied and it will be stored according to the post operation configuration or in a temporary storage (in this case the Location header contains where the image is stored)

400

invalid image format.

curl -v -H "X-Imager-Key: YOUR_API_KEY" 'https://api.imager200.io/grayscale?url=http://api-docs.imager200.io/images/examples/jpeg_image.jpg'
{
  "message": "Invalid parameters",
  "details": "unsupported image type",
  "requestId": "95158dd31d304bc5925af8cf673c5596"
}

Original

Processed

/resize/sync Edit

Resizes an image

Supported image types: jpeg, png, bmp, gif

Query Parameters
height

integer value that defines the new height of the image in pixels. Image size limits are specified in the limits section

width

integer value that defines the new width of the image in pixels. Image size limits are specified in the limits section

resampling_algorithm

optional value. It allows changing the resampling algorithm used when resizing (resampling) the image. The supported values are: lanczos (default), linear, box, nearest_neighbor, catmull_rom. More details can found in the changelog post.

Payload
image

image as bytes

Headers
Content-Type

application/x-www-form-urlencoded

Response Statuses
200

The image will be resized and returned in the response body.

400

Some field or header is missing or has invalid value.

curl -v -o resize_example.jpeg -H "X-Imager-Key: YOUR_API_KEY" --data-binary @jpeg_image.jpg 'https://api.imager200.io/resize/sync?width=300&height=150'
{
  "message": "Invalid parameters",
  "details": "invalid height value",
  "requestId": "95158dd31d304bc5925af8cf673c5596"
}

/resize Edit

Resizes an image

Supported image types: jpeg, png, bmp, gif

Query Parameters
height

integer value that defines the new height of the image in pixels. Image size limits are specified in the limits section

width

integer value that defines the new width of the image in pixels. Image size limits are specified in the limits section

resampling_algorithm

optional value. It allows changing the resampling algorithm used when resizing (resampling) the image. The supported values are: lanczos (default), linear, box, nearest_neighbor, catmull_rom. More details can found in the changelog post.

Payload
image

image as bytes

Headers
Content-Type

application/x-www-form-urlencoded

Response Statuses
201

The image will be resized and stored according to the post operation configuration or in a temporary storage (in this case the Location header contains where the image is stored)

400

Some field or header is missing or has invalid value.

curl -v -H "X-Imager-Key: YOUR_API_KEY" --data-binary @jpeg_image.jpg 'https://api.imager200.io/resize?width=300&height=150'
{
  "message": "Invalid parameters",
  "details": "invalid height value",
  "requestId": "95158dd31d304bc5925af8cf673c5596"
}

/resize/sync Edit

Resizes a remote image

Supported image types: jpeg, png, bmp, gif

Query Parameters
height

integer value that defines the new height of the image in pixels. Image size limits are specified in the limits section

width

integer value that defines the new width of the image in pixels. Image size limits are specified in the limits section

url

required url of the image to download.

resampling_algorithm

optional value. It allows changing the resampling algorithm used when resizing (resampling) the image. The supported values are: lanczos (default), linear, box, nearest_neighbor, catmull_rom. More details can found in the changelog post.

Response Statuses
200

The image will be downloaded, resized, and returned in the response body.

400

Some field or header is missing or has invalid value.

curl -v -o resize_example.jpeg -H "X-Imager-Key: YOUR_API_KEY" 'https://api.imager200.io/resize/sync?width=300&height=150&url=http://api-docs.imager200.io/images/examples/jpeg_image.jpg'
{
  "message": "Invalid parameters",
  "details": "invalid height value",
  "requestId": "95158dd31d304bc5925af8cf673c5596"
}

/resize Edit

Resizes a remote image

Supported image types: jpeg, png, bmp, gif

Query Parameters
height

integer value that defines the new height of the image in pixels. Image size limits are specified in the limits section

width

integer value that defines the new width of the image in pixels. Image size limits are specified in the limits section

url

required url of the image to download.

Response Statuses
201

The image will be resized and stored according to the post operation configuration or in a temporary storage (in this case the Location header contains where the image is stored)

400

Some field or header is missing or has invalid value.

resampling_algorithm

optional value. It allows changing the resampling algorithm used when resizing (resampling) the image. The supported values are: lanczos (default), linear, box, nearest_neighbor, catmull_rom. More details can found in the changelog post.

curl -v -H "X-Imager-Key: YOUR_API_KEY" 'https://api.imager200.io/resize?width=300&height=150&url=http://api-docs.imager200.io/images/examples/jpeg_image.jpg'
{
  "message": "Invalid parameters",
  "details": "invalid height value",
  "requestId": "95158dd31d304bc5925af8cf673c5596"
}

/rotate/sync Edit

Rotates an image according to the provided angle.

Supported image types: jpeg, png, bmp, gif

Query Parameters
angle

decimal value that defines the rotation angle in degrees. Should be between 0 and 360. Default value: 90

backgroundColor

the color that should be used to fill the empty surfaces after rotating the image. Must be a valid color name (supported names are specified here https://www.w3schools.com/colors/colors_names.asp) or hexadecimal code without the trailing #.(e.g 000000). Default value: white

Payload
image

image as bytes

Headers
Content-Type

application/x-www-form-urlencoded

Response Statuses
200

The image will be rotated and returned in the response body.

400

Some field or header is missing or has invalid value.

curl -v -o rotate_example.jpeg -H "X-Imager-Key: YOUR_API_KEY" --data-binary @jpeg_image.jpg 'https://api.imager200.io/rotate/sync?angle=70'
{
  "message": "Invalid parameters",
  "details": "invalid angle value",
  "requestId": "95158dd31d304bc5925af8cf673c5596"
}

Original

Processed

/rotate Edit

Rotates an image according to the provided angle asynchronously.

Supported image types: jpeg, png, bmp, gif

Query Parameters
angle

decimal value that defines the rotation angle in degrees. Should be between 0 and 360. Default value: 90

backgroundColor

the color that should be used to fill the empty surfaces after rotating the image. Must be a valid color name (supported names are specified here https://www.w3schools.com/colors/colors_names.asp) or hexadecimal code without the trailing #.(e.g 000000). Default value: white

Payload
image

image as bytes

Headers
Content-Type

application/x-www-form-urlencoded

Response Statuses
201

The image will be rotated and stored according to the post operation configuration or in a temporary storage (in this case the Location header contains where the image is stored).

400

Some field or header is missing or has invalid value.

curl -v -H "X-Imager-Key: YOUR_API_KEY" --data-binary @jpeg_image.jpg 'https://api.imager200.io/rotate?angle=70'
{
  "message": "Invalid parameters",
  "details": "invalid angle value",
  "requestId": "95158dd31d304bc5925af8cf673c5596"
}

Original

Processed

/rotate/sync Edit

Rotates a remote image image according to the provided angle.

Supported image types: jpeg, png, bmp, gif

Query Parameters
angle

decimal value that defines the rotation angle in degrees. Should be between 0 and 360. Default value: 90

url

required url of the image to download.

backgroundColor

the color that should be used to fill the empty surfaces after rotating the image. Must be a valid color name (supported names are specified here https://www.w3schools.com/colors/colors_names.asp) or hexadecimal code without the trailing #.(e.g 000000). Default value: white

Payload
image

image as bytes

Headers
Content-Type

application/x-www-form-urlencoded

Response Statuses
201

The image will be downloaded, rotated and returned in the response body.

400

Some field or header is missing or has invalid value.

curl -v -o rotate_example.jpeg -H "X-Imager-Key: YOUR_API_KEY" 'https://api.imager200.io/rotate/sync?angle=70&url=http://api-docs.imager200.io/images/examples/jpeg_image.jpg'
{
  "message": "Invalid parameters",
  "details": "invalid angle value",
  "requestId": "95158dd31d304bc5925af8cf673c5596"
}

Original

Processed

/rotate Edit

Rotates a remote image according to the provided angle asynchronously.

Supported image types: jpeg, png, bmp, gif

Query Parameters
angle

decimal value that defines the rotation angle in degrees. Should be between 0 and 360. Default value: 90

url

required url of the image to download.

backgroundColor

the color that should be used to fill the empty surfaces after rotating the image. Must be a valid color name (supported names are specified here https://www.w3schools.com/colors/colors_names.asp) or hexadecimal code without the trailing #.(e.g 000000). Default value: white

Payload
image

image as bytes

Headers
Content-Type

application/x-www-form-urlencoded

Response Statuses
201

The image will be downloaded, rotated and stored according to the post operation configuration or in a temporary storage (in this case the Location header contains where the image is stored).

400

Some field or header is missing or has invalid value.

curl -v -H "X-Imager-Key: YOUR_API_KEY" 'https://api.imager200.io/rotate?angle=70&url=http://api-docs.imager200.io/images/examples/jpeg_image.jpg'
{
  "message": "Invalid parameters",
  "details": "invalid angle value",
  "requestId": "95158dd31d304bc5925af8cf673c5596"
}

Original

Processed

/text/sync Edit

Adds text over an image.

Supported image types: jpeg, png, bmp, gif

Query Parameters
text

the text to be added. If it contains spaces or special charachters, it must be url encoded. Required.

x

optional integer value that defines the x coordinate in pixels of the point where the text will be added. Default value is 50

y

optional integer value that defines the y coordinate in pixels of the point where the text will be added. Default value is 50

size

optional integer value that defines the text size in pixels. Default value is 12.

fontName

optional value that defines the font type name. Default value is calibri. Possible values can be found here. (More fonts can be added on request)

color

optional value that defines the color of the text. Must be a valid color name (supported names are specified here https://www.w3schools.com/colors/colors_names.asp) or hexadecimal code without the trailing #.(e.g 000000). Default value is black.

Payload
image

image as bytes

Headers
Content-Type

application/x-www-form-urlencoded

Response Statuses
200

Text will be added to the image, and it will be returned in the response body.

400

Some field or header is missing or has invalid value.

curl -v -o text_example.jpeg -H "X-Imager-Key: YOUR_API_KEY" --data-binary @jpeg_image.jpg 'https://api.imager200.io/text/sync?text=BEACH&size=40&color=green&font=chinesetakeaway'
{
  "message": "Invalid parameters",
  "details": "invalid color value",
  "requestId": "95158dd31d304bc5925af8cf673c5596"
}

Original

Processed

/text Edit

Adds text over an image asynchronously.

Supported image types: jpeg, png, bmp, gif

Query Parameters
text

the text to be added. If it contains spaces or special charachters, it must be url encoded. Required.

x

optional integer value that defines the x coordinate in pixels of the point where the text will be added. Default value is 50

y

optional integer value that defines the y coordinate in pixels of the point where the text will be added. Default value is 50

size

optional integer value that defines the text size in pixels. Default value is 12.

fontName

optional value that defines the font type name. Default value is calibri. Possible values can be found here. (More fonts can be added on request)

color

optional value that defines the color of the text. Must be a valid color name (supported names are specified here https://www.w3schools.com/colors/colors_names.asp) or hexadecimal code without the trailing #.(e.g 000000). Default value is black.

Payload
image

image as bytes

Headers
Content-Type

application/x-www-form-urlencoded

Response Statuses
201

Text will be added to the image, and it will be stored according to the post operation configuration or in a temporary storage (in this case the Location header contains where the image is stored).

400

Some field or header is missing or has invalid value.

curl -v -H "X-Imager-Key: YOUR_API_KEY" --data-binary @jpeg_image.jpg 'https://api.imager200.io/text?text=BEACH&size=40&color=green&font=chinesetakeaway'
{
  "message": "Invalid parameters",
  "details": "invalid color value",
  "requestId": "95158dd31d304bc5925af8cf673c5596"
}

Original

Processed

/text/sync Edit

Adds text over a remote image.

Supported image types: jpeg, png, bmp, gif

Query Parameters
text

the text to be added. If it contains spaces or special charachters, it must be url encoded. Required.

x

optional integer value that defines the x coordinate in pixels of the point where the text will be added. Default value is 50

y

optional integer value that defines the y coordinate in pixels of the point where the text will be added. Default value is 50

size

optional integer value that defines the text size in pixels. Default value is 12.

fontName

optional value that defines the font type name. Default value is calibri. Possible values can be found here. (More fonts can be added on request)

color

optional value that defines the color of the text. Must be a valid color name (supported names are specified here https://www.w3schools.com/colors/colors_names.asp) or hexadecimal code without the trailing #.(e.g 000000). Default value is black.

url

required url of the image to download.

Response Statuses
200

Text will be added to the image, and it will be returned in the response body.

400

Some field or header is missing or has invalid value.

curl -v -o text_example.jpeg -H "X-Imager-Key: YOUR_API_KEY" 'https://api.imager200.io/text/sync?text=BEACH&size=40&color=green&font=chinesetakeaway&url=http://api-docs.imager200.io/images/examples/jpeg_image.jpg'
{
  "message": "Invalid parameters",
  "details": "invalid color value",
  "requestId": "95158dd31d304bc5925af8cf673c5596"
}

Original

Processed

/text Edit

Adds text over a remote image asynchronously.

Supported image types: jpeg, png, bmp, gif

Query Parameters
text

the text to be added. If it contains spaces or special charachters, it must be url encoded. Required.

x

optional integer value that defines the x coordinate in pixels of the point where the text will be added. Default value is 50

y

optional integer value that defines the y coordinate in pixels of the point where the text will be added. Default value is 50

size

optional integer value that defines the text size in pixels. Default value is 12.

fontName

optional value that defines the font type name. Default value is calibri. Possible values can be found here. (More fonts can be added on request)

color

optional value that defines the color of the text. Must be a valid color name (supported names are specified here https://www.w3schools.com/colors/colors_names.asp) or hexadecimal code without the trailing #.(e.g 000000). Default value is black.

url

required url of the image to download.

Response Statuses
201

Text will be added to the image, and it will be stored according to the post operation configuration or in a temporary storage (in this case the Location header contains where the image is stored).

400

Some field or header is missing or has invalid value.

curl -v -H "X-Imager-Key: YOUR_API_KEY" 'https://api.imager200.io/text?text=BEACH&size=40&color=green&font=chinesetakeaway&url=http://api-docs.imager200.io/images/examples/jpeg_image.jpg'
{
  "message": "Invalid parameters",
  "details": "invalid color value",
  "requestId": "95158dd31d304bc5925af8cf673c5596"
}

Original

Processed