Run Model with Summit API on Custom Interval from Schedule API

Pipedream makes it easy to connect APIs for Summit, Schedule and 2,800+ other apps remarkably fast.

Trigger workflow on

Custom Interval from the Schedule API

Next, do this

Run Model with the Summit 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 Summit action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Custom Interval trigger
1. Connect your Schedule account
2. Configure Cron Schedule
Configure the Run Model action
1. Connect your Summit account
2. Select a Model
3. Optional- Configure Experimental Flatten
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#

Custom Interval on Schedule

Description:Trigger your workflow every N hours, minutes or seconds.

Version:0.0.2

Key:schedule-custom-interval

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: "Custom Interval",
  version: "0.0.2",
  key: "schedule-custom-interval",
  type: "source",
  description: "Trigger your workflow every N hours, minutes or seconds.",
  props: {
    schedule,
    cron: {
      propDefinition: [
        schedule,
        "cron",
      ],
    },
  },
};

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#

Run Model on Summit

Description:Executes a model within Summit and captures the response fields. [See the documentation](https://summit.readme.io/reference/model-api)

Version:0.0.2

Key:summit-run-model

View on GitHub

Action Code#

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

export default {
  key: "summit-run-model",
  name: "Run Model",
  description: "Executes a model within Summit and captures the response fields. [See the documentation](https://summit.readme.io/reference/model-api)",
  version: "0.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    summit,
    model: {
      propDefinition: [
        summit,
        "model",
      ],
      reloadProps: true,
    },
    experimentalFlatten: {
      type: "integer",
      label: "Experimental Flatten",
      description: "This allows you to choose the index of the column you'd like to pull from the grid. -1 is the last column, which is useful for grabbing the last slice of a time series model, like a forecast.",
      optional: true,
    },
  },
  async additionalProps() {
    const props = {};
    if (!this.model) {
      return props;
    }
    const { parameters } = await this.summit.getModel({
      model: this.model,
    });
    for (const parameter of parameters) {
      props[parameter.name] = {
        type: "string",
        label: `${parameter.name}`,
        default: `${parameter.default_value}`,
      };
      if (parameter.value_choices) {
        props[parameter.name].options = parameter.value_choices;
      }
    }
    return props;
  },
  async run({ $ }) {
    const { parameters } = await this.summit.getModel({
      model: this.model,
    });
    const parametersObj = {};
    for (const parameter of parameters) {
      parametersObj[parameter.name] = this[parameter.name];
    }
    const data = {
      parameters: parametersObj,
    };
    if (this.experimentalFlatten !== undefined) {
      data.output = {
        "__experimental_flatten": this.experimentalFlatten,
      };
    }
    const response = await this.summit.runModel({
      $,
      model: this.model,
      data,
    });
    $.export("$summary", `Successfully executed model \`${(this.model).split("/").pop()}\``);
    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
Summit	`summit`	`app`	This component uses the Summit app.
Model	`model`	`string`	Select a value from the drop down menu.
Experimental Flatten	`experimentalFlatten`	`integer`	This allows you to choose the index of the column you'd like to pull from the grid. -1 is the last column, which is useful for grabbing the last slice of a time series model, like a forecast.