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

# API usage overview

The document root is configured to point directly inside the imengine/ folder. This means that all requests originate from `https://[IMENGINE_DOMAIN]/imengine/`

The index file as image.php so you can either request at `/`, or `/image.php`.

### Features

The API has three main features: Generate an image, purge image cache and health check.

|       |              |                                                                                                        |
| :---: | ------------ | ------------------------------------------------------------------------------------------------------ |
| `GET` | */*          | Get an image generated from function                                                                   |
| `GET` | */health*    | Will return 200 if the service is considered OK                                                        |
| `GET` | */purge.php* | Removes all versions of the image from S3 and queue up a wildcard invalidation for the specific image. |

### Using the API

We use query string parameters for all responses in the Imengine API. The format for query string parameters is the full resource URL followed by a question mark, and the parameters.

Some of the parameters are mandatory depending on the requested resource and some, like `function`, have there own set of parameters that will have to be provided if used.