> 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/pt-br/development-cycle/build-overview/api.md).

# API

## **O que é um pipeline API**

Um pipeline API permite configurar um pipeline com o API Trigger sem precisar abrir o Canvas desde o início. Você define os endpoints, a autenticação, o rate limiting e o CORS por uma interface dedicada na página de Pipelines, e a plataforma gera a estrutura do Canvas automaticamente.

O resultado é um pipeline com todas as rotas já configuradas e estruturado seguindo boas práticas. Para abrir o Canvas a qualquer momento, clique no botão de três pontos no card do pipeline e selecione **Abrir Canvas**. Você também pode configurar o API Trigger por lá.

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

## **Como funciona**

Ao criar um pipeline API, a plataforma monta automaticamente a seguinte estrutura no Canvas:

* Um [**API Trigger**](/documentation/connectors-and-triggers/pt-br/triggers/web-protocols/api.md) como ponto de entrada do pipeline.
* Um **Router** conectado ao trigger, responsável por direcionar as requisições para a rota correta.
* Um conector [**Block Execution**](/documentation/connectors-and-triggers/pt-br/connectors/logic/block-execution.md) ao final de cada rota, organizando o pipeline em subfluxos.
* Subfluxos [**OnProcess**](/documentation/developer-guide/pt-br/development-cycle/build-overview/pipelines/subpipelines.md#onprocess) e [**OnException**](/documentation/developer-guide/pt-br/development-cycle/build-overview/pipelines/subpipelines.md#onexception) dentro de cada Block Execution, para tratamento de respostas de sucesso e erro.
* Um menu **Endpoints** na barra lateral esquerda, com acesso rápido a todas as rotas configuradas.

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

Cada endpoint adicionado pela interface gera automaticamente essa estrutura no Canvas. Você pode configurar a lógica de cada rota abrindo os subfluxos OnProcess e OnException diretamente pela coluna **Ações** na interface de configuração.

## **Pipeline API e pipeline REST**

Ambos utilizam triggers HTTP e compartilham o mesmo ícone na listagem de pipelines. A diferença está na forma de criação e configuração:

|                                      | Pipeline API                                        | Pipeline REST   |
| ------------------------------------ | --------------------------------------------------- | --------------- |
| **Criação**                          | Interface dedicada na página de Pipelines ou Canvas | Canvas          |
| **Configuração de rotas**            | Interface dedicada ou Canvas                        | Canvas          |
| **Estrutura gerada automaticamente** | Sim                                                 | Não             |
| **Acesso ao Canvas**                 | Disponível a qualquer momento                       | Abre por padrão |

Para identificar o tipo de trigger de um pipeline na listagem, passe o cursor sobre o card. Um tooltip exibe se o trigger é [**API**](/documentation/connectors-and-triggers/pt-br/triggers/web-protocols/api.md) ou [**REST**](/documentation/connectors-and-triggers/pt-br/triggers/web-protocols/rest.md).

{% hint style="info" %}
Pipelines criados com o API Trigger antes desta funcionalidade também são atualizados para esse modelo e podem ser configurados pela interface dedicada ou diretamente no Canvas.
{% endhint %}

## **Resumo**

* Um pipeline API é criado e configurado por uma interface dedicada na página de Pipelines, sem precisar abrir o Canvas desde o início.
* A estrutura no Canvas (trigger, router, Block Execution e subfluxos) é gerada automaticamente a partir dos endpoints configurados.
* O Canvas permanece acessível a qualquer momento para ajustes e configurações avançadas.
* Pipelines REST não são afetados por essa funcionalidade.

## **Próximos passos**

Agora que você entende o conceito, leia [Como criar um pipeline API](http://link) para configurar seu primeiro pipeline passo a passo.


---

# 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/pt-br/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.