# Cursed API for ArchiveBox

ArchiveBox [doesn't have a web API](https://github.com/ArchiveBox/ArchiveBox/issues/496) yet. This is shitty single-endpoint API to automate page archiving. It uses subprocess to run archivebox CLI. archivebox CLI runs in new thread to avoid blocking main thread.

# Install and run

Install dependencies:

```
pip install bottle gunicorn
```

Start API on server where ArchiveBox container is running. Set actual path to docker-compose.yml.

```
ARCHIVEBOX_BIN="docker compose -f /opt/archievebox/docker-compose.yml run archivebox" python cursed_archivebox_api.py
```

# Environment

| Variable          | Default               |
| ----------------- | --------------------- |
| `ARCHIVEBOX_BIN`  | `/usr/bin/archivebox` (default for non-Docker installations) |
| `CURSED_PORT`     | `9998`                |
| `CURSED_HOST`     | `0.0.0.0`             |
| `CURSED_SERVER`   | `gunicorn` See [server backends](https://bottlepy.org/docs/dev/deployment.html#switching-the-server-backend) |

# GET /add

Query parameters:

* `url`. Resource URL
* `depth`. Archive depth. Default: 0 (current page)
* `tag`. List of comma separated tags e.g. `my_tag`, `my_tag,another_one`.

Example:

```
curl -i 'http://localhost:9998/add?url=https://example.com&depth=0&tag=api,example'
```