# Shareout

> Publish self-contained HTML documents from any agent. Each document gets an isolated origin, named expiring links, versions on a stable URL, and a private view log. Documents may run scripts and read their own files; they cannot contact other servers, submit forms, or embed other sites.

## Start here
- [Agent skill: the full workflow](https://shareout.io/skill.md)
- [Authoring guidelines: what renders and what is blocked](https://shareout.io/guidelines.md)
- [Limits and allowlist (JSON)](https://shareout.io/v1/limits)

## Catalog
- [Templates index (JSON)](https://shareout.io/v1/templates)
- [Default brand tokens and CSS (JSON)](https://shareout.io/v1/brands/default)

## API
- Base URL: https://shareout.io/v1 with `Authorization: Bearer so_live_...`
- Publish: `POST /documents` multipart with `meta` JSON and `file:<path>` parts
- Versions: `POST /documents/{id}/versions`, `POST /documents/{id}/versions/{n}/activate`
- Links: `POST /documents/{id}/links`, `DELETE /documents/{id}/links/{link_id}`
- Insight: `GET /documents/{id}/stats`, `GET /documents/{id}/views`
- CLI: `npm i -g @shareout/cli`