POST image

resize

1 credit

Resize image to dimensions or percentage, optionally maintain aspect ratio

Endpoint

POST /api/v1/tools/image/resize

Body Parameters

width integer | null optional default: null

format string optional default: "PNG"

height integer | null optional default: null

percent number | null optional default: null

image_base64 string required

maintain_aspect boolean optional default: true

Example

input Request

{
    "width": 1,
    "image_base64": "iVBORw0KGgoAAAANSUhEUgAAAAIAAAACCAYAAABytg0kAAAAFElEQVR4nGP8z8Dwn4GBgYGJAQoAHxcCAk+Uzr4AAAAASUVORK5CYII="
}

output Response

{
    "width": 1,
    "format": "PNG",
    "height": 1,
    "image_base64": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR4nGP4z8DwHwAFAAH/iZk9HQAAAABJRU5ErkJggg=="
}

Response Format

HTTP/1.1 200 OK SUCCESS

{
  "success": true,
  "data": {
    "width": 1,
    "format": "PNG",
    "height": 1,
    "image_base64": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR4nGP4z8DwHwAFAAH/iZk9HQAAAABJRU5ErkJggg=="
},
  "meta": {
    "tool": "resize",
    "credits_consumed": 1
  }
}

HTTP/1.1 422 Unprocessable Entity ERROR

{
  "success": false,
  "data": null,
  "error": {
    "code": "validation_error",
    "message": "The given data was invalid."
  }
}

Code Examples

Request Example

lightbulb Developer Tip

Credits are deducted before execution. If the upstream tool fails, credits are automatically refunded to your account.