Captions

With "caption" parameter any image can be added as a caption to result image.

{
    "url": "https://deep-image.ai/api-example.png",
    "width": 600,
    "output_format": "jpg",
    "caption": {
        "url": "http://ain.teonite.net/neuroapi-store/2023-02-07/d9a91e2e-9843-4d85-ae1a-e7baefc87746.png",
        "position": "RB",
        "target_width_percentage": 25,
        "padding": 20,
        "opacity": 85
    }
}

Caption can has several options:

Parameter nameDescription

url

(required) - url to the caption image

position

(RB by default) - position of the caption expressed as two letters - LT, MT, RT, ML, MM, MR, BL, BM, BR (L - left, M - middle, R - right, B - bottom, T - top)

target_width_percentage

(25 by default) - size of the captioning expressed as percentage of width of destination image

padding

(5% of width by default) - space in pixels between image borders and the captioning

opacity

(100 by default) - opacity of the captioning from 0 to 100

The result of example image with added "Deep image" caption"

Last updated