> For the complete documentation index, see [llms.txt](https://docs.digibee.com/documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.digibee.com/documentation/developer-guide/development-cycle/build-overview/api.md).

# API

## **What is an API pipeline**

An API pipeline lets you set up a pipeline with the [**API Trigger**](/documentation/connectors-and-triggers/triggers/web-protocols/api.md) without opening the Canvas from the start. You configure endpoints, authentication, rate limiting, and CORS through a dedicated interface on the Pipelines page, and the platform generates the Canvas structure automatically.

The result is a pipeline with all routes already configured and structured following best practices. To open the Canvas at any point, click the three-dots button on the pipeline card and select **Open Canvas**. You can also configure the API Trigger there.

<figure><img src="/files/5cKF0kf41fjD1Is5YLdD" alt=""><figcaption></figcaption></figure>

## **How it works**

When you create an API pipeline, the platform automatically builds the following structure in the Canvas:

* An **API Trigger** as the pipeline entry point.
* A **Router** connected to the trigger, responsible for directing requests to the correct route.
* A [**Block Execution**](/documentation/connectors-and-triggers/connectors/logic/block-execution.md) connector at the end of each route, organizing the pipeline into subflows.
* [**OnProcess**](/documentation/developer-guide/development-cycle/build-overview/pipelines/subpipelines.md#onprocess) and [**OnException**](/documentation/developer-guide/development-cycle/build-overview/pipelines/subpipelines.md#onexception) subflows inside each Block Execution, for handling success and error responses.
* An **Endpoints** menu in the left sidebar, with quick access to all configured routes.

<figure><img src="/files/gY0Xb7p1Yi5RE4iaFfmD" alt=""><figcaption></figcaption></figure>

Each endpoint added through the interface automatically generates this structure in the Canvas. You can configure the logic for each route by opening the OnProcess and OnException subflows directly from the **Actions** column in the configuration interface.

## **API pipeline and REST pipeline**

Both use HTTP triggers and share the same icon in the pipeline listing. The difference lies in how they are created and configured:

|                                       | API pipeline                                        | REST pipeline    |
| ------------------------------------- | --------------------------------------------------- | ---------------- |
| **Creation**                          | Dedicated interface on the Pipelines page or Canvas | Canvas           |
| **Route configuration**               | Dedicated interface or Canvas                       | Canvas           |
| **Automatically generated structure** | Yes                                                 | No               |
| **Canvas access**                     | Available at any point                              | Opens by default |

To identify the trigger type of a pipeline in the listing, hover over the card. A tooltip displays whether the trigger is [**API**](/documentation/connectors-and-triggers/triggers/web-protocols/api.md) or [**REST**](/documentation/connectors-and-triggers/triggers/web-protocols/rest.md).

{% hint style="info" %}
Pipelines created with the API Trigger before this feature are also updated to this model and can be configured either through the dedicated interface or directly inside the Canvas.
{% endhint %}

## **Summary**

* An API pipeline is created and configured through a dedicated interface on the Pipelines page, without needing to open the Canvas from the start.
* The Canvas structure (trigger, router, Block Execution, and subflows) is generated automatically from the configured endpoints.
* The Canvas remains accessible at any point for adjustments and advanced configurations.
* REST pipelines are not affected by this feature.

## **Next steps**

Now that you understand the concept, read [How to create an API pipeline](http://link) to configure your first pipeline step by step.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.digibee.com/documentation/developer-guide/development-cycle/build-overview/api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.