> For the complete documentation index, see [llms.txt](https://docs.kiln.tech/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.kiln.tech/developers/rest-api.md).

# Rest API

[![PyPI - Version](https://img.shields.io/pypi/v/kiln-server.svg?logo=pypi\&label=PyPI\&logoColor=gold)](https://pypi.org/project/kiln-server/) [![Docs](https://img.shields.io/badge/docs-OpenAPI-blue)](https://kiln-ai.github.io/Kiln/kiln_server_openapi_docs/index.html)

We also offer an open-source self-hostable REST API (web API) for Kiln, based on [FastAPI](https://fastapi.tiangolo.com).

To install the Kiln rest API, run the following command:

```bash
pip install kiln_server
```

### Docs

The [REST API docs](https://kiln-ai.github.io/Kiln/kiln_server_openapi_docs/index.html) explain the endpoints, parameters, response format, and errors.

### Client Side Libraries

The REST API supports OpenAPI, which means you can generate typed client libraries for almost any language using code generators:

* [OpenAPI Generator List](https://openapi-generator.tech/docs/generators/)
* [Swagger Codegen](https://github.com/swagger-api/swagger-codegen)