API Endpoints

/generate/patch

post
https://api.cloud.scenario.com/v1/generate/patch

Patch an asset with an image.

Query Params
string

If set to true, returns the original asset without transformation

string
Body Params
patch
object

The image to be merged.

string
required

The input image as a data URL (example: "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVQYV2NgYAAAAAMAAWgmWQ0AAAAASUVORK5CYII=") or the asset ID (example: "asset_GTrL3mq4SXWyMxkOHRxlpw")

string

The background color as an hexadecimal code (ex: "#FFFFFF"), an html color (ex: "red") or "transparent" if "format" is "png". Default to "white"

string
enum

The output format. Default to "png"

Allowed:
position
object

The position of the image to be merged.

boolean

Whether to allow the merged image to extend the size of the original (when x or y are negative or merged image is bigger)

crop
object

The crop operation to apply to the image. Applied before any operation. For the backgroundColor: rgba, hex or named color are supported.

Responses

Updated 5 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago