Introduction
ShareOut turns an idea into a live web page on your self-hosted instance. You send files, you get a URL. From there, the same page can hold data, take uploads, send email, and run on a schedule — all through one REST API.
No instance yet? Install / self-host first.
The core idea: an artifact
Section titled “The core idea: an artifact”Everything you publish is an artifact — a versioned bundle of files served at a live URL.
- Files — HTML, CSS, JS, images. The entrypoint is
index.htmlby default. - Versions — every publish creates a new version. Roll forward, never lose history.
- Visibility —
private,workspace, orpublic(anyone on the internet with the link). - Data — each artifact has its own JSON store, tables, and file blobs.
- Jobs — scheduled or event-driven tasks attached to the artifact.
What you can do over the API
Section titled “What you can do over the API”| You want to… | Endpoint |
|---|---|
| Publish or update a page | POST /v1/publish |
| List and manage artifacts | /v1/artifacts |
| Read or write artifact data | /v1/data/{id}/json |
| Store files | /v1/data/{id}/blobs |
| Schedule a task | /v1/jobs |
| Share with collaborators | /v1/artifacts/{id}/collaborators |
Base URL
Section titled “Base URL”Use your instance origin ($ORIGIN) — the workers.dev URL or custom domain
from install. There is no public ShareOut API host.
# from ~/.shareout/credentials → "origin", or:export SHAREOUT_ORIGIN=https://shareout.<your-account>.workers.devReady to publish your first page? Head to the Quickstart.