getOperate

API Reference

Knowledge Base

Our Demo

Contact Us

getOperate is a feature-rich platform that allows you to build endpoints, cron jobs, workflows & UIs. Each of these features can be used standalone.

Get started with getOperate

getOperate is a platform to build all your internal tools (endpoints, workflows, UIs) through the combination of code (in Typescript, Python, Go, Bash, SQL or any docker image) and low code builders.

Overview

Developer platform for APIs, critical jobs, workflows, data pipelines and UIs

Core Concepts

We supports scripts in Python, TypeScript, Go, Bash and Sql.

Connect Your Data

In this quick start guide, we will write our first script in Python. getOperate provides a Python 3.11 environment.

Script Quickstart

The present document will introduce you to Flows and how to build your first one.

Flows Quickstart

Welcome to the Apps Quickstart! This page will provide you with the necessary knowledge to build your first applications in a matter of minutes.

Apps Quickstart

Triggering Scripts

Triggering Flows

Workers are autonomous processes that run one script at a time using the entire cpu and memory available to them. They are at the basis of getOperate's architecture as run the jobs. The number of workers can be horizontally scaled up or down depending on needs without any overhead. Each worker on getOperate can run up to 26 million jobs a month, where each job lasts approximately 100ms.

Workers and Worker Groups

Build, schedule, and monitor your jobs, alerts, and ETL tasks.

This component allows you to create a decision tree. The decision tree is controlled by a flow-like structure. Each node in the tree represents a decision point and can lead to one or more subsequent nodes based on specified conditions.

Nodes

For loops is a special type of steps that allows you to iterate over a list of items, given by an iterator expression.

Loops

Conditional tabs are tabs that are displayed only if a condition is met. The conditions are an array of conditions. Conditions are evaluated in order. The first condition that evaluates to true will render its subgrid. If no condition evaluates to true, the last subgrid will be rendered.

Condition

Trigger scripts are designed to pull data from an external source and  return all of the new items since the last run, without resorting to external webhooks.  A trigger script is intended to be used with [schedules](/workflows/events/schedules)  and [states](#) (rich objects in JSON, persistent from one run to another) in order to compare  the execution to the previous one and process each new item in a [for loop](/workflows/events/loops).  If there are no new items, the flow will be skipped.

Triggers

An ETL is nothing else than a DAG of jobs, each of them reading datasets as input, running computation, and producing new datasets (or updating them).

Data Pipelines

getOperate provides the same set of features as CRON, but with a user interface and control panels. It allows you to define Schedules for Scripts and Flows. Once a schedule is defined, the script will automatically run at the set frequency. Think of it as an easy-to-use scheduler similar to CRON that you can share with other users.

Schedules

Webhooks are a way to interact with getOperate using standard web technologies.

Webhooks

There are 5 ways to do error handling in getOperate.

Error Handling

When writing scripts, you may want to reuse variables, or safely pass secrets to scripts. You can do that with Variables. getOperate has user-defined variables and contextual variables.

Variables and Secrets

On top of its integrated editors (scripts, flows, apps), getOperate allows users to see and test what they are building directly from the editor, even before deployment.

Instant Preview & Testing

Each workspace has a dedicated Runs menu that allows you to visualise all past and future runs.

Monitor Past and Future Runs

In getOperate, Scripts are the basis of all major features (they are the steps of flows, linked to apps components, or can be run as standalone).

Script Editor

getOperate's Flow Editor allows you to build flows with a low-code builder.

Flow Editor

The app editor is a low-code builder to create custom User Interfaces with a mix of drag-and-drop and code.

App Editor

The code editor is getOperate's integrated development environment. It allows you to write code in TypeScript, Python, Go, Bash, SQL, or even running any docker container through getOperate's Bash support.

Code Editor

Although getOperate provides a comprehensive [App editor](/introduction/quickstart/apps-quickstart) to turn scripts and workflows into custom UIs, you might want to import your own Apps in React.

React App Import

Vue App Import

Svelte App Import

When writing scripts, you may want to reuse variables, or safely pass secrets to scripts. You can do that with `Variables`. getOperate has user-defined variables and contextual variables.

Manage changes to scripts workflows, apps and resources using commits & push on remote repositories.

Version Control

To install the getOperate CLI, follow these steps:

Installation

Scripts

Flows

Apps

Resources

Variables

Folder

getOperate has its own integrated development environment, but you can also develop and run scripts locally, both with self-hosted and cloud instances.

Local Development

Deploy to Prod

getOperate supports Single Sign-On for Microsoft, Google, GitHub, GitLab, Okta, and domain restriction.

Introduction

Worksflows

Developer

Get started with getOperate

Scripts

Flows

Apps