# REST API

{% tabs %}
{% tab title="Parâmetros" %}

<figure><img src="/files/e1sKqNerKfxjsXH8a1X9" alt=""><figcaption><p>Parâmetros de configuração</p></figcaption></figure>

<table><thead><tr><th width="246">Campo</th><th width="128">Tipo</th><th>Descrição</th></tr></thead><tbody><tr><td>Descrição</td><td>Campo de texto</td><td>Campo reservado para adicionar detalhes sobre o funcionamento do conector dentro do fluxo.</td></tr><tr><td>Conta de serviço</td><td>Seletor</td><td>Possibilita a seleção de uma conta de serviço do tipo Bearer Token e que concede acesso à administração dos dados na conta.</td></tr><tr><td>Path</td><td>Campo de texto</td><td>Refere-se à parte específica da URL que identifica um recurso ou endpoint.</td></tr><tr><td>Method</td><td>Seletor</td><td>Representa a ação que deve ser realizada no recurso identificado pelo caminho.</td></tr><tr><td>Corpo</td><td>Campo de texto</td><td>Opcional e presente em requisições como POST, PUT ou PATCH, o corpo contém os dados que estão sendo enviados ao servidor. </td></tr><tr><td>Additional Headers</td><td>Tabela de parâmetros</td><td>Os cabeçalhos adicionais referem-se a informações extra incluídas em uma requisição HTTP para fornecer detalhes específicos sobre a requisição.</td></tr><tr><td>Output path</td><td>Campo de texto</td><td>Refere-se a um caminho específico utilizado para a saída ou resposta do conector.</td></tr></tbody></table>
{% endtab %}

{% tab title="Payload" %}

### **Payload**

Ao final da execução, serão retornados os dados da resposta da requisição realizada para a URL informada no conector, além de dados adicionais na mensagem contendo metadados da requisição e a resposta do servidor por meio dos atributos `response` e `request`.

<figure><img src="/files/mpOuCb2ZcC9pBZCzkrP6" alt=""><figcaption><p>Exemplo de request</p></figcaption></figure>

<table data-column-title-hidden data-view="cards"><thead><tr><th>Atributo</th><th>Descrição</th></tr></thead><tbody><tr><td><strong>payload { }</strong></td><td>Conteúdo retornado pela requisição.</td></tr><tr><td><strong>response { }</strong></td><td>Contém detalhes da resposta, permitindo monitorar a integridade através do status ou mensagens de retorno.</td></tr><tr><td><strong>request { }</strong></td><td>Exibe detalhes da requisição como URL, método, parâmetros, entre outras informações.</td></tr></tbody></table>
{% endtab %}
{% endtabs %}


---

# Agent Instructions: 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.floui.io/guia/conectores/categorias/conectores-essenciais/rest-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.
