Skip to content
ShareOut ShareOut Docs

Overview

Publish, serve, and manage live web artifacts.

ShareOut REST API 1.0

Section titled “ShareOut REST API 1.0”

The ShareOut REST API lets you publish HTML artifacts, manage versions and collaborators, store data and files, and schedule jobs — all over HTTPS.

Base URL: https://shareout.site

All write endpoints require a bearer token. Store yours in ~/.shareout/credentials as { "token": "so_..." }.

Heads up: ShareOut sits behind Cloudflare. Python requests can trip a 1010 block — build your JSON in Python and pipe it to curl instead.

Information

  • OpenAPI version: 3.1.0

Operations

Section titled “ Operations ”
POST
/v1/publish
GET
/v1/artifacts
GET
/v1/artifacts/{id}
DELETE
/v1/artifacts/{id}
PATCH
/v1/artifacts/{id}
GET
/v1/artifacts/{id}/files
GET
/v1/artifacts/{id}/collaborators
POST
/v1/artifacts/{id}/collaborators
DELETE
/v1/artifacts/{id}/collaborators/{email}
POST
/v1/artifacts/{id}/transfer-ownership
POST
/v1/artifacts/{id}/favorite
DELETE
/v1/artifacts/{id}/favorite
GET
/v1/data/{artifactId}/json
PUT
/v1/data/{artifactId}/json
GET
/v1/data/{artifactId}/tables
GET
/v1/data/{artifactId}/blobs
POST
/v1/data/{artifactId}/blobs
GET
/v1/jobs
POST
/v1/jobs
GET
/v1/jobs/{id}
DELETE
/v1/jobs/{id}
PATCH
/v1/jobs/{id}
POST
/v1/jobs/{id}/run

Authentication

Section titled “ Authentication ”

bearerAuth

Section titled “bearerAuth ”

ShareOut API token (so_...) from ~/.shareout/credentials.

Security scheme type: http