> For the complete documentation index, see [llms.txt](https://docs.floui.io/guia/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.floui.io/guia/conectores/categorias/conectores-essenciais/rest-api.md). # REST API {% tabs %} {% tab title="Parâmetros" %}

Campo	Tipo	Descrição
Descrição	Campo de texto	Campo reservado para adicionar detalhes sobre o funcionamento do conector dentro do fluxo.
Conta de serviço	Seletor	Possibilita a seleção de uma conta de serviço do tipo Bearer Token e que concede acesso à administração dos dados na conta.
Path	Campo de texto	Refere-se à parte específica da URL que identifica um recurso ou endpoint.
Method	Seletor	Representa a ação que deve ser realizada no recurso identificado pelo caminho.
Corpo	Campo de texto	Opcional e presente em requisições como POST, PUT ou PATCH, o corpo contém os dados que estão sendo enviados ao servidor.
Additional Headers	Tabela de parâmetros	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.
Output path	Campo de texto	Refere-se a um caminho específico utilizado para a saída ou resposta do conector.

{% 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`.

Atributo	Descrição
payload { }	Conteúdo retornado pela requisição.
response { }	Contém detalhes da resposta, permitindo monitorar a integridade através do status ou mensagens de retorno.
request { }	Exibe detalhes da requisição como URL, método, parâmetros, entre outras informações.

{% endtab %} {% endtabs %} --- # 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, and the optional `goal` query parameter: ``` GET https://docs.floui.io/guia/conectores/categorias/conectores-essenciais/rest-api.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. 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.