> For the complete documentation index, see [llms.txt](https://docs.erathos.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.erathos.com/api/introduction.md).

# Introduction

Integrate Erathos with your Modern data stack.

{% hint style="info" %}
This feature is in Beta.
{% endhint %}

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

<figure><img src="https://2158418640-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FovVtDtJhcLYgikyBBku0%2Fuploads%2FbmNA7m9oeiEioQ0Opz3K%2FCopy%20of%20Untitled%20drawing.png?alt=media&amp;token=13b441a5-4b3c-445d-a036-0d5e3b6ccb7b" alt=""><figcaption></figcaption></figure>

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

* [**Trigger Jobs Outside Erathos**](/api/introduction/trigger-jobs-outside-erathos.md): 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**](/api/introduction/trigger-jobs-in-erathos.md): 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.

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td>Airflow</td><td><a href="/api/quickstart/airflow.md">Airflow</a></td></tr><tr><td>Dbt Cloud</td><td><a href="/api/quickstart/dbt-cloud.md">Dbt Cloud</a></td></tr><tr><td>Erathos</td><td><a href="/api/quickstart/erathos.md">Erathos</a></td></tr><tr><td>Prefect</td><td><a href="/api/quickstart/prefect.md">Prefect</a></td></tr></tbody></table>

## Concepts

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td>Authentication</td><td><a href="/api/concepts/authentication.md">Authentication</a></td></tr><tr><td>Metadata</td><td><a href="/api/concepts/metadata.md">Metadata</a></td></tr><tr><td>Rules</td><td><a href="/api/concepts/rules.md">Rules</a></td></tr><tr><td>Variables and Secrets</td><td><a href="/api/concepts/variables-and-secrets.md">Variables and secrets</a></td></tr></tbody></table>

## API Reference

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

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td>Jobs</td><td><a href="/api/api-reference/jobs.md">Jobs</a></td></tr><tr><td>Orchestration</td><td><a href="/api/api-reference/orchestration.md">Orchestration</a></td></tr><tr><td>Secrets</td><td><a href="/api/api-reference/secrets.md">Secrets</a></td></tr><tr><td>Variables</td><td><a href="/api/api-reference/variables.md">Variables</a></td></tr><tr><td>Workspaces</td><td><a href="/api/api-reference/workspaces.md">Workspaces</a></td></tr></tbody></table>

## 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**](/api/api-reference/jobs.md#developers-workspaces-workspace_id-jobs-_id-run) endpoint is treated as a manual execution, equivalent to initiating a new manual execution directly through the platform. Similarly, if a [Block Window](/platform/connections/block-window.md) 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.
