PixHandy
Guides
DocumentationVersion 1

Recipe Contract

Portable, versioned JSON for saving and reusing batch settings.

Build a recipe

What a recipe contains

The file stores operation settings and their order. It does not contain source images, output images or account details.

Export a recipe from the batch editor and inspect it before importing it into another session.

  • PortabilityRecipes can be exported and imported in another browser session.
  • VersioningThe schema version identifies the format used by the recipe.

Strict validation

Imported JSON is size-bounded, schema-checked and normalized before execution. Unknown operations, unsafe geometry, missing watermark assets and unsupported output formats fail with explicit messages.

Validation example"quality": "82" → expected an integer from 1 to 100
pixhandy-recipe.jsonVersion 1
{
  "schema": "pixhandy/saved-recipe",
  "version": 1,
  "name": "Web-ready images",
  "plan": {
    "schema": "pixhandy/operation-plan",
    "version": 1,
    "operations": [
      { "kind": "resize", "fit": "contain", "width": 1600, "height": 1600, "allowUpscale": false },
      { "kind": "convert", "mimeType": "image/webp" },
      { "kind": "compress", "quality": 82 },
      { "kind": "strip-metadata" }
    ]
  }
}