> For the complete documentation index, see [llms.txt](https://docs.cloudimage.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.cloudimage.io/transformations/image-watermarking/text-watermark.md).
# Text watermark
If you need to tag an image or add a reference number as an overlay, use the text watermark function.
## Available parameters
| Parameter | Syntax | Description | | | | | |
| ------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | ----- | ------ | ------------------------- | ----------------------- | ------------------------------------------------- |
| use watermark | **wat=1** | **(required)** Activates the watermark function | | | | | |
| watermark text | **wat\_text=X** | **(required)** The text to be overlayed. Can be URL-encoded | | | | | |
| watermark gravity | wat\_gravity=X
X=\[north | south]\[east | west] | center |
absolute | relative
| Defines the position to "anchor" the watermark to |
| watermark padding | wat\_pad=X\[p]\[,Y\[p]]
X/Y=0..100\[p]
| Adds padding from the anchoring point in pixels (**X**) or in percent (**Xp**) | | | | | |
| watermark position | **wat\_pos=X\[,Y]** | sets the position in percent from the resized image; works only with
wat\_gravity=absolute and wat\_gravity=relative
| | | | | |
| watermark opacity | wat\_opacity=X
X=0..1
| Defines watermark opacity | | | | | |
| watermark font | **wat\_font=X** | Choose the font family for the overlay | | | | | |
| watermark color | **wat\_color=X** \| **wat\_colour=X** | Sets the text color | | | | | |
| watermark font size | **wat\_fontsize=X** \| **wat\_fontsize=Xmax** | Sets the font size. If the Xmax syntax is used, the size is reduced if the text cannot fit in the image | | | | | |
## Examples
| Preview | Syntax |
| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|  | [/samples.scaleflex.com/flat1.jpg?**w=550**&**wat=1**&**wat\_gravity=northeast**&**wat\_text=REF00189300B**&**wat\_pad=10**&**wat\_font=Arial-Black**&**wat\_fontsize=18**&**wat\_color=660000**](https://doc.cloudimg.io/https://samples.scaleflex.com/flat1.jpg?w=550\&wat=1\&wat_gravity=northeast\&wat_text=REF00189300B\&wat_pad=10\&wat_font=Arial-Black\&wat_fontsize=18\&wat_color=660000) |
|  | Text too long for the image:
/samples.scaleflex.com/flat1.jpg?w=400&wat=1&wat\_gravity=north&wat\_text=A%20VERY%20LONG%20TEXT%20WHICH%20WON%27T%20FIT&wat\_pad=10&wat\_font=Arial-Black&wat\_fontsize=20&wat\_color=000
|
|  | Text size limit set with wat\_fontsize=20max:
/samples.scaleflex.com/flat1.jpg?w=400&wat=1&wat\_gravity=north&wat\_text=A%20VERY%20LONG%20TEXT%20WHICH%20WON%27T%20FIT&wat\_pad=10&wat\_font=Arial-Black&wat\_fontsize=20max&wat\_color=000
|
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://docs.cloudimage.io/transformations/image-watermarking/text-watermark.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
