image.process

post/v1/images/{id}/process

image.process

Request

Parameters

Name	In	Type	Description
id*	path	string	No description

Body

{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "preset": {
            "type": "string",
            "enum": [
              "web",
              "visuallossless",
              "nearlossless",
              "photographer"
            ]
          },
          "encoder": {
            "type": [
              "string",
              "null"
            ],
            "enum": [
              "auto",
              "avif",
              "webp",
              "jpeg"
            ]
          },
          "max_long": {
            "type": [
              "integer",
              "null"
            ],
            "minimum": 256,
            "maximum": 8000
          },
          "force_classification": {
            "type": [
              "boolean",
              "null"
            ]
          },
          "force_444": {
            "type": [
              "boolean",
              "null"
            ]
          },
          "depth10": {
            "type": [
              "boolean",
              "null"
            ]
          },
          "lossless": {
            "type": [
              "boolean",
              "null"
            ]
          },
          "codec": {
            "type": [
              "string",
              "null"
            ],
            "enum": [
              "aom",
              "rav1e"
            ]
          },
          "sharpen": {
            "type": [
              "boolean",
              "null"
            ]
          },
          "color_space": {
            "type": [
              "string",
              "null"
            ],
            "enum": [
              "srgb",
              "keep"
            ]
          },
          "callback_url": {
            "type": [
              "string",
              "null"
            ],
            "format": "uri"
          },
          "callback_secret": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 255
          },
          "formats": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "jpg",
                "png",
                "webp",
                "avif"
              ]
            },
            "minItems": 1,
            "maxItems": 4
          },
          "retain_metadata": {
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": "string",
              "enum": [
                "orientation",
                "icc",
                "exif",
                "xmp"
              ]
            }
          },
          "branding": {
            "type": "object",
            "properties": {
              "logo": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "logo_light": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "logo_dark": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "position": {
                "type": [
                  "string",
                  "null"
                ],
                "enum": [
                  "ne",
                  "nw",
                  "se",
                  "sw",
                  "center"
                ]
              },
              "scale": {
                "type": [
                  "number",
                  "null"
                ],
                "minimum": 0,
                "maximum": 1
              },
              "padding": {
                "type": [
                  "integer",
                  "null"
                ],
                "minimum": 0,
                "maximum": 200
              },
              "opacity": {
                "type": [
                  "number",
                  "null"
                ],
                "minimum": 0,
                "maximum": 1
              },
              "background": {
                "type": [
                  "string",
                  "null"
                ]
              }
            }
          }
        },
        "required": [
          "preset",
          "formats"
        ]
      }
    }
  }
}

Responses

200No description

Schema

Schema Structure

{
  "type": "object"
}

422Validation error

Schema

Schema Structure

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "Errors overview."
    },
    "errors": {
      "type": "object",
      "description": "A detailed description of each field that failed validation.",
      "additionalProperties": {
        "type": "array",
        "items": {
          "type": "string"
        }
      }
    }
  },
  "required": [
    "message",
    "errors"
  ]
}