Run several steps on one image
run_pipelineRun a multi-step workflow on an image in one call, for example remove the background, resize, convert and compress. Needs a Pro plan. Give "pipeline": { "steps": [{ "op", "params", "when"? }] } with ops remove_background, upscale, resize, crop, rotate, edit, watermark, convert, compress (params are the REST API's options, e.g. { "width": 1600 } or { "format": "webp", "mode": "smart" }; "when" makes a step conditional on format, min_width, max_width, min_bytes, max_bytes or has_alpha), or "preset": the name of a saved pipeline or a template (web-optimized, thumbnail, product-square, social-square, avatar, private-share). Set dry_run to see which steps would run and the resulting size without processing anything. Returns a download URL valid for one hour and a report of every step.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | The source file's name, for the output name pattern. | |
| preset | No | ||
| dry_run | No | ||
| version | No | A version of a saved pipeline. Default: the latest. | |
| pipeline | No | The pipeline object. Use this or preset. | |
| image_url | No | Public http(s) address of the image. Use this or image_base64. | |
| image_base64 | No | The image file's bytes, base64-encoded. Use for a local file, e.g. one in the repository. |