Image processing for AI agents: resize, convert, compress, crop, and web-ready AI-generated images.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Analyze an image Fetch an image from a URL or base64 and return its metadata: size in bytes, pixel dimensions, source format, and what it costs every supported vision model in tokens. Always free. Dimensions are omitted if the image header cannot be read. Also reports whether the input carries a C2PA (Content Credentials) manifest and in which container; the manifest is not validated. ### Responses: **200**: Successful Response (Success Response) Content-Type: application/json **Example Response:** ```json { "size_bytes": 1, "c2pa_manifest": true } ```
Image source: a public URL (https://...) or a base64-encoded string (optionally as a data URI like data:image/png;base64,...).
This tool isn't marked read-only, so it may change something on the server or in an account you connected.
Analyze an image Fetch an image from a URL or base64 and return its metadata: size in bytes, pixel dimensions, source format, and what it costs every supported vision model in tokens. Always free. Dimensions are omitted if the image header cannot be read. Also reports whether the input carries a C2PA (Content Credentials) manifest and in which container; the manifest is not validated. ### Responses: **200**: Successful Response (Success Response) Content-Type: application/json **Example Response:** ```json { "size_bytes": 1, "c2pa_manifest": true } ```
| Argument | Type | Description |
|---|---|---|
| source* | string | Image source: a public URL (https://...) or a base64-encoded string (optionally as a data URI like data:image/png;base64,...). |
{
"type": "object",
"title": "analyze_imageArguments",
"required": [
"source"
],
"properties": {
"source": {
"type": "string",
"title": "source",
"description": "Image source: a public URL (https://...) or a base64-encoded string (optionally as a data URI like data:image/png;base64,...)."
}
}
}Compress an image Re-encode an image with quality/format options to reduce file size. Supports jpeg, png, webp, tiff, gif. Instead of a q number you can set quality_target (0-1]: the smallest file with SSIM at or above the target, searched on the worker (jpeg, webp, avif; flat surcharge; outcome reported in X-Pictomancer-Quality-* headers). If the output is not smaller than the input, the request is free (X-Pig-Billed: 0) and does not consume free-tier quota. Optional enhancement modifiers: denoise (1-3), equalize, sharpen (applied denoise -> equalize -> op -> sharpen). ### Responses: **200**: Processed image binary (Success Response) Content-Type: application/json Content-Type: image/jpeg **Example Response:** ```json "string" ``` Content-Type: image/png **Example Response:** ```json "string" ``` Content-Type: image/webp **Example Response:** ```json "string" ```
| Argument | Type | Description |
|---|---|---|
| q | integer | Quality (1-100). Lower = smaller file. Typical values: 60-80 for web, 85-95 for print. Maps to libvips Q parameter. |
| strip | boolean | Strip metadata (EXIF, ICC profile, etc.) from the output. Reduces file size slightly. |
| format | string | Output format: jpeg, png, webp, tiff, gif, or avif. If omitted, the original format is preserved. |
| source* | string | Image source: a public URL (https://...) or a base64-encoded string (optionally as a data URI like data:image/png;base64,...). |
| autorot | boolean | Apply EXIF orientation before compressing. Opt-in; default false, which preserves current byte-for-byte behavior. |
| denoise | integer | Median denoise before compressing: radius 1-3 (window 3x3 to 7x7). Opt-in; no surcharge. |
| sharpen | boolean | Unsharp-mask sharpen after compressing (libvips defaults). Opt-in. |
| delivery | string | |
| equalize | boolean | Auto-contrast (histogram equalisation of the value channel; hue and saturation preserved) before compressing. Opt-in. |
| quality_target | number | Target SSIM (0-1]: the worker searches for the smallest file that still scores at least this. Alternative to q; mutually exclusive with it. Requires an explicit format among jpeg, webp, avif. Carries a flat surcharge for the extra encodes. |
Convert image format Convert an image to a different format (jpeg, png, webp, tiff, gif, avif). Optionally set quality, strip metadata, enable lossless mode (webp, avif), or tune encoder effort (avif). Instead of a q number you can set quality_target (0-1]: the smallest file with SSIM at or above the target, searched on the worker (jpeg, webp, avif; flat surcharge; outcome reported in X-Pictomancer-Quality-* headers). Optional enhancement modifiers: denoise (1-3), equalize, sharpen (applied denoise -> equalize -> op -> sharpen). ### Responses: **200**: Processed image binary (Success Response) Content-Type: application/json Content-Type: image/jpeg **Example Response:** ```json "string" ``` Content-Type: image/png **Example Response:** ```json "string" ``` Content-Type: image/webp **Example Response:** ```json "string" ```
| Argument | Type | Description |
|---|---|---|
| q | integer | Quality (1-100). Maps to libvips Q parameter. |
| strip | boolean | Strip metadata (EXIF, ICC profile, etc.) from the output. |
| effort | integer | AV1 encoder CPU effort (0-9). Higher = smaller file, slower. Only applies to avif. |
| format* | string | Target format: jpeg, png, webp, tiff, gif, or avif. |
| source* | string | Image source: a public URL (https://...) or a base64-encoded string (optionally as a data URI like data:image/png;base64,...). |
| autorot | boolean | Apply EXIF orientation before converting. Opt-in; default false, which preserves current byte-for-byte behavior. |
Crop an image Extract a rectangular region from an image, in one of three mutually exclusive modes. Manual: give the top-left corner (x, y) and dimensions (width, height) in pixels. Smart crop: give 'gravity' (attention, entropy, centre) plus width and height; the window is picked automatically, clamped to the source if the target is larger. Trim: set 'trim: true' (optional 'threshold') to remove a uniform background border via content detection; the applied rect is reported in X-Pictomancer-Trim-* headers. Optional enhancement modifiers: denoise (1-3), equalize, sharpen (applied denoise -> equalize -> op -> sharpen). ### Responses: **200**: Processed image binary (Success Response) Content-Type: application/json Content-Type: image/jpeg **Example Response:** ```json "string" ``` Content-Type: image/png **Example Response:** ```json "string" ``` Content-Type: image/webp **Example Response:** ```json "string" ```
| Argument | Type | Description |
|---|---|---|
| x | integer | Left edge of the crop rectangle in pixels. Manual mode only. |
| y | integer | Top edge of the crop rectangle in pixels. Manual mode only. |
| trim | boolean | Trim mode: removes a uniform background border via content detection. Mutually exclusive with x/y/width/height/gravity. |
| width | integer | Width of the crop rectangle in pixels. Required in manual and gravity modes. |
| format | string | Output format: jpeg, png, webp, tiff, gif, or avif. If omitted, the original format is preserved. |
| height | integer |
Estimate the price of an operation Returns the exact USD price this API would charge for an operation on an input of the given size, without fetching or processing anything. Free. Use it before paying: send X-Max-Cost-USD on the real request to have the API refuse (412) instead of charging more than you allowed. The list price is returned even when the request could end up free (free tier, or a compress that does not shrink the file). ### Responses: **200**: Successful Response (Success Response) Content-Type: application/json **Example Response:** ```json { "operation": "Operation", "price_usd": 1.0, "base_usd": 1.0, "surcharges_usd": {}, "size_multiplier": 1.0, "within_free_tier": true, "free_tier_remaining": 1, "currency": "Currency", "network": "Network" } ```
| Argument | Type | Description |
|---|---|---|
| format | string | Requested output format; only avif changes the price. |
| operation* | string | Operation to price. One of resize, compress, convert, crop, optimize_for_vision, optimize_generated, remove_background, pipeline. analyze is always free. |
| operations | array | For pipeline only: the ordered operations, each {type, format?}. Volume discount applies at 3+ operations. |
| input_bytes* | integer | Size of the input image in bytes. Get it from analyze_image (free) if you do not know it. |
| quality_target | boolean | Whether the request will use quality_target (SSIM search surcharge). |
Get supported formats and options Returns supported output formats and their configurable options. ### Responses: **200**: Successful Response (Success Response) Content-Type: application/json
No arguments.
{
"type": "object",
"title": "get_format_infoArguments",
"properties": {}
}Run a multi-step image pipeline Chain multiple operations (resize, compress, convert, crop) in sequence. The image is fetched once, then each operation is applied to the output of the previous one. Max 10 operations per pipeline. ### Responses: **200**: Processed image binary (Success Response) Content-Type: application/json Content-Type: image/jpeg **Example Response:** ```json "string" ``` Content-Type: image/png **Example Response:** ```json "string" ``` Content-Type: image/webp **Example Response:** ```json "string" ```
| Argument | Type | Description |
|---|---|---|
| source* | string | Image source: a public URL (https://...) or a base64-encoded string (optionally as a data URI like data:image/png;base64,...). |
| delivery | string | |
| operations* | array | Ordered list of operations to apply sequentially. Each operation receives the output of the previous one. Max 10. |
{
"type": "object",
"title": "image_pipelineArguments",
"required": [
"source",
"operations"
],
"properties": {
"source": {
"type": "string",
"title": "source",
"description": "Image source: a public URL (https://...) or a base64-encoded string (optionally as a data URI like data:image/png;base64,...)."
},
"delivery": {
"type": "string",
"oneOf": [
{
"type": "object",
"title": "InlineDelivery",
"properties": {
"mode": {
"type": "string",
"const": "inline",
"title": "Mode",
"default": "inline"
}
},
"additionalProperties": false
},
{
"type": "object",
"title": "PutUrlDelivery",
"required": [
"mode",
"put_url"
],
"properties": {
"mode": {
"type": "string",
"const": "put_url",
"title": "Mode"
},
"headers": {
"anyOf": [
{
"type": "object",
"additionalProperties": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Headers",
"description": "Optional storage headers to include on the PUT call (Content-Type, Cache-Control, x-amz-acl, etc.). Whitelisted at SSRF layer."
},
"put_url": {
"type": "string",
"title": "Put Url",
"format": "uri",
"maxLength": 2083,
"minLength": 1,
"description": "Customer-signed presigned PUT URL where the optimized bytes will be written. Must be https://. Cloud credentials never reach our infrastructure; only the URL itself is used and discarded after the request."
}
},
"additionalProperties": false
},
{
"type": "object",
"title": "CallbackDelivery",
"required": [
"mode",
"callback_url"
],
"properties": {
"mode": {
"type": "string",
"const": "callback_url",
"title": "Mode"
},
"secret": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Secret",
"description": "Optional HMAC secret. When set, we sign the POST body with HMAC-SHA256 and send 'X-Pig-Signature: sha256=<hex>'. Used per request and never stored. Recompute the HMAC on your endpoint to authenticate the callback (constant-time compare)."
},
"headers": {
"anyOf": [
{
"type": "object",
"additionalProperties": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Headers",
"description": "Optional headers to include on the POST call (Content-Type, Cache-Control, x-amz-*, etc.). Whitelisted at SSRF layer."
},
"callback_url": {
"type": "string",
"title": "Callback Url",
"format": "uri",
"maxLength": 2083,
"minLength": 1,
"description": "Customer endpoint where the optimized bytes will be POSTed. Must be https://. For async/large jobs. We send an X-Pig-Sha256 header of the body so the receiver can verify integrity. No credentials are stored on our side; secure the endpoint with a token in the URL itself."
}
},
"additionalProperties": false
}
],
"title": "delivery",
"discriminator": {
"mapping": {
"inline": "#/components/schemas/InlineDelivery",
"put_url": "#/components/schemas/PutUrlDelivery",
"callback_url": "#/components/schemas/CallbackDelivery"
},
"propertyName": "mode"
}
},
"operations": {
"type": "array",
"items": {
"type": "object",
"title": "PipelineOperation",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"title": "Type",
"description": "Operation type: resize, compress, convert, or crop."
},
"params": {
"type": "object",
"title": "Params",
"default": {},
"description": "Operation parameters as key-value string pairs. E.g. {\"scale\": \"0.5\"} for resize, {\"format\": \"webp\"} for convert.",
"additionalProperties": {
"type": "string"
}
}
}
},
"title": "operations",
"description": "Ordered list of operations to apply sequentially. Each operation receives the output of the previous one. Max 10."
}
}
}Resize an image for a vision model Resize an image to the largest size a given vision model still benefits from, and report what it costs that model in tokens before and after. Every provider downscales oversized input before counting tokens, so this alone saves bytes and upload latency rather than tokens. Pass max_tokens to trade resolution for tokens: that lever is continuous on Claude, unavailable on OpenAI (cost follows the aspect ratio alone), and on Gemini reaches only a flat 258. An image already within budget is returned untouched and free (X-Pig-Billed: 0). ### Responses: **200**: Processed image binary (Success Response) Content-Type: application/json Content-Type: image/jpeg **Example Response:** ```json "string" ``` Content-Type: image/png **Example Response:** ```json "string" ``` Content-Type: image/webp **Example Response:** ```json "string" ```
| Argument | Type | Description |
|---|---|---|
| q | integer | Quality (1-100). Maps to libvips Q parameter. |
| format | string | Output format: jpeg, png, webp, tiff, gif, or avif. If omitted, the original format is preserved. |
| source* | string | Image source: a public URL (https://...) or a base64-encoded string (optionally as a data URI like data:image/png;base64,...). |
| delivery | string | |
| max_tokens | integer | Optional cap on what the image may cost the target model. Without it the image is resized to the model's own ceiling, which saves bytes and upload latency but no tokens, because every provider already downscales oversized input before counting. Set a budget to trade resolution for tokens. The response reports the cost actually achieved: on OpenAI it cannot be lowered by resizing at all, and on Gemini only down to a flat 258. |
Optimize an AI-generated image for the web The step after image generation. gpt-image, DALL-E, Flux, Midjourney and Stable Diffusion hand back 2-8 MB PNGs; this returns the same picture as a web-ready webp (default), avif, jpeg or png, metadata stripped, transparency kept on webp/avif/png. Optional max_dimension caps the longest side (never upscales); optional q or quality_target (smallest file with SSIM >= target, flat surcharge) control quality. Same price as convert. If the result is not smaller than the input it is still returned but free (X-Pig-Billed: 0). X-Pictomancer-Bytes-Before/-After/-Saved-Percent report the saving. The input's C2PA manifest, if any, is reported in X-Pictomancer-C2PA-Input but is not carried over: re-encoding invalidates it. ### Responses: **200**: Processed image binary (Success Response) Content-Type: application/json Content-Type: image/jpeg **Example Response:** ```json "string" ``` Content-Type: image/png **Example Response:** ```json "string" ``` Content-Type: image/webp **Example Response:** ```json "string" ```
| Argument | Type | Description |
|---|---|---|
| q | integer | Quality (1-100). Maps to libvips Q parameter. Omit to use the encoder default; or set quality_target instead. |
| strip | boolean | Strip metadata. Defaults to true: generated images carry no EXIF worth keeping. Metadata includes any C2PA manifest, which would be invalid after re-encoding anyway. |
| format | string | Output format: webp (default), avif, jpeg or png. webp, avif and png keep transparency; jpeg flattens it. |
| source* | string | Image source: a public URL (https://...) or a base64-encoded string (optionally as a data URI like data:image/png;base64,...). |
Remove the background from an image Cut the subject (person, product, animal, object) out of a photo and return it on a transparent background as png (default), webp or avif. Optional q (1-100) for webp/avif. Runs a segmentation model (U2Net) on CPU: expect a few seconds per image, not milliseconds. Not available in pipeline. ### Responses: **200**: Processed image binary (Success Response) Content-Type: application/json Content-Type: image/jpeg **Example Response:** ```json "string" ``` Content-Type: image/png **Example Response:** ```json "string" ``` Content-Type: image/webp **Example Response:** ```json "string" ```
| Argument | Type | Description |
|---|---|---|
| q | integer | Quality (1-100) for webp and avif. Ignored for png, which is lossless. Omit to use the encoder default. |
| format | string | Output format: png (default), webp or avif. All three keep the transparency; jpeg is not offered because it has none. |
| source* | string | Image source: a public URL (https://...) or a base64-encoded string (optionally as a data URI like data:image/png;base64,...). |
| delivery | string |
{
"type": "object",
"title": "remove_image_backgroundArguments",
"required": [
"source"
],
"properties": {
"q": {
"type": "integer",
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "q",
"description": "Quality (1-100) for webp and avif. Ignored for png, which is lossless. Omit to use the encoder default."
},
"format": {
"type": "string",
"title": "format",
"default": "png",
"description": "Output format: png (default), webp or avif. All three keep the transparency; jpeg is not offered because it has none."
},
"source": {
"type": "string",
"title": "source",
"description": "Image source: a public URL (https://...) or a base64-encoded string (optionally as a data URI like data:image/png;base64,...)."
},
"delivery": {
"type": "string",
"oneOf": [
{
"type": "object",
"title": "InlineDelivery",
"properties": {
"mode": {
"type": "string",
"const": "inline",
"title": "Mode",
"default": "inline"
}
},
"additionalProperties": false
},
{
"type": "object",
"title": "PutUrlDelivery",
"required": [
"mode",
"put_url"
],
"properties": {
"mode": {
"type": "string",
"const": "put_url",
"title": "Mode"
},
"headers": {
"anyOf": [
{
"type": "object",
"additionalProperties": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Headers",
"description": "Optional storage headers to include on the PUT call (Content-Type, Cache-Control, x-amz-acl, etc.). Whitelisted at SSRF layer."
},
"put_url": {
"type": "string",
"title": "Put Url",
"format": "uri",
"maxLength": 2083,
"minLength": 1,
"description": "Customer-signed presigned PUT URL where the optimized bytes will be written. Must be https://. Cloud credentials never reach our infrastructure; only the URL itself is used and discarded after the request."
}
},
"additionalProperties": false
},
{
"type": "object",
"title": "CallbackDelivery",
"required": [
"mode",
"callback_url"
],
"properties": {
"mode": {
"type": "string",
"const": "callback_url",
"title": "Mode"
},
"secret": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Secret",
"description": "Optional HMAC secret. When set, we sign the POST body with HMAC-SHA256 and send 'X-Pig-Signature: sha256=<hex>'. Used per request and never stored. Recompute the HMAC on your endpoint to authenticate the callback (constant-time compare)."
},
"headers": {
"anyOf": [
{
"type": "object",
"additionalProperties": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Headers",
"description": "Optional headers to include on the POST call (Content-Type, Cache-Control, x-amz-*, etc.). Whitelisted at SSRF layer."
},
"callback_url": {
"type": "string",
"title": "Callback Url",
"format": "uri",
"maxLength": 2083,
"minLength": 1,
"description": "Customer endpoint where the optimized bytes will be POSTed. Must be https://. For async/large jobs. We send an X-Pig-Sha256 header of the body so the receiver can verify integrity. No credentials are stored on our side; secure the endpoint with a token in the URL itself."
}
},
"additionalProperties": false
}
],
"title": "delivery",
"discriminator": {
"mapping": {
"inline": "#/components/schemas/InlineDelivery",
"put_url": "#/components/schemas/PutUrlDelivery",
"callback_url": "#/components/schemas/CallbackDelivery"
},
"propertyName": "mode"
}
}
}
}Resize an image Scale an image by a factor, or fill an exact box. Use 'scale' for uniform scaling, or 'scale_x'/'scale_y' for independent axes (float factors, e.g. 0.5 = half size). Alternatively set 'width'+'height' for fill mode: resize and smart-crop to those exact dimensions in one call (optional 'gravity', default attention). The two modes are mutually exclusive. Optional enhancement modifiers: denoise (1-3), equalize, sharpen (applied denoise -> equalize -> op -> sharpen). ### Responses: **200**: Processed image binary (Success Response) Content-Type: application/json Content-Type: image/jpeg **Example Response:** ```json "string" ``` Content-Type: image/png **Example Response:** ```json "string" ``` Content-Type: image/webp **Example Response:** ```json "string" ```
| Argument | Type | Description |
|---|---|---|
| scale | number | Uniform scale factor applied to both axes (e.g. 0.5 = half size). Use this for simple scaling; use scale_x/scale_y for independent axes. |
| width | integer | Target width in pixels for fill mode: resize and smart-crop to these exact dimensions in one call. Requires height. Mutually exclusive with scale/scale_x/scale_y. Upscaling is allowed. |
| format | string | Output format: jpeg, png, webp, tiff, gif, or avif. If omitted, the original format is preserved. |
| height | integer | Target height in pixels for fill mode. Requires width. |
| source* | string | Image source: a public URL (https://...) or a base64-encoded string (optionally as a data URI like data:image/png;base64,...). |
{
"type": "object",
"title": "compress_imageArguments",
"required": [
"source"
],
"properties": {
"q": {
"type": "integer",
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "q",
"description": "Quality (1-100). Lower = smaller file. Typical values: 60-80 for web, 85-95 for print. Maps to libvips Q parameter."
},
"strip": {
"type": "boolean",
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "strip",
"description": "Strip metadata (EXIF, ICC profile, etc.) from the output. Reduces file size slightly."
},
"format": {
"type": "string",
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "format",
"description": "Output format: jpeg, png, webp, tiff, gif, or avif. If omitted, the original format is preserved."
},
"source": {
"type": "string",
"title": "source",
"description": "Image source: a public URL (https://...) or a base64-encoded string (optionally as a data URI like data:image/png;base64,...)."
},
"autorot": {
"type": "boolean",
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "autorot",
"description": "Apply EXIF orientation before compressing. Opt-in; default false, which preserves current byte-for-byte behavior."
},
"denoise": {
"type": "integer",
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "denoise",
"description": "Median denoise before compressing: radius 1-3 (window 3x3 to 7x7). Opt-in; no surcharge."
},
"sharpen": {
"type": "boolean",
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "sharpen",
"description": "Unsharp-mask sharpen after compressing (libvips defaults). Opt-in."
},
"delivery": {
"type": "string",
"oneOf": [
{
"type": "object",
"title": "InlineDelivery",
"properties": {
"mode": {
"type": "string",
"const": "inline",
"title": "Mode",
"default": "inline"
}
},
"additionalProperties": false
},
{
"type": "object",
"title": "PutUrlDelivery",
"required": [
"mode",
"put_url"
],
"properties": {
"mode": {
"type": "string",
"const": "put_url",
"title": "Mode"
},
"headers": {
"anyOf": [
{
"type": "object",
"additionalProperties": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Headers",
"description": "Optional storage headers to include on the PUT call (Content-Type, Cache-Control, x-amz-acl, etc.). Whitelisted at SSRF layer."
},
"put_url": {
"type": "string",
"title": "Put Url",
"format": "uri",
"maxLength": 2083,
"minLength": 1,
"description": "Customer-signed presigned PUT URL where the optimized bytes will be written. Must be https://. Cloud credentials never reach our infrastructure; only the URL itself is used and discarded after the request."
}
},
"additionalProperties": false
},
{
"type": "object",
"title": "CallbackDelivery",
"required": [
"mode",
"callback_url"
],
"properties": {
"mode": {
"type": "string",
"const": "callback_url",
"title": "Mode"
},
"secret": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Secret",
"description": "Optional HMAC secret. When set, we sign the POST body with HMAC-SHA256 and send 'X-Pig-Signature: sha256=<hex>'. Used per request and never stored. Recompute the HMAC on your endpoint to authenticate the callback (constant-time compare)."
},
"headers": {
"anyOf": [
{
"type": "object",
"additionalProperties": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Headers",
"description": "Optional headers to include on the POST call (Content-Type, Cache-Control, x-amz-*, etc.). Whitelisted at SSRF layer."
},
"callback_url": {
"type": "string",
"title": "Callback Url",
"format": "uri",
"maxLength": 2083,
"minLength": 1,
"description": "Customer endpoint where the optimized bytes will be POSTed. Must be https://. For async/large jobs. We send an X-Pig-Sha256 header of the body so the receiver can verify integrity. No credentials are stored on our side; secure the endpoint with a token in the URL itself."
}
},
"additionalProperties": false
}
],
"title": "delivery",
"discriminator": {
"mapping": {
"inline": "#/components/schemas/InlineDelivery",
"put_url": "#/components/schemas/PutUrlDelivery",
"callback_url": "#/components/schemas/CallbackDelivery"
},
"propertyName": "mode"
}
},
"equalize": {
"type": "boolean",
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "equalize",
"description": "Auto-contrast (histogram equalisation of the value channel; hue and saturation preserved) before compressing. Opt-in."
},
"quality_target": {
"type": "number",
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "quality_target",
"description": "Target SSIM (0-1]: the worker searches for the smallest file that still scores at least this. Alternative to q; mutually exclusive with it. Requires an explicit format among jpeg, webp, avif. Carries a flat surcharge for the extra encodes."
}
}
}| denoise | integer | Median denoise before converting: radius 1-3 (window 3x3 to 7x7). Opt-in; no surcharge. |
| sharpen | boolean | Unsharp-mask sharpen after converting (libvips defaults). Opt-in. |
| delivery | string |
| equalize | boolean | Auto-contrast (histogram equalisation of the value channel; hue and saturation preserved) before converting. Opt-in. |
| lossless | boolean | Enable lossless encoding. Only applies to webp and avif. |
| quality_target | number | Target SSIM (0-1]: the worker searches for the smallest file that still scores at least this. Alternative to q; mutually exclusive with it and with lossless. Only for jpeg, webp, avif. Carries a flat surcharge for the extra encodes. |
{
"type": "object",
"title": "convert_imageArguments",
"required": [
"source",
"format"
],
"properties": {
"q": {
"type": "integer",
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "q",
"description": "Quality (1-100). Maps to libvips Q parameter."
},
"strip": {
"type": "boolean",
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "strip",
"description": "Strip metadata (EXIF, ICC profile, etc.) from the output."
},
"effort": {
"type": "integer",
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "effort",
"description": "AV1 encoder CPU effort (0-9). Higher = smaller file, slower. Only applies to avif."
},
"format": {
"type": "string",
"title": "format",
"description": "Target format: jpeg, png, webp, tiff, gif, or avif."
},
"source": {
"type": "string",
"title": "source",
"description": "Image source: a public URL (https://...) or a base64-encoded string (optionally as a data URI like data:image/png;base64,...)."
},
"autorot": {
"type": "boolean",
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "autorot",
"description": "Apply EXIF orientation before converting. Opt-in; default false, which preserves current byte-for-byte behavior."
},
"denoise": {
"type": "integer",
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "denoise",
"description": "Median denoise before converting: radius 1-3 (window 3x3 to 7x7). Opt-in; no surcharge."
},
"sharpen": {
"type": "boolean",
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "sharpen",
"description": "Unsharp-mask sharpen after converting (libvips defaults). Opt-in."
},
"delivery": {
"type": "string",
"oneOf": [
{
"type": "object",
"title": "InlineDelivery",
"properties": {
"mode": {
"type": "string",
"const": "inline",
"title": "Mode",
"default": "inline"
}
},
"additionalProperties": false
},
{
"type": "object",
"title": "PutUrlDelivery",
"required": [
"mode",
"put_url"
],
"properties": {
"mode": {
"type": "string",
"const": "put_url",
"title": "Mode"
},
"headers": {
"anyOf": [
{
"type": "object",
"additionalProperties": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Headers",
"description": "Optional storage headers to include on the PUT call (Content-Type, Cache-Control, x-amz-acl, etc.). Whitelisted at SSRF layer."
},
"put_url": {
"type": "string",
"title": "Put Url",
"format": "uri",
"maxLength": 2083,
"minLength": 1,
"description": "Customer-signed presigned PUT URL where the optimized bytes will be written. Must be https://. Cloud credentials never reach our infrastructure; only the URL itself is used and discarded after the request."
}
},
"additionalProperties": false
},
{
"type": "object",
"title": "CallbackDelivery",
"required": [
"mode",
"callback_url"
],
"properties": {
"mode": {
"type": "string",
"const": "callback_url",
"title": "Mode"
},
"secret": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Secret",
"description": "Optional HMAC secret. When set, we sign the POST body with HMAC-SHA256 and send 'X-Pig-Signature: sha256=<hex>'. Used per request and never stored. Recompute the HMAC on your endpoint to authenticate the callback (constant-time compare)."
},
"headers": {
"anyOf": [
{
"type": "object",
"additionalProperties": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Headers",
"description": "Optional headers to include on the POST call (Content-Type, Cache-Control, x-amz-*, etc.). Whitelisted at SSRF layer."
},
"callback_url": {
"type": "string",
"title": "Callback Url",
"format": "uri",
"maxLength": 2083,
"minLength": 1,
"description": "Customer endpoint where the optimized bytes will be POSTed. Must be https://. For async/large jobs. We send an X-Pig-Sha256 header of the body so the receiver can verify integrity. No credentials are stored on our side; secure the endpoint with a token in the URL itself."
}
},
"additionalProperties": false
}
],
"title": "delivery",
"discriminator": {
"mapping": {
"inline": "#/components/schemas/InlineDelivery",
"put_url": "#/components/schemas/PutUrlDelivery",
"callback_url": "#/components/schemas/CallbackDelivery"
},
"propertyName": "mode"
}
},
"equalize": {
"type": "boolean",
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "equalize",
"description": "Auto-contrast (histogram equalisation of the value channel; hue and saturation preserved) before converting. Opt-in."
},
"lossless": {
"type": "boolean",
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "lossless",
"description": "Enable lossless encoding. Only applies to webp and avif."
},
"quality_target": {
"type": "number",
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "quality_target",
"description": "Target SSIM (0-1]: the worker searches for the smallest file that still scores at least this. Alternative to q; mutually exclusive with it and with lossless. Only for jpeg, webp, avif. Carries a flat surcharge for the extra encodes."
}
}
}| Height of the crop rectangle in pixels. Required in manual and gravity modes. |
| source* | string | Image source: a public URL (https://...) or a base64-encoded string (optionally as a data URI like data:image/png;base64,...). |
| autorot | boolean | Apply EXIF orientation before cropping. Opt-in; default false, which preserves current byte-for-byte behavior. |
| denoise | integer | Median denoise before cropping: radius 1-3 (window 3x3 to 7x7). Opt-in; no surcharge. |
| gravity | string | Smart-crop mode: picks the window automatically. One of ('attention', 'entropy', 'centre'). Requires width and height; mutually exclusive with x/y and trim. A target larger than the source clamps to the source size. |
| sharpen | boolean | Unsharp-mask sharpen after cropping (libvips defaults). Opt-in. |
| delivery | string |
| equalize | boolean | Auto-contrast (histogram equalisation of the value channel; hue and saturation preserved) before cropping. Opt-in. |
| threshold | number | Trim sensitivity (must be positive; default 10.0). Only valid together with trim: true. |
{
"type": "object",
"title": "crop_imageArguments",
"required": [
"source"
],
"properties": {
"x": {
"type": "integer",
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "x",
"description": "Left edge of the crop rectangle in pixels. Manual mode only."
},
"y": {
"type": "integer",
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "y",
"description": "Top edge of the crop rectangle in pixels. Manual mode only."
},
"trim": {
"type": "boolean",
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "trim",
"description": "Trim mode: removes a uniform background border via content detection. Mutually exclusive with x/y/width/height/gravity."
},
"width": {
"type": "integer",
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "width",
"description": "Width of the crop rectangle in pixels. Required in manual and gravity modes."
},
"format": {
"type": "string",
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "format",
"description": "Output format: jpeg, png, webp, tiff, gif, or avif. If omitted, the original format is preserved."
},
"height": {
"type": "integer",
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "height",
"description": "Height of the crop rectangle in pixels. Required in manual and gravity modes."
},
"source": {
"type": "string",
"title": "source",
"description": "Image source: a public URL (https://...) or a base64-encoded string (optionally as a data URI like data:image/png;base64,...)."
},
"autorot": {
"type": "boolean",
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "autorot",
"description": "Apply EXIF orientation before cropping. Opt-in; default false, which preserves current byte-for-byte behavior."
},
"denoise": {
"type": "integer",
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "denoise",
"description": "Median denoise before cropping: radius 1-3 (window 3x3 to 7x7). Opt-in; no surcharge."
},
"gravity": {
"type": "string",
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "gravity",
"description": "Smart-crop mode: picks the window automatically. One of ('attention', 'entropy', 'centre'). Requires width and height; mutually exclusive with x/y and trim. A target larger than the source clamps to the source size."
},
"sharpen": {
"type": "boolean",
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "sharpen",
"description": "Unsharp-mask sharpen after cropping (libvips defaults). Opt-in."
},
"delivery": {
"type": "string",
"oneOf": [
{
"type": "object",
"title": "InlineDelivery",
"properties": {
"mode": {
"type": "string",
"const": "inline",
"title": "Mode",
"default": "inline"
}
},
"additionalProperties": false
},
{
"type": "object",
"title": "PutUrlDelivery",
"required": [
"mode",
"put_url"
],
"properties": {
"mode": {
"type": "string",
"const": "put_url",
"title": "Mode"
},
"headers": {
"anyOf": [
{
"type": "object",
"additionalProperties": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Headers",
"description": "Optional storage headers to include on the PUT call (Content-Type, Cache-Control, x-amz-acl, etc.). Whitelisted at SSRF layer."
},
"put_url": {
"type": "string",
"title": "Put Url",
"format": "uri",
"maxLength": 2083,
"minLength": 1,
"description": "Customer-signed presigned PUT URL where the optimized bytes will be written. Must be https://. Cloud credentials never reach our infrastructure; only the URL itself is used and discarded after the request."
}
},
"additionalProperties": false
},
{
"type": "object",
"title": "CallbackDelivery",
"required": [
"mode",
"callback_url"
],
"properties": {
"mode": {
"type": "string",
"const": "callback_url",
"title": "Mode"
},
"secret": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Secret",
"description": "Optional HMAC secret. When set, we sign the POST body with HMAC-SHA256 and send 'X-Pig-Signature: sha256=<hex>'. Used per request and never stored. Recompute the HMAC on your endpoint to authenticate the callback (constant-time compare)."
},
"headers": {
"anyOf": [
{
"type": "object",
"additionalProperties": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Headers",
"description": "Optional headers to include on the POST call (Content-Type, Cache-Control, x-amz-*, etc.). Whitelisted at SSRF layer."
},
"callback_url": {
"type": "string",
"title": "Callback Url",
"format": "uri",
"maxLength": 2083,
"minLength": 1,
"description": "Customer endpoint where the optimized bytes will be POSTed. Must be https://. For async/large jobs. We send an X-Pig-Sha256 header of the body so the receiver can verify integrity. No credentials are stored on our side; secure the endpoint with a token in the URL itself."
}
},
"additionalProperties": false
}
],
"title": "delivery",
"discriminator": {
"mapping": {
"inline": "#/components/schemas/InlineDelivery",
"put_url": "#/components/schemas/PutUrlDelivery",
"callback_url": "#/components/schemas/CallbackDelivery"
},
"propertyName": "mode"
}
},
"equalize": {
"type": "boolean",
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "equalize",
"description": "Auto-contrast (histogram equalisation of the value channel; hue and saturation preserved) before cropping. Opt-in."
},
"threshold": {
"type": "number",
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "threshold",
"description": "Trim sensitivity (must be positive; default 10.0). Only valid together with trim: true."
}
}
}{
"type": "object",
"title": "estimate_costArguments",
"required": [
"operation",
"input_bytes"
],
"properties": {
"format": {
"type": "string",
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "format",
"description": "Requested output format; only avif changes the price."
},
"operation": {
"type": "string",
"title": "operation",
"description": "Operation to price. One of resize, compress, convert, crop, optimize_for_vision, optimize_generated, remove_background, pipeline. analyze is always free."
},
"operations": {
"type": "array",
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "EstimateOperation",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"title": "Type",
"description": "Operation type: resize, compress, convert, or crop."
},
"format": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Format",
"description": "Requested output format for this operation; only avif changes the price."
}
}
}
},
{
"type": "null"
}
],
"title": "operations",
"description": "For pipeline only: the ordered operations, each {type, format?}. Volume discount applies at 3+ operations."
},
"input_bytes": {
"type": "integer",
"title": "input_bytes",
"minimum": 1,
"description": "Size of the input image in bytes. Get it from analyze_image (free) if you do not know it."
},
"quality_target": {
"type": "boolean",
"title": "quality_target",
"default": false,
"description": "Whether the request will use quality_target (SSIM search surcharge)."
}
}
}| target_model* | string | Vision model the image is being prepared for, e.g. claude-opus-5, gpt-4o, gemini-2.5-pro. Unknown ids are rejected rather than guessed: the wrong limits would silently resize to the wrong size. |
{
"type": "object",
"title": "optimize_for_visionArguments",
"required": [
"source",
"target_model"
],
"properties": {
"q": {
"type": "integer",
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "q",
"description": "Quality (1-100). Maps to libvips Q parameter."
},
"format": {
"type": "string",
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "format",
"description": "Output format: jpeg, png, webp, tiff, gif, or avif. If omitted, the original format is preserved."
},
"source": {
"type": "string",
"title": "source",
"description": "Image source: a public URL (https://...) or a base64-encoded string (optionally as a data URI like data:image/png;base64,...)."
},
"delivery": {
"type": "string",
"oneOf": [
{
"type": "object",
"title": "InlineDelivery",
"properties": {
"mode": {
"type": "string",
"const": "inline",
"title": "Mode",
"default": "inline"
}
},
"additionalProperties": false
},
{
"type": "object",
"title": "PutUrlDelivery",
"required": [
"mode",
"put_url"
],
"properties": {
"mode": {
"type": "string",
"const": "put_url",
"title": "Mode"
},
"headers": {
"anyOf": [
{
"type": "object",
"additionalProperties": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Headers",
"description": "Optional storage headers to include on the PUT call (Content-Type, Cache-Control, x-amz-acl, etc.). Whitelisted at SSRF layer."
},
"put_url": {
"type": "string",
"title": "Put Url",
"format": "uri",
"maxLength": 2083,
"minLength": 1,
"description": "Customer-signed presigned PUT URL where the optimized bytes will be written. Must be https://. Cloud credentials never reach our infrastructure; only the URL itself is used and discarded after the request."
}
},
"additionalProperties": false
},
{
"type": "object",
"title": "CallbackDelivery",
"required": [
"mode",
"callback_url"
],
"properties": {
"mode": {
"type": "string",
"const": "callback_url",
"title": "Mode"
},
"secret": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Secret",
"description": "Optional HMAC secret. When set, we sign the POST body with HMAC-SHA256 and send 'X-Pig-Signature: sha256=<hex>'. Used per request and never stored. Recompute the HMAC on your endpoint to authenticate the callback (constant-time compare)."
},
"headers": {
"anyOf": [
{
"type": "object",
"additionalProperties": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Headers",
"description": "Optional headers to include on the POST call (Content-Type, Cache-Control, x-amz-*, etc.). Whitelisted at SSRF layer."
},
"callback_url": {
"type": "string",
"title": "Callback Url",
"format": "uri",
"maxLength": 2083,
"minLength": 1,
"description": "Customer endpoint where the optimized bytes will be POSTed. Must be https://. For async/large jobs. We send an X-Pig-Sha256 header of the body so the receiver can verify integrity. No credentials are stored on our side; secure the endpoint with a token in the URL itself."
}
},
"additionalProperties": false
}
],
"title": "delivery",
"discriminator": {
"mapping": {
"inline": "#/components/schemas/InlineDelivery",
"put_url": "#/components/schemas/PutUrlDelivery",
"callback_url": "#/components/schemas/CallbackDelivery"
},
"propertyName": "mode"
}
},
"max_tokens": {
"type": "integer",
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "max_tokens",
"description": "Optional cap on what the image may cost the target model. Without it the image is resized to the model's own ceiling, which saves bytes and upload latency but no tokens, because every provider already downscales oversized input before counting. Set a budget to trade resolution for tokens. The response reports the cost actually achieved: on OpenAI it cannot be lowered by resizing at all, and on Gemini only down to a flat 258."
},
"target_model": {
"type": "string",
"title": "target_model",
"description": "Vision model the image is being prepared for, e.g. claude-opus-5, gpt-4o, gemini-2.5-pro. Unknown ids are rejected rather than guessed: the wrong limits would silently resize to the wrong size."
}
}
}| delivery |
| string |
| max_dimension | integer | Cap on the longest side in pixels. Larger images are scaled down to fit, aspect ratio preserved; smaller images are never upscaled. |
| quality_target | number | Target SSIM (0-1]: the worker searches for the smallest file that still scores at least this. Alternative to q; mutually exclusive with it. Carries a flat surcharge for the extra encodes. |
{
"type": "object",
"title": "optimize_generated_imageArguments",
"required": [
"source"
],
"properties": {
"q": {
"type": "integer",
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "q",
"description": "Quality (1-100). Maps to libvips Q parameter. Omit to use the encoder default; or set quality_target instead."
},
"strip": {
"type": "boolean",
"title": "strip",
"default": true,
"description": "Strip metadata. Defaults to true: generated images carry no EXIF worth keeping. Metadata includes any C2PA manifest, which would be invalid after re-encoding anyway."
},
"format": {
"type": "string",
"title": "format",
"default": "webp",
"description": "Output format: webp (default), avif, jpeg or png. webp, avif and png keep transparency; jpeg flattens it."
},
"source": {
"type": "string",
"title": "source",
"description": "Image source: a public URL (https://...) or a base64-encoded string (optionally as a data URI like data:image/png;base64,...)."
},
"delivery": {
"type": "string",
"oneOf": [
{
"type": "object",
"title": "InlineDelivery",
"properties": {
"mode": {
"type": "string",
"const": "inline",
"title": "Mode",
"default": "inline"
}
},
"additionalProperties": false
},
{
"type": "object",
"title": "PutUrlDelivery",
"required": [
"mode",
"put_url"
],
"properties": {
"mode": {
"type": "string",
"const": "put_url",
"title": "Mode"
},
"headers": {
"anyOf": [
{
"type": "object",
"additionalProperties": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Headers",
"description": "Optional storage headers to include on the PUT call (Content-Type, Cache-Control, x-amz-acl, etc.). Whitelisted at SSRF layer."
},
"put_url": {
"type": "string",
"title": "Put Url",
"format": "uri",
"maxLength": 2083,
"minLength": 1,
"description": "Customer-signed presigned PUT URL where the optimized bytes will be written. Must be https://. Cloud credentials never reach our infrastructure; only the URL itself is used and discarded after the request."
}
},
"additionalProperties": false
},
{
"type": "object",
"title": "CallbackDelivery",
"required": [
"mode",
"callback_url"
],
"properties": {
"mode": {
"type": "string",
"const": "callback_url",
"title": "Mode"
},
"secret": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Secret",
"description": "Optional HMAC secret. When set, we sign the POST body with HMAC-SHA256 and send 'X-Pig-Signature: sha256=<hex>'. Used per request and never stored. Recompute the HMAC on your endpoint to authenticate the callback (constant-time compare)."
},
"headers": {
"anyOf": [
{
"type": "object",
"additionalProperties": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Headers",
"description": "Optional headers to include on the POST call (Content-Type, Cache-Control, x-amz-*, etc.). Whitelisted at SSRF layer."
},
"callback_url": {
"type": "string",
"title": "Callback Url",
"format": "uri",
"maxLength": 2083,
"minLength": 1,
"description": "Customer endpoint where the optimized bytes will be POSTed. Must be https://. For async/large jobs. We send an X-Pig-Sha256 header of the body so the receiver can verify integrity. No credentials are stored on our side; secure the endpoint with a token in the URL itself."
}
},
"additionalProperties": false
}
],
"title": "delivery",
"discriminator": {
"mapping": {
"inline": "#/components/schemas/InlineDelivery",
"put_url": "#/components/schemas/PutUrlDelivery",
"callback_url": "#/components/schemas/CallbackDelivery"
},
"propertyName": "mode"
}
},
"max_dimension": {
"type": "integer",
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "max_dimension",
"description": "Cap on the longest side in pixels. Larger images are scaled down to fit, aspect ratio preserved; smaller images are never upscaled."
},
"quality_target": {
"type": "number",
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "quality_target",
"description": "Target SSIM (0-1]: the worker searches for the smallest file that still scores at least this. Alternative to q; mutually exclusive with it. Carries a flat surcharge for the extra encodes."
}
}
}| autorot |
| boolean |
| Apply EXIF orientation before resizing. Opt-in; default false, which preserves current byte-for-byte behavior. |
| denoise | integer | Median denoise before resizing: radius 1-3 (window 3x3 to 7x7). Opt-in; no surcharge. |
| gravity | string | Fill-mode smart-crop strategy: one of ('attention', 'entropy', 'centre'). Only valid together with width and height; defaults to attention. |
| scale_x | number | Horizontal scale factor (e.g. 0.5 = half width). If only scale_x is given, scale_y defaults to the same value. |
| scale_y | number | Vertical scale factor (e.g. 0.75 = 75% height). Optional; defaults to scale_x if omitted. |
| sharpen | boolean | Unsharp-mask sharpen after resizing (libvips defaults). Opt-in. |
| delivery | string |
| equalize | boolean | Auto-contrast (histogram equalisation of the value channel; hue and saturation preserved) before resizing. Opt-in. |
{
"type": "object",
"title": "resize_imageArguments",
"required": [
"source"
],
"properties": {
"scale": {
"type": "number",
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "scale",
"description": "Uniform scale factor applied to both axes (e.g. 0.5 = half size). Use this for simple scaling; use scale_x/scale_y for independent axes."
},
"width": {
"type": "integer",
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "width",
"description": "Target width in pixels for fill mode: resize and smart-crop to these exact dimensions in one call. Requires height. Mutually exclusive with scale/scale_x/scale_y. Upscaling is allowed."
},
"format": {
"type": "string",
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "format",
"description": "Output format: jpeg, png, webp, tiff, gif, or avif. If omitted, the original format is preserved."
},
"height": {
"type": "integer",
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "height",
"description": "Target height in pixels for fill mode. Requires width."
},
"source": {
"type": "string",
"title": "source",
"description": "Image source: a public URL (https://...) or a base64-encoded string (optionally as a data URI like data:image/png;base64,...)."
},
"autorot": {
"type": "boolean",
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "autorot",
"description": "Apply EXIF orientation before resizing. Opt-in; default false, which preserves current byte-for-byte behavior."
},
"denoise": {
"type": "integer",
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "denoise",
"description": "Median denoise before resizing: radius 1-3 (window 3x3 to 7x7). Opt-in; no surcharge."
},
"gravity": {
"type": "string",
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "gravity",
"description": "Fill-mode smart-crop strategy: one of ('attention', 'entropy', 'centre'). Only valid together with width and height; defaults to attention."
},
"scale_x": {
"type": "number",
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "scale_x",
"description": "Horizontal scale factor (e.g. 0.5 = half width). If only scale_x is given, scale_y defaults to the same value."
},
"scale_y": {
"type": "number",
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "scale_y",
"description": "Vertical scale factor (e.g. 0.75 = 75% height). Optional; defaults to scale_x if omitted."
},
"sharpen": {
"type": "boolean",
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "sharpen",
"description": "Unsharp-mask sharpen after resizing (libvips defaults). Opt-in."
},
"delivery": {
"type": "string",
"oneOf": [
{
"type": "object",
"title": "InlineDelivery",
"properties": {
"mode": {
"type": "string",
"const": "inline",
"title": "Mode",
"default": "inline"
}
},
"additionalProperties": false
},
{
"type": "object",
"title": "PutUrlDelivery",
"required": [
"mode",
"put_url"
],
"properties": {
"mode": {
"type": "string",
"const": "put_url",
"title": "Mode"
},
"headers": {
"anyOf": [
{
"type": "object",
"additionalProperties": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Headers",
"description": "Optional storage headers to include on the PUT call (Content-Type, Cache-Control, x-amz-acl, etc.). Whitelisted at SSRF layer."
},
"put_url": {
"type": "string",
"title": "Put Url",
"format": "uri",
"maxLength": 2083,
"minLength": 1,
"description": "Customer-signed presigned PUT URL where the optimized bytes will be written. Must be https://. Cloud credentials never reach our infrastructure; only the URL itself is used and discarded after the request."
}
},
"additionalProperties": false
},
{
"type": "object",
"title": "CallbackDelivery",
"required": [
"mode",
"callback_url"
],
"properties": {
"mode": {
"type": "string",
"const": "callback_url",
"title": "Mode"
},
"secret": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Secret",
"description": "Optional HMAC secret. When set, we sign the POST body with HMAC-SHA256 and send 'X-Pig-Signature: sha256=<hex>'. Used per request and never stored. Recompute the HMAC on your endpoint to authenticate the callback (constant-time compare)."
},
"headers": {
"anyOf": [
{
"type": "object",
"additionalProperties": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Headers",
"description": "Optional headers to include on the POST call (Content-Type, Cache-Control, x-amz-*, etc.). Whitelisted at SSRF layer."
},
"callback_url": {
"type": "string",
"title": "Callback Url",
"format": "uri",
"maxLength": 2083,
"minLength": 1,
"description": "Customer endpoint where the optimized bytes will be POSTed. Must be https://. For async/large jobs. We send an X-Pig-Sha256 header of the body so the receiver can verify integrity. No credentials are stored on our side; secure the endpoint with a token in the URL itself."
}
},
"additionalProperties": false
}
],
"title": "delivery",
"discriminator": {
"mapping": {
"inline": "#/components/schemas/InlineDelivery",
"put_url": "#/components/schemas/PutUrlDelivery",
"callback_url": "#/components/schemas/CallbackDelivery"
},
"propertyName": "mode"
}
},
"equalize": {
"type": "boolean",
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "equalize",
"description": "Auto-contrast (histogram equalisation of the value channel; hue and saturation preserved) before resizing. Opt-in."
}
}
}