Skip to content

Export

Control the output image format, quality, and resolution.

Usage

json
{
  "settings": {
    "export": {
      "format": "png",
      "quality": 90,
      "scale": 2
    }
  }
}

Properties

PropertyTypeRangeDefaultDescription
formatstringpng, jpg, webpwebpOutput image format
qualitynumber10 - 10085Image quality (lossy formats)
scalenumber1 - 41Resolution multiplier

Formats

PNG

  • Lossless compression
  • Supports transparency
  • Larger file sizes
  • Best for graphics with sharp edges
json
{
  "settings": {
    "export": {
      "format": "png"
    }
  }
}

JPEG

  • Lossy compression
  • Smaller file sizes
  • No transparency
  • Best for photographs
json
{
  "settings": {
    "export": {
      "format": "jpg",
      "quality": 85
    }
  }
}

WebP

  • Modern format with excellent compression
  • Supports transparency
  • Smaller than PNG, better quality than JPEG
  • Recommended default
json
{
  "settings": {
    "export": {
      "format": "webp",
      "quality": 90
    }
  }
}

Resolution Scale

The scale property multiplies the output resolution:

ScaleOutput
11x (standard)
22x (retina)
33x (high-DPI)
44x (ultra-high)

Note

Higher scales increase render time and response size.

Examples

High Quality PNG

json
{
  "settings": {
    "export": {
      "format": "png",
      "scale": 2
    }
  }
}

Optimized for Web

json
{
  "settings": {
    "export": {
      "format": "webp",
      "quality": 80,
      "scale": 1
    }
  }
}
json
{
  "settings": {
    "export": {
      "format": "png",
      "scale": 4
    }
  }
}

Shotprose API Documentation