Add Request to Queue with fal.ai API on Monthly Schedule from Schedule API

Pipedream makes it easy to connect APIs for fal.ai, Schedule and 2,400+ other apps remarkably fast.

Trigger workflow on

Monthly Schedule from the Schedule API

Next, do this

Add Request to Queue with the fal.ai API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Schedule trigger and fal.ai action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Monthly Schedule trigger
1. Connect your Schedule account
2. Configure Cron Schedule
Configure the Add Request to Queue action
1. Connect your fal.ai account
2. Configure App ID
3. Configure Data
4. Optional- Configure Rerun Enabled
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are 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.

Trigger#

Monthly Schedule on Schedule

Description:Trigger your workflow on one or more days each month at a specific time (with timezone support).

Version:0.0.2

Key:schedule-monthly

View on GitHub

Schedule Overview#

The Schedule app in Pipedream is a powerful tool that allows you to trigger workflows at regular intervals, ranging from every minute to once a year. This enables the automation of repetitive tasks and the scheduling of actions to occur without manual intervention. By leveraging this API, you can execute code, run integrations, and process data on a reliable schedule, all within Pipedream's serverless environment.

Trigger Code#

import schedule from "../../schedule.app.mjs";

export default {
  name: "Monthly Schedule",
  version: "0.0.2",
  key: "schedule-monthly",
  type: "source",
  description: "Trigger your workflow on one or more days each month at a specific time (with timezone support).",
  props: {
    schedule,
    cron: {
      propDefinition: [
        schedule,
        "cron",
      ],
      default: {
        cron: "0 10 1 * *",
      },
    },
  },
};

Trigger 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.

Label	Prop	Type	Description
Schedule	`schedule`	`app`	This component uses the Schedule app.
Cron Schedule	`cron`	`$.interface.timer`	Enter a cron expression

Trigger Authentication#

The Schedule API does not require authentication.

About Schedule#

Trigger workflows on an interval or cron schedule.

Action#

Add Request to Queue on fal.ai

Description:Adds a request to the queue for asynchronous processing, including specifying a webhook URL for receiving updates. [See the documentation](https://fal.ai/docs/model-endpoints/queue#queue-endpoints).

Version:0.0.1

Key:fal_ai-add-request-to-queue

View on GitHub

Action Code#

import app from "../../fal_ai.app.mjs";

export default {
  key: "fal_ai-add-request-to-queue",
  name: "Add Request to Queue",
  description: "Adds a request to the queue for asynchronous processing, including specifying a webhook URL for receiving updates. [See the documentation](https://fal.ai/docs/model-endpoints/queue#queue-endpoints).",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    appId: {
      propDefinition: [
        app,
        "appId",
      ],
    },
    data: {
      type: "object",
      label: "Data",
      description: "Additional data to include with the request. [See the documentation](https://fal.ai/models/fal-ai/lora/api#schema-input) for more input fields.",
      default: {
        model_name: "stabilityai/stable-diffusion-xl-base-1.0",
        prompt: "Photo of a european medieval 40 year old queen, silver hair, highly detailed face, detailed eyes, head shot, intricate crown, age spots, wrinkles",
      },
    },
    reRunEnabled: {
      type: "boolean",
      label: "Rerun Enabled",
      description: "Enable the step to rerun to retrieve the request response. [See the documentation](https://pipedream.com/docs/code/nodejs/rerun/#flowrerun).",
      optional: true,
      reloadProps: true,
      default: false,
    },
  },
  additionalProps() {
    if (this.reRunEnabled) {
      return {
        reRunTimeoutInSecs: {
          type: "integer",
          label: "Rerun Timeout",
          description: "The time in seconds to wait before rerunning the step to retrieve the request response. Eg. `30`. [See the documentation](https://pipedream.com/docs/code/nodejs/rerun/#flowrerun).",
          optional: true,
          min: 10,
        },
      };
    }

    return {
      falWebhook: {
        type: "string",
        label: "Webhook URL",
        description: "The URL to receive updates via webhook.",
        optional: true,
      },
    };
  },
  methods: {
    addToQueue({
      appId, ...args
    } = {}) {
      return this.app.post({
        path: `/${appId}`,
        ...args,
      });
    },
  },
  async run({ $ }) {
    const {
      context: {
        run: {
          runs,
          callback_request: callbackRequest,
        },
      },
    } = $;

    const {
      app,
      addToQueue,
      appId,
      data,
      falWebhook,
      reRunEnabled,
      reRunTimeoutInSecs,
    } = this;

    if (!reRunEnabled) {
      const response = await addToQueue({
        $,
        appId,
        params: {
          fal_webhook: falWebhook,
        },
        data,
      });

      $.export("$summary", `Successfully added the request to the queue with ID \`${response.request_id}\`.`);
      return response;
    }

    if (runs === 1) {
      const timeout = 1000 * (reRunTimeoutInSecs || 10);
      const { resume_url: resumeUrl } = $.flow.rerun(timeout, null, 1);

      return addToQueue({
        $,
        appId,
        params: {
          fal_webhook: resumeUrl,
        },
        data,
      });
    }

    const response = await app.getRequestResponse({
      $,
      appId,
      requestId: callbackRequest.body?.request_id,
    });

    $.export("$summary", "Successfully retrieved the request response.");
    return response;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
fal.ai	`app`	`app`	This component uses the fal.ai app.
App ID	`appId`	`string`	The unique identifier for the app. Eg. `lora`.
Data	`data`	`object`	Additional data to include with the request. See the documentation for more input fields.
Rerun Enabled	`reRunEnabled`	`boolean`	Enable the step to rerun to retrieve the request response. See the documentation.

Action Authentication#

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