{"openapi":"3.0.0","info":{"description":"Image processing API.\n\n\n# errors\n\nThe API uses standard HTTP status codes to indicate the success or failure of the API call and extension of HTTP status codes to be more accurate in the error handling. \nIn case of error, the body of the response allows you to display a message to an end user, report the error to a support service, or process the error automatically in the invoking code. In some case, some technical errors will raise the structure inside de JSon global response.\n\nThe body of the response will be JSON in the following format:\n\n```\n{\n   \"error\": \"404/100\",\n   \"message\": \"Resource not found\",\n   \"error_uri\": \"https://club-wed.wedia-group.com:443/api/rest/errors#404/100\",\n   \"errorWithContact\": false,\n   \"errorSupportDetails\": [\n        {\n            \"value\": \"Wedia support email: support@wedia-group.com.\",\n            \"key\": \"WEDIA_ERROR_SUPPORT\",\n            \"params\": [\n                \"support@wedia-group.com\"\n            ]\n        }\n    ],\n   \"errtag\": 706\n}\n```\n\n## Properties\n\n* **error**: (string) an extended HTTP status code.This code is formed as the concatenation of the standard code and a specific code, both separated by a slash.\n\n Example: 404/100 (Resource type not found)\n \n* **message**: (string) a human readable message to show to end user\n\n Example: Resource not found.\n \n* **submessage**: (string, optional) a more specific human readable message for some errors\n\n* **errorSupportDetails**: (object) error details to allow automatic forwarding to a support email.\n  \n  Example :\n  ```json\n  [\n        {\n            \"value\": \"Wedia support email: support@wedia-group.com.\",\n            \"key\": \"WEDIA_ERROR_SUPPORT\",\n            \"params\": [\n                \"support@wedia-group.com\"\n            ]\n        }\n  ]\n  ```\n\n  This data will allow you to display standard localized message such as \"Send an email to <such an address>\", or allow to automatically send an email with the current error datas and other circumstantial data.\n\n  * **value**: string, a standard localized message provided by the server\n  * **key**: string, the key used by the server to create the message (client may by example use the same key with a specific resource bundle to define a client specific message)\n  * **params** array, the list of values used by the server to patch into the localized message (client may use by example these parameters to customized the message). By convention, the first one is always the support email.\n\n  The localized message contains some sequences to be patched with contextual parameters (a number in braces}.\n\n* **error_uri**: (string) uri of the error documentation (if any). \n\n By example : [https://club-wed.wedia-group.com:443/api/rest/errors#404/100](https://club-wed.wedia-group.com:443/api/rest/errors#404/100)\n \n* **errorWithContact**: (boolean) if true, the message invites user to contact a support or administration department \n* **errtag**: a number to help to find the corresponding message in log (to be communicated to a competent department).\n\n[See more about error handling](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/11928057/Error+Handling)\n\n[See error documentation](https://club-wed.wedia-group.com:443/api/rest/errors)\n\n\n# general parameters\n\n## Parameters common to all end points\n\nThese parameters can be used with any end point URIs:\n\n* `lang`\n\n  This parameter is used to override default preferences (user, browser&hellip;) localization language, set with header `Accept-Language`.\n\n  By example: `lang=en-US`\n\n* <span id='general-parameter-state'></span>`state`\n\n  The value of this parameter is returned as it is in the response. When the value is JSON, it is directly integrated into the JSON response structure. This information allows you to reconcile a response and a request. This is particularly useful if the client uses an asynchronous and centralized queue. Another case could be the possibility of ignoring obsolete responses. For example, in a search system, an impatient user could restart a new search and his answer could come back before the answer of the previous search. The state will let you know that the second answer is obsolete and no longer needs to be processed.  \n  To limit the load on response times, prefer to send an identifier (or short data structure) and manage an association map in the client to find the information that allows you to find the request (or the component that is supposed to process the response).\n\n  By example: `state=searchquery#a1fe37`\n \n## Localization\n\nBy default, the localization is based upon the web browser language locale. If the web browser has no locale, it uses header Accept-Language.\nIt is also possible to force a locale by using the request parameter lang. Its syntax is similar to the header. \nIf the requested language is not supported the service will respond NOT_ACCEPTABLE.\n\n## HTTP methods\n\nIn some cases (particularly when the server is not configured to do so), it is not possible to use methods other than GET, HEAD or POST.\nThen we could override the method. The end point should be called with the POST method and the name of the actual method should be set in a specific header.\nThe supported standard headers for method overriding are:\n\n* X-HTTP-Method-Override (Google/GData HTTP method overwriting)\n\n* X-HTTP-Method (Microsoft HTTP method overwriting)\n\n* X-METHOD-OVERRIDE (IBM HTTP method overwriting)\n\n\n# image transform\n\nThe imaging API will allow you to transform images while downloading them. The value of the parameter `transform` is a command set: this is the list of commands and their parameters to be chained to obtain the final image.\n\nExamples:\n\n* Example 1 - Cropping\n```HTML \nx_80,y_80,w_135,h_65,c_crop\n```\n| Input: Boat in clear blue ocean, W400&times;H267 | Output: Boat in clear blue ocean, W135&times;H65 |\n|:------:|:------:|\n|![Boat in clear blue ocean: W400&times;H267](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/boat-in-clear-blue-ocean.jpg)|![Boat in clear blue ocean: W135&times;H65](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/boat-in-clear-blue-ocean_jpg_'x_80,y_80,w_135,h_65,c_crop'.jpg)\n\n* Example 2 - Liquid resizing \n```HTML \n w_proportional,h_50p,c_lresize\n```\n| Input: Madivaru finolhu, Maldives, W320&times;H400 | Output: Madivaru finolhu, Maldives, W160&times;H200 | To compare to resize output `w_proportional,h_50p,c_resize` |\n|:------:|:------:|:------:|\n|![Madivaru finolhu, Maldives: W320&times;H400](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/island.jpg)|![Madivaru finolhu, Maldives: W160&times;H200](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/island_jpg_'w_proportional,h_50p,c_lresize'.jpg)|![Madivaru finolhu, Maldives: W160&times;H200 (resized)](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/island_jpg_'w_proportional,h_50p,c_resize'.jpg)|\n\n&#x26a0;The possibilities of imaging can be restricted according to imaging policies and the types of resources.\n\n[Find out more on Imaging REST API](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/379912195/Imaging+downloading+and+applying+image+transformations#commands)\n\n## Command set\n\nThe command set is defined by a comma separated list of parameters and commands. Spaces are not allowed except in the texts, between double-quotes (see below).\n\n### parameter or command\n\nA parameter is a prefix (one or two letters) followed by an underscore then by a value.  \nThe prefix defines the type of value:\n* `c` for a command name\n* other (see below) for a parameter (`w` by example for width)\n\n### switches \n\nThis is a boolean parameter, can be set (enabled) or unset (disabled). This is a name without underscore and prefixed with `+` or `-` (default if not prefixed is `+`).\n\nBy example: `+fixed`\n\n### command set\n\nEach command is preceded by its parameters.\n\n* Example (resize image to 100&times;100 pixels)\n```HTML\nw_100,h_100,c_resize\n\nSeveral commands can be linked in succession. Each command processes the result of the previous command.\n\n* Example (resize image to 100&times;100 pixels, then add a border around the new image)\n```HTML\nw_100,h_100,c_resize,bd_40,bg_sandybrown,c_pad\n```\n\n## Values\n\nThe syntax for the values follows the following rules:\n\n* dimension value  \n\n   Defines a dimension (x, y, width, height, top, right, bottom or left) in pixels. It could be absolute or relative to the size of the image.\n   \n  * a positive number means an absolute size in pixels\n    ```HTML\n    w_100,h_100\n    ```\n  * a positive number followed by px means an absolute size in pixels\n    ```HTML\n    w_100px,h_100px\n    ```\n  * a positive number followed by `f` (or `&times;`) means a factor\n    ```HTML \n    w_2f,h_0.5&times;\n    ```\n    means double width and halved height    \n  * a number followed by `p` (or `%`) means a percentage\n    ```HTML \n    w_200p,h_50%\n    ```\n  * the word `proportional` could be used as value in some commands (you can use also the number `-1`) \n  \n* size value\n\n   Defines a dimension in different units. The same values as used for dimension value could be used, and the followed additional syntaxes:\n\n  * a number followed by mm means a size in millimeters.\n    ```HTML \n    w_50mm\n    ```\n  * a number followed by a quote means a size in inches.\n    ```HTML \n    w_50'\n    ```\n  * a number followed by `pt` means a size in points.\n    ```HTML \n    w_72pt\n    ```\n    \n* factor value\n\n  * a positive number means a factor: the final size will be the original size multiplied by the factor\n    ```HTML \n    w_2,h_0.5\n    ```\n    means doubled width and halved height.\n\n  * a number followed by `f` (or `&times;`) means a factor    \n    ```HTML \n    w_2f,h_0.5&times;\n    ```\n    means doubled width and halved height.\n    \n  * a number followed by `p` (or `%`) means a percentage\n    ```HTML \n    w_200p,h_50%\n    ```\n* angle value\n\n  Defines an angle value, in degrees by default.\n  \n  * a number means a value in degrees  \n    ```HTML \n    a_-45,c_rotate\n    ```\n  * a number followed by `°` or `deg` means an angle in degrees\n    ```HTML \n    a_-45°,c_rotate\n    ```\n    ```HTML \n    a_-45deg,c_rotate\n    ```\n  * a number followed by `rad` means an angle in radians    \n    ```HTML \n    a_3.14rad,c_rotate\n    ```\n  * a number followed by `pi`, (or `%` or `&#960;`) means pi multiplied by the value    \n    ```HTML \n    a_1.5pi,c_rotate\n    ```\n    means <span><sup>3</sup>&#8725;<sub>2</sub></span> &times; &#960;\n  * an integer followed by `>`, (or `right`) means a clockwise 90 degrees rotation (number 1 may be omitted)\n    ```HTML \n    a_2>,c_rotate\n    ```\n    ```HTML \n    a_right,c_rotate\n    ```\n  * an integer followed by `<`, (or `left`) means a counterclockwise 90 degrees rotation (number 1 may be omitted)  \n    ```HTML \n    a_<,c_rotate\n    ```\n    ```HTML \n    a_2left,c_rotate\n    ```\n* color value\n\n  * html color name\n    ```HTML \n    bg_red\n    ```\n  * gray level\n    ```HTML \n    bg_gray50\n    ```\n  * hexadecimal RGB code\n    ```HTML \n    bg_#FF0000\n    ```\n  * transparent color\n    ```HTML \n    bg_none\n    ```\n  * a string starting with $dom to specify the dominant color of the image. It can be followed with the index of the dominant color.\n  \n    * $dom means the first dominant color\n    * $dom2 means the second dominant color\n    * $dom2-1 means the second dominant color, skipping the first one\n    \n    ```HTML \n    bg_$dom\n    ```\n    \n  * a string starting with $gradient:, followed with the starting and the ending colors, separated by a dash, to specified a vertical gradient.\n  \n    ```HTML \n    bg_$gradient:red-blue\n    ```\n    \n    * You can specify an extent with a dimension value:\n      ```HTML \n      fg_$gradient:red-blue-50%\n      ```\n    * No color value means none:\n      ```HTML \n      fg_$gradient:red\n      ```\n      is equivalent to \n      ```HTML \n      fg_$gradient:red-none\n      ```\n    * a string starting with $pattern:, followed with the name of a pattern, to specified a pattern.    \n      ```HTML \n      bg_pattern:checkerboard\n      ```\n    * the string $blur, or a string starting with $blur: followed with blur parameters, to specify a blur of the background image.\n    \n      * blur parameters: It’s two positive integers separated with an x. The first is radius and the second sigma.\n        ```HTML \n        bg_$blur:25x25\n        ```\n      * `$blur` is equivalent to `$blur:3x3`\n      \n* density value\n\n  Define the density in dpi (Dot Per Inches).\n  \n  * a positive number means an absolute size in pixels\n    ```HTML\n    hv_72,vv_72\n    ```\n      \n* font description\n\n  Selects a font (the font must be installed in the server), with a font name , a font size (cf \"size value\"), font styles (bold, italic&#8230;).\n\n  * a string, with component separated with a pipe\n    ```HTML \n    f_Arial\n    ```  \n    ```HTML \n    f_Arial|16pt\n    ```\n    ```HTML \n    f_Candice|20%|bold\n    ```\n    ```HTML \n    f_Candice|bold|italic\n    ```\n  * a number, as size in point  \n    ```HTML \n    f_24\n    ``` \n  * Font styles are a combination of different parameters:\n    * style:\n      * Italic\n      * Oblique\n    * weight:\n      * Thin\n      * ExtraLight\n      * Light\n      * Medium\n      * DemiBold        \n      * Bold\n      * ExtraBold\n      * Heavy\n    * stretch:\n      * Condensed\n      * Expanded\n      * ExtraCondensed\n      * ExtraExpanded\n      * SemiCondensed\n      * UltraCondenses\n      * UltraExpanded \n       \n  * Text decoration parameter     \n      \n    Specifies a text decoration, one of these values:\n\n    * None\n    * Underline\n    * LineThrough\n    * Overline\n  \n* gravity value   \n\n  Specifies a location in the image, like in this grid:\n  <table>\n<tr><td align='center'>northwest</td><td align='center'>north</td><td align='center'>northeast</td></tr>\n<tr><td align='center'>west</td><td align='center'>center</td><td align='center'>east</td></tr>\n<tr><td align='center'>southwest</td><td align='center'>south</td><td align='center'>southeast</td></tr>\n</table>\n\n  Gravity often can be mixed with a location by coordinates (x and y):\n\n    * if both coordinates are provided, gravity value is ignored\n    * if only one of the two is provided, gravity is used to locate on other axis\n                       \n* preset name\n\n  Specifies the name of a preset\n  \n    ```HTML \n    n_circle_png\n    ``` \n  \n* shade parameter\n\n  It’s two positive integers (angles in degrees) separated with an x. The first is direction and the second elevation, of a light source.\n\n    ```HTML \n    sh_45x90\n    ```\n  \n* string value\n\n  A simple text or word\n  \n    ```HTML \n    tx_hello!\n    ```\n\n * Simple text (without spaces or special characters)\n```HTML\ntx_hello\n```\n * To specify text with spaces, or other special characters, embrace it between double-quotes\n```HTML\ntx_\"hello you!\"\n```\n * You can put double-quotes within text by duplicate them (escape double-quotes)  \n```HTML\ntx_\"say \"\"hello\"\"!\"`\n```\n * Use antislash \\ to escape special characters, like \\n for carriage return. Use two of them to get an antislash: \\\\n means exactly \\n, not carriage return.\n```HTML\ntx_\"First line\\nSecond line with \\\\n\"\n```\nto get\n>```HTML\n>first line\n>second line with \\n\n>```\n * You can use \\u followed by unicode codepoint (four hexadecimal digits mandatory) to specify special characters\n```HTML\ntx_\"\\u00a9xxx\"\n```\nto get `©xxx`.\n\n## Commands\n\n### autoorient\n\nResets EXIF image profile setting 'Orientation' and then performs the appropriate 90 degree rotation on the image to orient the image, for correct viewing.\n\nNo parameters.\n\nExample:\n\n```HTML \nc_autoorient\n```    \n### background\n\nFills the transparent background of the image with the specified color.\n\nParameters:\n\n* prefix `bg`: a **color value**, default value is `none`.  \n \n  Specifies the background filling color. *Blur* type color is not allowed in this context.\n  \nExamples:     \n* Example 1 - Fill background with a color\n```HTML \nbg_dodgerblue,c_background\n```    \n* Example 2 - Fill background with a pattern\n```HTML \nbg_$pattern:checkerboard,c_background\n```    \n* Example 3 - Fill background with a gradient\n```HTML \nbg_$gradient:-aquamarine,c_background\n```\n* Example 4 - Fill background with a sized gradient\n```HTML \nbg_$gradient:dodgerblue-aquamarine-80p,c_background    \n```    \n\n### clip\n\nFills with a color the area delimited by a clipping path contained in the image\n\nParameters:\n\n* prefix `bg`: a **color value**, default value is `none`.  \n \n  Specifies the background filling color.\n  \n* prefix `cp`: a path name, or an index (# followed by the position from 1 to n), default is `#1` \n \n  Specifies the clipping path to use \n  \n* switch `outside`: to choose whether to fill the inside or the outside of the path, default is true (ie outside)\n  \n* prefix `cl`: a colorization factor\n\n  specifies the percentage by which the fill color is blended with the background\n\nExamples:     \n* Example 1 - Clip and fill with a color\n```HTML \nbg_dodgerblue,c_clip\n```    \n| Input: Flamingo, W2983&times;H3977 | Output: Flamingo, W2983&times;H3977 |\n|:------:|:------:|\n|![Flamingo: W2983&times;H3977](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/flamingo.jpg)|![Flamingo: W2983&times;H3977](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/flamingo_jpg_'bg_dodgerblue,c_clip'.jpg)\n\n* Example 2 - Clip along a named clipping path\n```HTML \nbg_$gradient:DarkBlue-Turquoise,n_Flamingo,c_clip\n```\n| Input: Flamingo, W2983&times;H3977 | Output: Flamingo, W2983&times;H3977 |\n|:------:|:------:|\n|![Flamingo: W2983&times;H3977](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/flamingo.jpg)|![Flamingo: W2983&times;H3977](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/flamingo_jpg_'bg_$gradient_DarkBlue-Turquoise,n_Flamingo,c_clip'.jpg)\n\n* Example 3 - Clip with half blending\n```HTML \nbg_red,cl_50,c_clip\n```\n| Input: Flamingo, W2983&times;H3977 | Output: Flamingo, W2983&times;H3977 |\n|:------:|:------:|\n|![Flamingo: W2983&times;H3977](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/flamingo.jpg)|![Flamingo: W2983&times;H3977](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/flamingo_jpg_'bg_red,cl_50,c_clip'.jpg)\n\n### crop\n\nCrop a subimage from the image, and optionally layout the subimage into the crop box. The coordinates of the cropping box can be absolute or relative to the image, in location, as well as in size, and can be specified as Cartesian absolute coordinates or CSS relative position (top, right, bottom, left), but not at the same time.               \n\nParameters:\n\n* Cartesian coordinates\n\n  Default mode.\n\n  * prefix `x`: a **dimension value**, default value is 0  \n\n    The x (easting) of the top-left corner of the cropping box              \n  \n  * prefix `y`: a **dimension value**, default value is 0\n\n    The y (northing) of the top-left corner of the cropping box\n  \n  * prefix `w`: a **dimension value**, default value is 100%\n\n    The width of the cropping box\n\n  * prefix `h`: a **dimension value**, default value is 100%\n\n    the width of the cropping box\n \n* CSS top, right, bottom, left\n\n Coordinates not mentioned are deducted from the values mentioned. If none of them are, you have to switch to Cartesian mode.  \n If only one of them is mentioned, all have the same value. If two of them are, the others are deducted first in relation to their axis (vertical or horizontal).\n   \n * prefix `t`: a **dimension value**\n \n   the top inset    \n  \n * prefix `r`: a **dimension value**\n \n   the right inset   \n  \n * prefix `b`: a **dimension value**\n \n   the bottom inset   \n  \n * prefix `l`: a **dimension value**\n \n   the left inset   \n     \n* switch `centered`: to set or not the centered mode (not set by default)\n \n  If set, moves the bounding box top left corner coordinates (x and y) to center of bounding box. This moves the reference for Cartesian coordinates. \n \n* switch `fixed`: to set or not the fixed mode (not set by default)\n \n  In this mode, the resulting image always has the size of the cropping box, or the fixed size bounding box, if specified\n \n  * prefix `fw`: a **dimension value**\n   \n    width of the fixed size bounding box\n      \n  * prefix `fh`: a **dimension value**\n   \n    height of the fixed size bounding box\n   \n  * prefix `ly` layout type (location of the cropped image into the result image, in case of overflowing cropping). Default is **none**.\n   \n    * **none**: no layout;\n    * **center**: the resulting image is centered in the cropping box;\n    * **tile**: the resulting image is a tile (the image is cut into tiles according to a regular grid) \n    * **fit**: the resulting image fits the cropping box\n    * **fill**: the resulting image fills the cropping box\n    * **lresize**: the resulting image fills the cropping box with seam carving algorithm \n   \n  If only one of `fw` or `fh` only is set, both will have the same value.\n\n\nExamples:     \n* Example 1 - Simple border cropping (Removes 20% around the image)\n```HTML \nt_20p,c_crop\n```  \n| Input: Maldives, W400&times;H225 | Output: Maldives, W320&times;H180 |\n|:------:|:------:|\n|![Maldives: W400&times;H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: W320&times;H180](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'t_20p,c_crop'.jpg)\n\n* Example 2 - Box cropping\n```HTML \nx_80,y_80,w_135,h_65,c_crop\n```\n| Input: Boat in clear blue ocean, W400&times;H267 | Output: Boat in clear blue ocean, W135&times;H65 |\n|:------:|:------:|\n|![Boat in clear blue ocean: W400&times;H267](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/boat-in-clear-blue-ocean.jpg)|![Boat in clear blue ocean: W135&times;H65](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/boat-in-clear-blue-ocean_jpg_'x_80,y_80,w_135,h_65,c_crop'.jpg)\n\n* Example 3 - Focus crop, no layout, no fixed size\n```HTML \nx_0,y_0,w_200,h_150,centered,c_crop\n```\n| Input: Iceland, W300&times;H409 | Output: Iceland, W200&times;H150|\n|:------:|:------:|\n|![Iceland: W300&times;H409](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/iceland.jpg)|![Iceland: W200&times;H150](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/iceland_jpg_'x_0,y_0,w_200,h_150,centered,c_crop'.jpg)\n\n* Example 4 - Focus crop, no layout, fixed size\n```HTML \nx_0,y_0,w_200,h_150,centered,fixed,c_crop\n```\n| Input: Iceland, W300&times;H409 | Output: Iceland, W100&times;H75|\n|:------:|:------:|\n|![Iceland: W300&times;H409](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/iceland.jpg)|![Iceland: W100&times;H75](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/iceland_jpg_'x_0,y_0,w_200,h_150,centered,fixed,c_crop'.jpg)\n\n* Example 5 - Focus crop, tile layout, fixed size\n```HTML \nx_0,y_0,w_200,h_150,centered,fixed,ly_tile,c_crop\n```\n| Input: Iceland, W300&times;H409 | Output: Iceland, W200&times;H150|\n|:------:|:------:|\n|![Iceland: W300&times;H409](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/iceland.jpg)|![Iceland: W200&times;H150](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/iceland_jpg_'x_0,y_0,w_200,h_150,centered,fixed,ly_tile,c_crop'.jpg)\n  \n  >&#x1f4a1; To get a transparent background, instead of black, convert the image to png. To get a background in the color you want, then use the background command. Then you can transform back the image to the original format.\n>```HTML \n>e_png,c_format,x_0,y_0,w_200,h_150,centered,fixed,ly_tile,c_crop,bg_lavender,c_background,e_$org,c_format\n>```\n>| Input: Iceland, W300&times;H409 | Output: Iceland, W200&times;H150|\n>|:------:|:------:|\n>|![Iceland: W300&times;H409](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/iceland.jpg)|![Iceland: W200&times;H150](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/iceland_jpg_'e_png,c_format,x_0,y_0,w_200,h_150,centered,fixed,ly_tile,c_crop,bg_lavender,c_background,e_$org,c_format'.jpg)\n  \n* Example 6 - Focus crop, center layout, fixed size\n```HTML \nx_0,y_0,w_200,h_150,centered,fixed,ly_center,c_crop\n```\n| Input: Iceland, W300&times;H409 | Output: Iceland, W200&times;H150|\n|:------:|:------:|\n|![Iceland: W300&times;H409](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/iceland.jpg)|![Iceland: W200&times;H150](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/iceland_jpg_'x_0,y_0,w_200,h_150,centered,fixed,ly_center,c_crop'.jpg)\n  \n* Example 7 - Focus crop, fit layout, fixed size\n```HTML \nx_0,y_0,w_200,h_150,centered,fixed,ly_fit,c_crop\n```\n| Input: Iceland, W300&times;H409 | Output: Iceland, W200&times;H150|\n|:------:|:------:|\n|![Iceland: W300&times;H409](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/iceland.jpg)|![Iceland: W200&times;H150](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/iceland_jpg_'x_0,y_0,w_200,h_150,centered,fixed,ly_fit,c_crop'.jpg)\n \n* Example 8 - Focus crop, fill layout, changing bounds\n```HTML \nx_0,y_0,w_200,h_150,centered,fixed,ly_fill,fw_200,fh_200,c_crop\n```\n| Input: Iceland, W300&times;H409 | Output: Iceland, W200&times;H200|\n|:------:|:------:|\n|![Iceland: W300&times;H409](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/iceland.jpg)|![Iceland: W200&times;H200](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/iceland_jpg_'x_0,y_0,w_200,h_150,centered,fixed,ly_fill,fw_200,fh_200,c_crop'.jpg)\n\n### density\n\nSpecifies the image resolution. Sets an attribute and does not alter the underlying raster image.\n\nParameters:\n\n* prefix `d`: the value of density, as pixels per unit, or a couple of values separated by ×, one for horizontal value, the other for vertical value; \n* prefix `hv`: the horizontal density value, as pixels per unit;\n* prefix `hh`: the vertical density value, as pixels per unit;\n* switch `ppc`: to set the unit to centimenter (by default, unit is inch)\n* prefix `q`: the quality of file for type which handle it (jpeg, mpeg, png, mng, tiff, miff, bpg, webp…​). It’s a positive integer, usually from 0 (or 1) to 100, the lowest means the lowest quality, the highest means highest quality. \n\nExamples:     \n* Example 1 - Set to 300dpi\n```HTML \nd_300,c_density\n```\n* Example 2 - Set to 256&times;192dpc\n```HTML \nd_256&times;192,ppc,c_density\n```\nor\n```HTML \nvh_256,vv_192,ppc,c_density\n```\n\n\n### fill\n\nAdapts the size of the image to completely fill a box, parts of the image can therefore be hidden, but proportionality is respected.\n\nParameters:\n\n* prefix `w`: a **dimension value**, default value is 100%\n\n  width of the new image\n  \n* prefix `h`: a **dimension value**, default value is 100%\n\n  height of the new image\n  \n* prefix `g`: a **gravity value**\n* prefix `x`: a **dimension value**, default value is 0\n\n  the x (easting) of the center point of the source image in the target image\n  \n* prefix `y`: a **dimension value**, default value is 0\n\n  the y (northing) of the center point of the source image in the target image\n\nExamples:     \n* Example 1 - Fill, no gravity\n```HTML \nw_300,h_300,c_fill\n```\n| Input: Maldives, W400&times;H225 | Output: Maldives, W300&times;H300 |\n|:------:|:------:|\n|![Maldives: W400&times;H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: W300&times;H300](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'w_300,h_300,c_fill'.jpg)\n\n* Example 2 - Fill, with gravity\n```HTML \ng_east,w_300,h_300,c_fill\n```\n| Input: Maldives, W400&times;H225 | Output: Maldives, W300&times;H300 |\n|:------:|:------:|\n|![Maldives: W400&times;H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Boat in clear blue ocean: W135&times;H65](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'g_east,w_300,h_300,c_fill'.jpg)\n\n### fit \n\nAdapts the size of the image to fill a box as much as possible, but in such a way as to be completely visible, while respecting proportionality.\n\nParameters:\n\n* prefix `w`: a **dimension value**, default value is 100% \n\n  width of the new image\n  \n* prefix `h`: a **dimension value**, default value is 100%\n\n  height of the new image\n  \n* prefix `g`: a **gravity value**\n* prefix `x`: a **dimension value**, default value is 0\n\n  the x (easting) of the center point of the source image in the target image\n  \n* prefix `y`: a **dimension value**, default value is 0\n\n  the y (northing) of the center point of the source image in the target image\n\n* prefix `bg`: the color to fill empty space\n\n* switch `trim`: remove empty space (parameters prefixed with `g`,`x`,`y`or`bg` can't be used with this switch)\n\nExamples:     \n* Example 1 - Fit, no gravity\n```HTML \nw_300,h_300,c_fit\n```\n| Input: Maldives, W400&times;H225 | Output: Maldives, W300&times;H300 |\n|:------:|:------:|\n|![Maldives: W400&times;H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: W300&times;H300](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'w_300,h_300,c_fit'.jpg)\n\n* Example 2 - Fit, with gravity\n```HTML \ng_north,w_300,h_300,c_fit\n```\n| Input: Maldives, W400&times;H225 | Output: Maldives, W300&times;H300 |\n|:------:|:------:|\n|![Maldives: W400&times;H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: W300&times;H300](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'g_north,w_300,h_300,c_fit'.jpg)\n\n* Example 3 - Fit, with colored background\n```HTML \nbg_aquamarine,w_300,h_300,c_fit\n```\n| Input: Maldives, W400&times;H225 | Output: Maldives, W300&times;H300 |\n|:------:|:------:|\n|![Maldives: W400&times;H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: W300&times;H300](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'bg_aquamarine,w_300,h_300,c_fit'.jpg)\n\n### flip\n\nFlips the image vertically (Horizontal axis symmetry).\n\nNo parameters.\n\nExample:\n\n```HTML \nc_flip\n```  \n\n### flop\n\nFlips the image horizontally (Vertical axis symmetry).\n\nNo parameters.\n\nExample:\n\n```HTML \nc_flop\n``` \n\n### format\n\nConvert file to specified format.\n\nParameters:\n\n* prefix `e`: output file extension\n  \n  Use value `$org` to format to input file extension (can be use to convert to a specific format to chain some commands and finally return to original format)\n  \n* prefix `q`: the quality of file for type which handle it (jpeg, mpeg, png, mng, tiff, miff, bpg, webp…​). It’s a positive integer, usually from 0 (or 1) to 100, the lowest means the lowest quality, the highest means highest quality. \n\n* prefix `hv`: a **density value**, the horizontal density of the binary target if source is a vector image (default is `vv` if specified)\n\n* prefix `vv`: a **density value**, the vertical density of the binary target if source is a vector image (default is `hv` if specified)\n\n* switch `dpi`: set the density in dots per inch (default)\n\n* switch `dpc`: set the density in dots per centimeter\n\n* prefix `cp`: clipping path\n\n* switch `outside`: +outside to clip outside or -outside to clip inside\n\nExamples:     \n* Example 1 - Convert to png\n```HTML \ne_png,c_format\n```\n\n* Example 2 - Convert to jpeg with specified quality\n```HTML \ne_jpg,q_5,c_format\n```\n\n>&#x1f4a1; to change quality without changing extension, use `$current` value for extension:\n>```HTML \n>e_$current,q_5,c_format\n>```\n\n### layout\n\nThis command just places the image in an image of a certain size.\n\nParameters:\n\n* prefix `w`: a **dimension value**, default value is 100%\n\n  width of the target image\n\n\n* prefix `h`: a **dimension value**, default value is 100%\n\n  height of the target image\n\n* prefix `g`: a **gravity value**\n* prefix `x`: a **dimension value**, default value is 0  \n\n  the x (easting) of the center point of the source image in the target image          \n  \n* prefix `y`: a **dimension value**, default value is 0\n\n  the y (northing) of the center point of the source image in the target image\n\n* prefix `bg`: the color to fill empty space  (Only classic color or $dom type color is allowed)\n\nExamples:\n* Example 1 - Simple layout\n```HTML \nbg_dodgerblue,w_600,h_600,c_layout\n```\n| Input: Maldives, W400&times;H225 | Output: Maldives, W600&times;H600 |\n|:------:|:------:|\n|![Maldives: W400&times;H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: 600&times;H600](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'bg_dodgerblue,w_600,h_600,c_layout'.jpg)\n* Example 2 - Layout, specifying location\n```HTML \nbg_dodgerblue,g_east,y_100,w_600,h_600,c_layout\n```\n| Input: Maldives, W400&times;H225 | Output: Maldives, W600&times;H600 |\n|:------:|:------:|\n|![Maldives: W400&times;H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: 600&times;H600](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'bg_dodgerblue,g_east,y_100,w_600,h_600,c_layout'.jpg)\n\n### lresize (liquid resize)\n\nThis command resize the image with the seam carving algorithm, keeping focus on main subjects. Note some parts of he image could be distorted.\n\nParameters:\n\n* prefix `w`: a **dimension value**, default value is 100%\n\n  width of the new image\n  \n* prefix `h`: a **dimension value**, default value is 100%\n\n  height of the new image \n\nExample: liquid resize to 50%, proportionally\n```HTML \n w_proportional,h_50p,c_lresize\n```\n| Input: Madivaru finolhu, Maldives, W320&times;H400 | Output: Madivaru finolhu, Maldives, W160&times;H200 | To compare to resize output `w_proportional,h_50p,c_resize` |\n|:------:|:------:|:------:|\n|![Madivaru finolhu, Maldives: W320&times;H400](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/island.jpg)|![Madivaru finolhu, Maldives: W160&times;H200](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/island_jpg_'w_proportional,h_50p,c_lresize'.jpg)|![Madivaru finolhu, Maldives: W160&times;H200 (resized)](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/island_jpg_'w_proportional,h_50p,c_resize'.jpg)|\n\n### metadata\n\nWrite metadata into image file.\n\nParameters:\n\n* prefix `mv`: specify the name and value of a metadata\n \n  * the name must be one of the followings:\n  \n    * **artist**: \n    * **comment**: \n    * **copyright**: \n    * **DocumentName**: \n    * **ImageDescription**: \n    * **Make**: \n    * **Software**: \n \n  * the value is a string value\n  \n    Example : `mv_copyright=\"Dummy Production\"`\n  \n  * you can set value from asset metadata\n   \n    Example : `mv_ImageDescription=prop:description`\n  \n  * value is patchable\n  \n    You can specify variables that will be replaced by there corresponding value.\n  \n    Example : `mv_artist=\"${photograph.firstname} ${photograph.name}\"`\n\n* prefix `ts` allows to set metadata with a json like\n \n  ```\n  {\n    \"artist\":\"${photograph.firstname} ${photograph.name}\",\n    \"ImageDescription\":\"prop:description\",\n    \"comment\":\"this was exported on July 3, 2020\"\n  }\n  ```\n\n### pad\n\nAdd some space surrounding the image or to selected sides of the image\n\nThis command resize the image with the seam carving algorithm, keeping focus on main subjects. Note some parts of he image could be distorted.\n\nParameters:\n\n* prefix `t`: a **dimension value**, default value is 0\n\n  the amount of top inset (above the image)\n  \n* prefix `r`: a **dimension value**, default value is 0\n\n  the amount of right inset (on the right of the image)\n\n* prefix `b`: a **dimension value**, default value is 0\n\n  the amount of bottom inset (below the image)\n\n* prefix `l`: a **dimension value**, default value is 0\n\n  the amount of left inset (on the left of the image)\n  \n* prefix `bd`: a **dimension value**, default value is 0\n\n  a common default value for top, right, bottom or left inset (default value is 0)\n\n*  prefix `bg`: a **dimension value**, default value is 0\n\n  the color to fill space\n\nExamples:     \n* Example 1 - Borders around\n```HTML \nbd_40,bg_sandybrown,c_pad\n```\n| Input: Maldives, W400&times;H225 | Output: Maldives, W480&times;H305 |\n|:------:|:------:|\n|![Maldives: W400&times;H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: W480&times;H305](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'bd_40,bg_sandybrown,c_pad'.jpg)\n\n* Example 2 - Selected borders (top and bottom)\n```HTML \nt_40,b_40,bg_sandybrown,c_pad\n```\n| Input: Maldives, W400&times;H225 | Output: Maldives, W400&times;H305 |\n|:------:|:------:|\n|![Maldives: W400&times;H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: W400&times;H305](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'t_40,b_40,bg_sandybrown,c_pad'.jpg)\n\n* Example 3 - Different sizes\n```HTML \nbd_10,b_20p,bg_white,c_pad\n```\n| Input: Maldives, W400&times;H225 | Output: Maldives, W420&times;H280 |\n|:------:|:------:|\n|![Maldives: W400&times;H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: W420&times;H280](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'bd_10,b_20p,bg_white,c_pad'.jpg)\n\n>&#x1f4a1; For Different colors, chain several pad commands \n>```HTML \n>bd_1,bg_black,c_pad,bd_10,bg_white,c_pad,bd_1,bg_black,c_pad\n>```\n| Input: Maldives, W400&times;H225 | Output: Maldives, W424&times;H249 |\n|:------:|:------:|\n|![Maldives: W400&times;H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: W424&times;H249](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'bd_1,bg_black,c_pad,bd_10,bg_white,c_pad,bd_1,bg_black,c_pad'.jpg)\n    \n### preset\n\nApply a preset\n\nParameters:\n\n* prefix `n`: a string\n\n  name of preset   \n  \nExample:\n```HTML \nn_circle_png,c_preset\n```\n| Input: Maldives, W400&times;H225 | Output: Maldives, W225&times;H225 |\n|:------:|:------:|\n|![Maldives: W400&times;H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: W225&times;H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'n_circle_png,c_preset'.png)\n\n### resample\n\nChange the density (in Dot Per Inches) of the image.\n\nParameters:\n\n* prefix `hv`: a **density value**\n\n  the horizontal density\n\n* prefix `vv`: a **density value**\n\n  the vertical density\n\nIf only one of the two parameters is specified, the other parameter is equal to it.\n\nExample:\n```HTML \nhv_300,vv_300,c_resample\n```\n\n### rescale\n\nResize the image proportionaly.\n\nParameters:\n\n* prefix `f`: factor\n\n  the rescaling factor\n\nExample:\n```HTML \nf_1.5,c_rescale\n```\n| Input: Maldives, W400&times;H225 | Output: Maldives, W600&times;H337 |\n|:------:|:------:|\n|![Maldives: W400&times;H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: W600&times;H337](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'f_1.5,c_rescale'.jpg)\n\n### resize\n\nParameters:\n\n* prefix `w`: a **dimension value**, default value is 100%\n\n  width of the new image\n  \n* prefix `h`: a **dimension value**, default value is 100%\n\n  height of the new image \n\nExamples:     \n* Example 1 - Not proportional resizing\n```HTML \nw_125p,h_75p,c_resize\n```\n| Input: Maldives, W400&times;H225 | Output: Maldives, W500&times;H168 |\n|:------:|:------:|\n|![Maldives: W400&times;H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: W500&times;H168](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'w_125p,h_75p,c_resize'.jpg)\n\n* Example 2 - One dimension resizing\n```HTML \nh_200p,c_resize\n```\n| Input: Maldives, W400&times;H225 | Output: Maldives, W400&times;H450 |\n|:------:|:------:|\n|![Maldives: W400&times;H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: W400&times;H450](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'h_200p,c_resize'.jpg)\n\n* Example 3 - Proportional resizing\n```HTML \nw_proportional,h_50p,c_resize\n```\n| Input: Maldives, W400&times;H225 | Output: Maldives, W199&times;H112 |\n|:------:|:------:|\n|![Maldives: W400&times;H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: W199&times;H112](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'w_proportional,h_50p,c_resize'.jpg)\n\n* Example 4 - Invert width and height\n```HTML \nw_height,h_width,c_resize\n```\n| Input: Maldives, W400&times;H225 | Output: Maldives, W225&times;H400 |\n|:------:|:------:|\n|![Maldives: W400&times;H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: W225&times;H400](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'w_height,h_width,c_resize'.jpg)\n\n### rotate\n\nRotates the image.\n\nParameters:\n\n* prefix `a`: angle\n* switch `crop`: crop mode switch\n* prefix `x`: a **dimension value**, default value is 0  \n\n  The x (easting) of the top-left corner of the cropping box              \n  \n* prefix `y`: a **dimension value**, default value is 0\n\n  The y (northing) of the top-left corner of the cropping box\n  \nExamples:     \n* Example 1 - Turn left\n```HTML \na_left,c_rotate\n```\n| Input: Maldives, W400&times;H225 | Output: Maldives, W225&times;H400 |\n|:------:|:------:|\n|![Maldives: W400&times;H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: W225&times;H400](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'a_left,c_rotate'.jpg)\n  \n* Example 2 - Turn 45 degrees\n```HTML \na_45,c_rotate\n```\n| Input: Maldives, W400&times;H225 | Output: Maldives, W444&times;H443 |\n|:------:|:------:|\n|![Maldives: W400&times;H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: W444&times;H443](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'a_45,c_rotate'.jpg)\n  \n* Example 3 - Turn 45 degrees, fill background with second dominant color\n```HTML \nbg_$dom-1,a_45,c_rotate\n```\n| Input: Maldives, W400&times;H225 | Output: Maldives, W444&times;H443 |\n|:------:|:------:|\n|![Maldives: W400&times;H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: W444&times;H443](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'bg_$dom-1,a_45,c_rotate'.jpg)\n\n* Example 4 - Turn 45 degrees, crop to original size\n```HTML \na_45,crop,c_rotate\n```\n| Input: Maldives, W400&times;H225 | Output: Maldives, W400&times;H225 |\n|:------:|:------:|\n|![Maldives: W400&times;H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: W400&times;H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'a_45,crop,c_rotate'.jpg)\n \n* Example 5 - Turn 45 degrees, crop to original size, with focus\n```HTML \na_45,crop,x_50p,y_25p,c_rotate\n```\n| Input: Maldives, W400&times;H225 | Output: Maldives, W400&times;H225 |\n|:------:|:------:|\n|![Maldives: W400&times;H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: W400&times;H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'a_45,crop,x_50p,y_25p,c_rotate'.jpg)\n \n### strip\n\nRemoves metadata (Exif, IPTC…​) from image.\n\nNo parameters.\n\nExample:\n\n```HTML \nc_strip\n```\n\n### thumbnail\n\nGenerates a standard thumbnail.\n\nParameters:\n\n* prefix `w`: a **dimension value**, default value is 100%\n\n  width of the target image\n\n\n* prefix `h`: a **dimension value**, default value is 100%\n\n  height of the target image\n\n* prefix `e`: output file extension\n  \n  Use value `$org` to format to input file extension (can be use to convert to a specific format to chain some commands and finally return to original format)\n\n* prefix `bg`: background color\n* prefix `q`: the quality of file for type which handle it (jpeg, mpeg, png, mng, tiff, miff, bpg, webp…​). It’s a positive integer, usually from 0 (or 1) to 100, the lowest means the lowest quality, the highest means highest quality. \n* prefix `i`: image index, if origin is a multi-page/multi document (or multi-image file) (integer, default is 0)\n\n* switch `-proportional`: deactivate proportional resizing (true by default)\n* switch `autorotate`: activate self-orientation (based on EXIF image profile setting 'Orientation')\n* switch `zoomin`: activate image fitting\n* switch `extend`: activate image filling\n\nExamples:\n* Example 1 - Simple thumbnail\n```HTML \nw_300,h_300,c_thumbnail\n```\n| Input: Maldives, W400&times;H225 | Output: Maldives, W300&times;H168 |\n|:------:|:------:|\n|![Maldives: W400&times;H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: 300&times;H168](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'w_300,h_300,c_thumbnail'.png)\n\n### watermark\n\nDraws text overlay on image.\n\nParameters:\n\n* prefix `f`: font\n* prefix `bg`: background color\n* prefix `fg`: foreground color\n* prefix `sc`: stroke color\n* prefix `g`: location\n* prefix `x`: x (easting) coordinates\n* prefix `y`: y (northing) coordinates\n* prefix `a`: angle\n* prefix `s`: stroke width\n* prefix `tx`: text  \n* prefix `xd`: text decoration\n* prefix `sh`: shade\n* switch `thickeroutline`: increases the thickness of outlines \n\nExamples:     \n* Example 1 - Text\n```HTML \ntx_\"\\u00a9Wedia\",f_Candice|25%|bold,c_watermark\n```\n| Input: Maldives, W400&times;H225 | Output: Maldives, W400&times;H225 |\n|:------:|:------:|\n|![Maldives: W400&times;H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: W400&times;H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'tx_''_u00a9Wedia'',f_Candice_25p_bold,c_watermark'.jpg)\n  \n* Example 2 - Colored text\n```HTML \ntx_\"\\u00a9Wedia\",f_Montserrat|25p|bold,fg_#00A5C8,c_watermark\n```\n| Input: Maldives, W400&times;H225 | Output: Maldives, W400&times;H225 |\n|:------:|:------:|\n|![Maldives: W400&times;H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: W400&times;H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'tx_''_u00a9Wedia'',f_Montserrat_25p_bold,fg__00A5C8,c_watermark'.jpg)\n  \n* Example 3 - Outlined text\n```HTML \ntx_\"\\u00a9Wedia\",f_Montserrat|50p|heavy,sc_white,fg_none,g_center,c_watermark\n```\n| Input: Maldives, W400&times;H225 | Output: Maldives, W400&times;H225 |\n|:------:|:------:|\n|![Maldives: W400&times;H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: W400&times;H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'tx_'_u00a9Wedia,f_Montserrat_50p_heavy,sc_white,fg_none,g_center,c_watermark'.jpg)\n\n* Example 4 - Outlined text, blur effect\n```HTML \ntx_\"\\u00a9Wedia\",f_Montserrat|50p|heavy,sc_white,fg_$blur:25x25,g_center,c_watermark\n```\n| Input: Maldives, W400&times;H225 | Output: Maldives, W400&times;H225 |\n|:------:|:------:|\n|![Maldives: W400&times;H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: W400&times;H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'tx_''_u00a9Wedia'',f_Montserrat_50p_heavy,sc_white,fg_$blur_25x25,g_center,c_watermark'.jpg)\n\n* Example 5 - Outlined text, shade effect\n```HTML \ntx_\"\\u00a9Wedia\",f_Montserrat|50p|heavy,sc_white,fg_$blur:25x25,g_center,thickeroutline,sh_45&times;90,c_watermark\n```\n| Input: Maldives, W400&times;H225 | Output: Maldives, W400&times;H225 |\n|:------:|:------:|\n|![Maldives: W400&times;H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: W400&times;H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'watermark_shade_effect'.jpg)\n\n* Example 6 - With or without thickeroutline\n\nWithout:\n```HTML \ntx_\"\\u00a9Wedia\",f_Arial|40p|bold,s_5,sc_black,fg_white,c_watermark\n```\n| Input: Maldives, W400&times;H225 | Output: Maldives, W400&times;H225 |\n|:------:|:------:|\n|![Maldives: W400&times;H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: W400&times;H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'without_thickeroutline'.jpg)\n    \nWith:\n```HTML \ntx_\"\\u00a9Wedia\",f_Arial|40p|bold,s_5,sc_black,fg_white,thickeroutline,c_watermark\n```\n| Input: Maldives, W400&times;H225 | Output: Maldives, W400&times;H225 |\n|:------:|:------:|\n|![Maldives: W400&times;H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: W400&times;H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'with_thickeroutline'.jpg)\n    ","version":"2.4","title":"WEDIA REST Imaging API","contact":{"email":"support@wedia-group.com"}},"servers":[{"url":"https://club-wed.wedia-group.com/api/media"}],"tags":[{"name":"imaging","description":"API to transform images.","externalDocs":{"url":"https://crossmedia.atlassian.net/wiki/spaces/WD/pages/379912195/Imaging+downloading+and+applying+image+transformations#commands","description":"Documentation of the REST WEDIA API transform configuration"}}],"paths":{"/imaging/clubwedlist/{resourceId}":{"get":{"summary":"Transform resource image","description":"Get transformed image from specified resource.","tags":["imaging"],"parameters":[{"name":"resourceId","in":"path","description":"ID of the resource from which to get the binary file.","schema":{"type":"integer"},"required":true},{"name":"transform","in":"query","description":"Imaging commands to transform the image.\n\n [See documentation of transform commands](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/379912195/Imaging+downloading+and+applying+image+transformations)","schema":{"type":"string"},"required":false},{"name":"commands","in":"query","description":"Imaging commands to transform the image. Ignored if transform is specified.\n\n [See documentation of transform commands](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/379912195/Imaging+downloading+and+applying+image+transformations)","schema":{"type":"object","format":"jsonquery","additionalProperties":true},"required":false},{"name":"preset","in":"query","description":"Imaging preset to transform the image. Ignored if transform or commands is specified.","schema":{"type":"string"},"required":false},{"name":"strip","in":"query","description":"If true, removes all metadata in transformed image","schema":{"type":"boolean","default":true},"required":false},{"name":"attachment","in":"query","description":"If true, returns the Content-Disposition header filled with attachment data","schema":{"type":"boolean","default":true},"required":false},{"name":"lang","in":"query","description":"Language (override header Accept-Language).","schema":{"type":"string"},"required":false},{"name":"state","in":"query","description":"The value of this parameter is returned as it is in the response.  \n\n[See more about state parameter here]: #general-parameter-state \"More about state parameter\"\n\n[See more about state parameter here]","schema":{},"required":false}],"responses":{"200":{"description":"The binary file resource","content":{"*/*":{"schema":{"type":"string","format":"binary"}}}}}}},"/imaging/clubwedlista/{resourceId}":{"get":{"summary":"Transform resource image","description":"Get transformed image from specified resource.","tags":["imaging"],"parameters":[{"name":"resourceId","in":"path","description":"ID of the resource from which to get the binary file.","schema":{"type":"integer"},"required":true},{"name":"transform","in":"query","description":"Imaging commands to transform the image.\n\n [See documentation of transform commands](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/379912195/Imaging+downloading+and+applying+image+transformations)","schema":{"type":"string"},"required":false},{"name":"commands","in":"query","description":"Imaging commands to transform the image. Ignored if transform is specified.\n\n [See documentation of transform commands](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/379912195/Imaging+downloading+and+applying+image+transformations)","schema":{"type":"object","format":"jsonquery","additionalProperties":true},"required":false},{"name":"preset","in":"query","description":"Imaging preset to transform the image. Ignored if transform or commands is specified.","schema":{"type":"string"},"required":false},{"name":"strip","in":"query","description":"If true, removes all metadata in transformed image","schema":{"type":"boolean","default":true},"required":false},{"name":"attachment","in":"query","description":"If true, returns the Content-Disposition header filled with attachment data","schema":{"type":"boolean","default":true},"required":false},{"name":"lang","in":"query","description":"Language (override header Accept-Language).","schema":{"type":"string"},"required":false},{"name":"state","in":"query","description":"The value of this parameter is returned as it is in the response.  \n\n[See more about state parameter here]: #general-parameter-state \"More about state parameter\"\n\n[See more about state parameter here]","schema":{},"required":false}],"responses":{"200":{"description":"The binary file resource","content":{"*/*":{"schema":{"type":"string","format":"binary"}}}}}}}},"components":{"schemas":{}},"externalDocs":{"url":"https://crossmedia.atlassian.net/wiki/spaces/WD/pages/16547995/Integration+with+the+Wedia+Rest+API","description":"Find out more about Wedia REST API"}}