Text String `text`

Specifies a string to be rendered as text over the image.

Multiline text strings

Multiline text strings can be created adding line feed escape characters \n to the text string, splitting the text into multiple lines.

An example of a text string value with multiple lines is Line 1\nLine 2\nLine 3.

This is not required if you are specifying text dimensions with text-width and text-height parameters. In that case, text will be splitted on multiple lines automatically.

Text and JPEG

When rendering text using output format with jpeg it is possible to find some artifacts due to JPEG compression and differences in contrast between the text and background.

If you feel the resulting image can be improved try to increase quality to a higher value. For more extreme cases you can even disable chroma subsampling, setting subsample to 444 at the cost of a bigger file size.

For the following examples we use quality=90 and disabled chroma subsampling with subsample=444.

Examples

Simple use of text parameter with text=The five boxing wizards jump quickly.:

GET

https://assets.imglab-cdn.net/particles.jpeg?text=The+five+boxing+wizards+jump+quickly.

Rendering text over image with text parameter.

x px

Using explicit multiline text string with text=The five boxing\nwizards jump quickly.:

GET

https://assets.imglab-cdn.net/particles.jpeg?text=The+five+boxing%0Awizards+jump+quickly.

Rendering multiline text over image with text parameter including line feed escape characters.

x px

Using some tags to modify the previous multiline text string with text=The <s>five boxing</s>\nwizards jump quickly.:

GET

https://assets.imglab-cdn.net/particles.jpeg?text=The+%3Cs%3Efive+boxing%3C%2Fs%3E%0A%3Ci%3Ewizards%3C%2Fi%3E+%3Cb%3Ejump%3C%2Fb%3E+%3Cu%3Equickly%3C%2Fu%3E.