> For the complete documentation index, see [llms.txt](https://docs.rootcause.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.rootcause.ai/more-details/applications/application-modules/apirequestin.md).

# API Request

> The HTTP request event: body, query, headers and the sync or async response mode.

The entry point of an API application: the request that called it arrives here.

One per application — it is what gives the deployed app a callable endpoint, which is why it is created Ready and pinned. `requestSchema` is published as the endpoint's request body schema, so filling it in is what documents the API.

## At a glance

|                          |                       |
| ------------------------ | --------------------- |
| Module type              | `APIRequestIn`        |
| Category                 | Events                |
| Default tier             | `reactive`            |
| Runs on                  | `reactive`, `durable` |
| Starts a flow            | yes                   |
| Holds a body             | no                    |
| Keeps state between runs | no                    |
| Available in             | `api`                 |

## Parameters

### `requestSchema`

`SchemaEntryModel[]` · optional

The request body's shape, published as the endpoint's schema and validated against on every call.

## Inputs

*None.*

## Outputs

| Port           | Kind   | Connects to                | Description                                                                 |
| -------------- | ------ | -------------------------- | --------------------------------------------------------------------------- |
| `request-body` | `json` | `json`, `scalar`, `signal` | The parsed request body, validated against `requestSchema` when one is set. |
| `query-params` | `json` | `json`, `scalar`, `signal` | The query string, parsed.                                                   |

***

[← All application modules](/more-details/applications/application-modules.md)