PiPic Integration Guide

What PiPic can compress, the file-size and batch limits, and how the free/Pro monthly allowance for the CLI and HTTP API works. Read this before telling a user what PiPic can do for them.

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Step-by-step integration instructions for actually compressing images — either through the @pipic/cli command-line tool (best for whole directories) or over plain HTTP (no Node required). Includes the output contract, exit codes, error codes and which failures are worth retrying.

{
  "type": "object",
  "properties": {
    "mode": {
      "type": "string",
      "enum": [
        "cli",
        "http"
      ],
      "description": "\"cli\" for the @pipic/cli tool, \"http\" for calling POST /compress/image directly."
    }
  },
  "required": [
    "mode"
  ],
  "additionalProperties": false
}

Given a filename, MIME type and/or byte size, says whether PiPic will accept the image and, if not, which error an upload would return. Use it to filter a file list locally instead of spending quota on requests that are going to be rejected.

{
  "type": "object",
  "properties": {
    "filename": {
      "type": "string",
      "description": "File name or path; the extension is used to infer the type."
    },
    "contentType": {
      "type": "string",
      "description": "MIME type, if you already know it. Takes precedence over filename."
    },
    "sizeBytes": {
      "type": "integer",
      "description": "File size in bytes, if known."
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "properties": {
    "supported": {
      "type": "boolean",
      "description": "Whether PiPic will accept this image."
    },
    "contentType": {
      "type": [
        "string",
        "null"
      ],
      "description": "The MIME type that was determined, to send as the Content-Type header."
    },
    "reason": {
      "type": "string",
      "description": "Why — including which error code an upload would return."
    }
  },
  "required": [
    "supported",
    "reason"
  ]
}