# {py:mod}`arelle.api.Session`

```{py:module} arelle.api.Session
```

```{autodoc2-docstring} arelle.api.Session
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`Session <arelle.api.Session.Session>`
  - ```{autodoc2-docstring} arelle.api.Session.Session
    :summary:
    ```
````

### API

`````{py:class} Session()
:canonical: arelle.api.Session.Session

```{autodoc2-docstring} arelle.api.Session.Session
```

```{rubric} Initialization
```

```{autodoc2-docstring} arelle.api.Session.Session.__init__
```

````{py:method} clear_logs() -> None
:canonical: arelle.api.Session.Session.clear_logs

```{autodoc2-docstring} arelle.api.Session.Session.clear_logs
```

````

````{py:method} close() -> None
:canonical: arelle.api.Session.Session.close

```{autodoc2-docstring} arelle.api.Session.Session.close
```

````

````{py:method} get_log_messages() -> list[dict[str, typing.Any]]
:canonical: arelle.api.Session.Session.get_log_messages

```{autodoc2-docstring} arelle.api.Session.Session.get_log_messages
```

````

````{py:method} get_logs(log_format: typing.Literal[json, text, xml], clear_logs: bool = False) -> str
:canonical: arelle.api.Session.Session.get_logs

```{autodoc2-docstring} arelle.api.Session.Session.get_logs
```

````

````{py:method} get_models() -> list[arelle.ModelXbrl.ModelXbrl]
:canonical: arelle.api.Session.Session.get_models

```{autodoc2-docstring} arelle.api.Session.Session.get_models
```

````

````{py:method} run(options: arelle.RuntimeOptions.RuntimeOptions, sourceZipStream: typing.BinaryIO | arelle.FileSource.FileNamedBytesIO | None = None, responseZipStream: typing.BinaryIO | None = None, logHandler: logging.Handler | None = None, logFilters: list[logging.Filter] | None = None, logFileName: pathlib.Path | arelle.Cntlr.TypeLogFileName | None = None) -> bool
:canonical: arelle.api.Session.Session.run

```{autodoc2-docstring} arelle.api.Session.Session.run
```

````

`````