Introduction

Integrate Erathos with your Modern data stack.

This feature is in Beta.

About the API

The Erathos API is designed to enable seamless programmatic interaction with our platform, allowing you to customize workflows to suit your architecture and specific requirements.

There are two main use cases that guided the development of the Erathos API:

• Trigger Jobs Outside Erathos: At the end of a job execution, the Erathos platform makes a request to a specified endpoint, allowing external systems to receive updates or act on the results.
• Trigger Jobs in Erathos: Job executions can be initiated by external agents, such as orchestration tools like Airflow or other third-party systems, ensuring seamless integration with your existing workflows.

Quickstart

Access our quick-start examples for a faster and more streamlined implementation.

Airflow

Dbt Cloud

Erathos

Prefect

Concepts

Authentication

Metadata

Rules

Variables and Secrets

API Reference

To view details about the available endpoints, visit the following pages:

Jobs

Orchestration

Secrets

Variables

Workspaces

Limitations

This section outlines the constraints and boundaries of the Orchestration feature to help you better understand its current capabilities. Being aware of these limitations ensures optimal usage while avoiding unexpected behavior or errors in your workflows.

Job Dependencies

For API connectors, dependent jobs may exist, meaning certain endpoints require data from the primary endpoint. For instance, a primary endpoint that lists users might have a dependent endpoint that provides detailed information about each user based on their identifier.

These dependent jobs cannot run independently. To execute a dependent job, the primary job must be executed first. When the primary job runs, all its dependent jobs are automatically executed afterward.

Block Window

Programmatic use of the Run endpoint is treated as a manual execution, equivalent to initiating a new manual execution directly through the platform. Similarly, if a Block Window is configured for the same time as the Run orchestration and the Allow manual executions indicator is disabled, new executions will be blocked, and the API will return a 400 response, preventing the execution from starting.