> ## Documentation Index
> Fetch the complete documentation index at: https://iso8583sim.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# REST app

> REST API for iso8583sim, built with FastAPI.

`iso8583sim.web.app`

Run with `iso8583sim web` or `uvicorn iso8583sim.web.app:app`. Interactive docs are served
at /docs and the OpenAPI schema at /openapi.json.

Set ISO8583SIM\_PUBLIC=1 to run it as a public demo: LLM features are turned off, so nobody
can spend the server's API keys, and browsers on any site may call it (CORS).

## `FieldValue`

Bases: `BaseModel`

## `MessageRequest`

Bases: `BaseModel`

## `ParseResponse`

Bases: `BaseModel`

## `BuildRequest`

Bases: `BaseModel`

## `BuildResponse`

Bases: `BaseModel`

## `ValidateRequest`

Bases: `MessageRequest`

## `NetworkResult`

Bases: `BaseModel`

## `ValidateResponse`

Bases: `BaseModel`

## `ExplainRequest`

Bases: `MessageRequest`

## `ExplainResponse`

Bases: `BaseModel`

## `GenerateRequest`

Bases: `BaseModel`

## `GenerateResponse`

Bases: `BaseModel`

## `ConvertRequest`

Bases: `MessageRequest`

## `ConvertResponse`

Bases: `BaseModel`

## `HealthResponse`

Bases: `BaseModel`

## Functions

### `create_app()`

```python theme={null}
def create_app(public: bool | None = None) -> FastAPI
```

Create the REST API application.

**Parameters**

<ResponseField name="public" type="bool | None" default="None">
  Run as a public demo, with LLM features off and CORS open to any origin.
  Defaults to the ISO8583SIM\_PUBLIC environment variable.
</ResponseField>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.