frame_render_config
Options you can use to include a base64 string your application can use to render an image. Note this will slow down the return response so should only be used if needed for your application.
| Name | Description | Type | Additional information |
|---|---|---|---|
| content_type | Optional. Default is png. Values are 0 for png and 1 for jpg. | image_content_types | None. |
| render_size | Maximum dimensions (pixels) you want the rendered image to be. Any number between 100 and 1200. Default is 500. | number |
Range: inclusive between 100 and 1200 |
| squared | Default is false however you can choose to contain the rendered image in a square. Note, this can slightly increase rendering time. | boolean | None. |
| shadow_inner | Optional - You can choose to render a drop shadow on the inside of the frame. | boolean | None. |
| prompt_image | Optional - Places a "add image" marker in center of frame if not image is supplied. | boolean | None. |
| frame_image_to_display_url | Optional - Include the url of an image file you want to use. Must be JPG or PNG. Alternatively, if you have a mat, you can designate an image to display there, in which case this would be ignored. Note this can slow down rendering, dependent on the file size. | text | None. |