Documentation v0.2.0
- URL parameter index
- Config key index
- HTTP status codes
Basics
Get up and running, learn how a request URL is built, and adjust the config.
Getting started
Install picturium with one command, keep it up to date, and transform your first image.
- Install
- Upgrade
- Configure
- Run with Docker manually
- +1 more
Request model
Learn how picturium reads, verifies, caches, and serves a request.
- URL grammar
- Signed URLs
- Caching & force
- HTTP caching
- +2 more
Configuration & operations
Configure, deploy, monitor, and tune the server.
- Config file
- Environment overrides
- Cache tuning
- Concurrency
- +1 more
Features
Resize, crop, filter, and format images through the URL.
Sizing & layout
Fit an image into a requested box.
- Width, height, aspect ratio
- Fit modes
- Gravity
- Scaling: dpr, scale, upsize
- +4 more
Cropping
Cut a region out of the source before sizing.
- The crop parameter
- Smart crop
Filters & effects
Combine several colour and image adjustments in one filter= value.
- Tone & colour
- Presets
- Blur, sharpen, pixelate
- Palette
Output format & quality
Choose an output format and balance image quality against file size.
- Format selection
- Quality
- Encoder options
- Metadata
- +2 more
Animation & video
Keep, flatten, or adjust animated images and extract video frames or clips.
- Animated images
- The anim parameter
- Video frames & clips
Documents & vectors
Render pages from PDF, SVG, Office, and vector-art files.
- Page selection
- SVG
- Office documents
- +2 more
Watermarking
Overlay an image or text mark.
- watermark parameter
- Config defaults
- Behaviour
Video clipping
Cut a shorter video clip out of a video source, returned as video.
Integrations
Use picturium from PHP, JavaScript, or AI workflows.
PHP library
Use picturium in your PHP applications, including your favourite frameworks.
JavaScript library
Use picturium in your JavaScript and TypeScript applications.
AI integration
Automate picturium integration within your existing codebase.
Monitoring & telemetry
Observe requests, performance, and service health.