# ashim

> Self-hosted, open-source image processing platform with 45+ tools including AI/ML. Runs in a single Docker container with GPU auto-detection.

Resize, compress, convert, remove backgrounds, upscale, run OCR, and more - without sending images to external services.

## Docs

### Guide

- [Getting Started](https://ashim-hq.github.io/ashim/guide/getting-started.md)
- [Architecture](https://ashim-hq.github.io/ashim/guide/architecture.md)
- [Configuration](https://ashim-hq.github.io/ashim/guide/configuration.md)
- [Database](https://ashim-hq.github.io/ashim/guide/database.md)
- [Deployment](https://ashim-hq.github.io/ashim/guide/deployment.md)
- [Docker Image](https://ashim-hq.github.io/ashim/guide/docker-tags.md)
- [Developer guide](https://ashim-hq.github.io/ashim/guide/developer.md)
- [Translation guide](https://ashim-hq.github.io/ashim/guide/translations.md)
- [Contributing](https://ashim-hq.github.io/ashim/guide/contributing.md)

### API reference

- [REST API Reference](https://ashim-hq.github.io/ashim/api/rest.md)
- [Image engine](https://ashim-hq.github.io/ashim/api/image-engine.md)
- [AI Engine Reference](https://ashim-hq.github.io/ashim/api/ai.md)



## API Quick Reference

- Base URL: `http://localhost:1349`
- Auth: Session token via `POST /api/auth/login` or API key (`Authorization: Bearer si_...`)
- Tools: `POST /api/v1/tools/{toolId}` (multipart: file + settings JSON)
- Batch: `POST /api/v1/tools/{toolId}/batch` (multiple files, returns ZIP)
- Pipelines: `POST /api/v1/pipeline/execute` (chain tools sequentially)
- Interactive API docs on running instance: `/api/docs`
- OpenAPI spec on running instance: `/api/v1/openapi.yaml`

## Source

- [GitHub](https://github.com/ashim-hq/ashim)
- License: AGPLv3 (commercial license also available)