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

# General

## Description

This module allow to build a web service API endpoint.

## Features

* Create, modify, rename and delete existing API endpoint
* Group API endpoints into folders
* Configure behavior between different HTTP methods (GET, PATCH, PUT, POST, DELETE)
* Provide custom actions on each API endpoint via action flow
* Configure input for each endpoint based on supported channels (Header, Parameters) and types (Query, Body)
* Configure output for each endpoint with support of different data type (Text, JSON)
* Configure custom authentication layer for each of the API endpoint based on different methods (Basic Auth, OAuth2)
* Test and run the action flow itself

## Overview

![](/files/Ju4bvDcBXWBq6afSQIE6)

1. **API list tree**: Shows the list of Action created under this project, Uses file-and-folder-based hierarchical system.
2. **Method tab**: Toggle between supported HTTP methods (GET, PATCH, PUT, POST, DELETE)
3. **Edit section**: Allow to rename or delete currently selected item, and also to create new one. In addition, contains Authentication dropdown to allow changing configuration on currently selected item.
4. **View tab**: Toggle between views on the API and customize behavior for each of the components listed.
5. **Action flow**: When **Action** tab is selected, allows to construct the functionality of the API itself.


---

# 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.emobiq.com/emobiq-server/002-api/001-general.md?ask=<question>&goal=<endgoal>
```

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