← ShortPixel

Optimize Image with ShortPixel API

Pipedream makes it easy to connect APIs for ShortPixel and 2,500+ other apps remarkably fast.

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Optimize Image with the ShortPixel API
No credit card required
Intro to Pipedream
Watch us build a workflow
Watch us build a workflow
8 min
Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo
Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo

Developers Pipedream

Getting Started

Create a workflow to Optimize Image with the ShortPixel API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Optimize Image action
    1. Connect your ShortPixel account
    2. Configure URL
    3. Optional- Configure Width
    4. Optional- Configure Height
    5. Optional- Select a Crop Style
    6. Optional- Select a Quality
    7. Optional- Configure Filename
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Optimize Image with ShortPixel API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + ShortPixel
 
Try it
Optimize Image with ShortPixel API on New Submission from Typeform API
Typeform + ShortPixel
 
Try it
Optimize Image with ShortPixel API on New Submission (Instant) from Jotform API
Jotform + ShortPixel
 
Try it
Optimize Image with ShortPixel API on New Scheduled Tasks from Pipedream API
Pipedream + ShortPixel
 
Try it
Optimize Image with ShortPixel API on New Download Counts from npm API
npm + ShortPixel
 
Try it

Details

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Optimize Image on ShortPixel
Description:Optimize and/or adjust an image using ShortPixel. [See the documentation](https://shortpixel.com/knowledge-base/article/shortpixel-adaptive-images-api-parameters/)
Version:0.0.1
Key:shortpixel-optimize-image

Code

import shortpixel from "../../shortpixel.app.mjs";
import { ConfigurationError } from "@pipedream/platform";
import fs from "fs";

export default {
  key: "shortpixel-optimize-image",
  name: "Optimize Image",
  description: "Optimize and/or adjust an image using ShortPixel. [See the documentation](https://shortpixel.com/knowledge-base/article/shortpixel-adaptive-images-api-parameters/)",
  version: "0.0.1",
  type: "action",
  props: {
    shortpixel,
    url: {
      type: "string",
      label: "URL",
      description: "The URL of the image to optimize",
    },
    width: {
      type: "integer",
      label: "Width",
      description: "The width in pixels of the new image",
      optional: true,
    },
    height: {
      type: "integer",
      label: "Height",
      description: "The height in pixels of the new image",
      optional: true,
    },
    cropStyle: {
      type: "string",
      label: "Crop Style",
      description: "The crop style, useful when both width and height are specified",
      options: [
        "top",
        "right",
        "bottom",
        "left",
        "center",
      ],
      optional: true,
    },
    quality: {
      type: "string",
      label: "Quality",
      description: "The quality setting of the new image",
      options: [
        "lqip",
        "lossless",
        "glossy",
        "lossy",
      ],
      optional: true,
    },
    filename: {
      type: "string",
      label: "Filename",
      description: "Optionally, enter a filename that will be used to save the image in /tmp",
      optional: true,
    },
  },
  methods: {
    buildParams() {
      const paramArray = [
        "ret_wait ",
      ];
      if (this.width) {
        paramArray.push(`w_${this.width}`);
      }
      if (this.height) {
        paramArray.push(`h_${this.height}`);
      }
      if (this.cropStyle) {
        paramArray.push(`c_${this.cropStyle}`);
      }
      if (this.quality) {
        paramArray.push(`q_${this.quality}`);
      }
      return paramArray.join(",");
    },
    downloadFileToTmp(file, filePath) {
      const rawcontent = file.toString("base64");
      const buffer = Buffer.from(rawcontent, "base64");
      fs.writeFileSync(filePath, buffer);
    },
  },
  async run({ $ }) {
    if (!this.width && !this.height && !this.cropStyle && !this.quality) {
      throw new ConfigurationError("Must enter at least one of `width`, `height`, `cropStyle`, or `quality`");
    }

    const params = this.buildParams();

    let response = {
      url: `${this.shortpixel._baseUrl()}/client/${params}/${this.url}`,
    };

    try {
      const image = await this.shortpixel.optimizeImage({
        $,
        params,
        url: this.url,
        responseType: "arraybuffer",
      });
      if (this.filename) {
        const filePath = this.filename.includes("tmp/")
          ? this.filename
          : `/tmp/${this.filename}`;
        this.downloadFileToTmp(image, filePath);
        response.filePath = filePath;
      }
    } catch {
      throw new Error(`Unable to process image at URL: ${this.url}`);
    }

    return response;
  },
};

Configuration

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.
LabelPropTypeDescription
ShortPixelshortpixelappThis component uses the ShortPixel app.
URLurlstring

The URL of the image to optimize

Widthwidthinteger

The width in pixels of the new image

Heightheightinteger

The height in pixels of the new image

Crop StylecropStylestringSelect a value from the drop down menu:toprightbottomleftcenter
QualityqualitystringSelect a value from the drop down menu:lqiplosslessglossylossy
Filenamefilenamestring

Optionally, enter a filename that will be used to save the image in /tmp

Authentication

ShortPixel uses API keys for authentication. When you connect your ShortPixel account, Pipedream securely stores the keys so you can easily authenticate to ShortPixel APIs in both code and no-code steps.

Sign in and copy your API key from the API Keys page.

About ShortPixel

ShortPixel is an image optimizer that improves website performance by resizing, compressing and serving images from CDN. Optimized images are smaller and visually similar with the original images.

Explore Other Apps

1
-
24
of
2,500+
apps by most popular

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.
Premium
Salesforce
Salesforce
Web services API for interacting with Salesforce
Premium
HubSpot
HubSpot
HubSpot's CRM platform contains the marketing, sales, service, operations, and website-building software you need to grow your business.
Premium
Zoho CRM
Zoho CRM
Zoho CRM is an online Sales CRM software that manages your sales, marketing, and support in one CRM platform.
Premium
Stripe
Stripe
Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.
Shopify
Shopify
Shopify is a complete commerce platform that lets anyone start, manage, and grow a business. You can use Shopify to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.
Premium
WooCommerce
WooCommerce
WooCommerce is the open-source ecommerce platform for WordPress.
Premium
Snowflake
Snowflake
A data warehouse built for the cloud
Premium
MongoDB
MongoDB
MongoDB is an open source NoSQL database management program.
Supabase
Supabase
Supabase is an open source Firebase alternative.
MySQL
MySQL
MySQL is an open-source relational database management system.
PostgreSQL
PostgreSQL
PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
Premium
AWS
AWS
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Premium
Twilio SendGrid
Twilio SendGrid
Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.
Amazon SES
Amazon SES
Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation
Premium
Klaviyo
Klaviyo
Email Marketing and SMS Marketing Platform
Premium
Zendesk
Zendesk
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
Slack
Slack
Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.
Microsoft Teams
Microsoft Teams
Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.
Schedule
Schedule
Trigger workflows on an interval or cron schedule.