# Box

> Box publishes Markdown artifacts and their assets as polished, responsive editorial pages on Cloudflare Workers. Reads are public; writes use a Bearer token.

Box is designed for agents: create an artifact with one JSON, multipart, or ZIP request and receive a short URL. Markdown supports relative images and assets, figures with captions, before/after comparison sliders, galleries, callouts, math, mermaid diagrams, tables, and footnotes. Private artifacts use expiring signed view links.

## Docs

- [API documentation](https://box.ridhom.dev/docs): endpoints, curl examples, Markdown directives, limits, errors.
- [OpenAPI specification](https://box.ridhom.dev/openapi.json): machine-readable schema for every endpoint.
- [Health](https://box.ridhom.dev/health): service and database status.

## Core endpoints

- `POST /api/artifacts` - publish JSON Markdown, multipart files, or a ZIP.
- `GET /api/artifacts` - list artifacts owned by the token.
- `GET /api/artifacts/{id}` - read metadata.
- `PUT /api/artifacts/{id}` - update title, slug, entry, visibility, expiry.
- `DELETE /api/artifacts/{id}` - delete the artifact and its bytes.
- `POST /api/artifacts/{id}/assets` - add or replace one asset.
- `POST /api/artifacts/{id}/share-link` - mint an expiring private view link.
- `POST /api/tokens` - create an API token (admin only).

## Public URLs

- `/{slug}-{shortid}` - rendered page.
- `/{slug}-{shortid}/raw` - source Markdown.
- `/{slug}-{shortid}/download` - ZIP download.
- `/{slug}-{shortid}/_files/{path}` - an asset.

## Notes

Raw HTML in Markdown is disabled. Relative asset URLs resolve under `/{slug}-{shortid}/_files/`. Limits: 25 MB per file, 150 MB per artifact, 100 files, 40 MB ZIP.