Skip to content
ShareOut ShareOut Docs

Publish an artifact

POST
/v1/publish
 
curl --request POST \
  --url https://shareout.site/v1/publish \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "My App", "slug": "my-app", "entrypoint": "index.html", "visibility": "public", "files": [ { "path": "index.html", "content": "<!DOCTYPE html><h1>Hello</h1>", "mime": "text/html", "encoding": "utf8" } ] }'

Create a new artifact or push a new version of an existing one.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
object
name
required

Display name.

string
slug

URL slug. Auto-generated if omitted.

string
entrypoint
string
default: index.html
files
required
Array<object>
object
path
required
string
content
required
string
mime
string
encoding
string
Allowed values: utf8 base64
size_bytes
integer
visibility

‘unlisted’ was retired 2026-07 — still accepted as input and treated as ‘public’.

string
Allowed values: public workspace private
mobile_html
string
pwa
object
enabled
boolean
name
string
short_name
string
<= 12 characters
icon

Data URL or absolute URL to a PNG icon.

string
access_policy

Row-level access policy for per-viewer data filtering.

object
agent

Turns on the visitor chat agent.

object
enabled
boolean
default: true
systemPrompt
string
model
string
maxTokens
integer
temperature
number
contextJson
boolean
default: true
contextTables
Array<string>
Examples
Example minimal

Single HTML file

{
  "name": "My App",
  "slug": "my-app",
  "entrypoint": "index.html",
  "visibility": "public",
  "files": [
    {
      "path": "index.html",
      "content": "<!DOCTYPE html><h1>Hello</h1>",
      "mime": "text/html",
      "encoding": "utf8"
    }
  ]
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Published

Media type application/json
object
artifact
object
id
string
version
object
id
string
version_no
integer
deployment
object
slug
string
url
string format: uri
subdomain_url

Preferred share URL for workspace artifacts (https://{workspace}.shareout.site/{slug}/). Omitted for personal artifacts.

string format: uri
mobile_url
string format: uri
editor_readiness

Advisory HTML editor-readiness profile (HTML artifacts only). Never blocks publishing.

object
manifest
string
Allowed values: valid invalid missing
outline
boolean
counts
object
pages
integer
bindings
integer
templates
integer
summary
object
errors
integer
warnings
integer
infos
integer
findings
Array<object>
object
rule
string
level
string
message
string
suggestion
string
disables
string
pwa
object
manifest_url
string format: uri
installable
boolean
notice

Human-readable message when publish was adjusted (governance, caps, email gate).

string
approval_required

Present when workspace policy requires teammate approval before going open.

object
required

Number of approvers the requester must nominate.

integer
artifact_id
string
moderation
object
status
string
Allowed values: approved pending blocked
message
string
Example 
{
  "editor_readiness": {
    "manifest": "valid"
  },
  "moderation": {
    "status": "approved"
  }
}

400

Section titled “400 ”

Invalid request

Media type application/json
object
success
required
boolean
error
required

Human-readable message.

string
code
required

Machine-readable error code.

string
Example 
{
  "success": false
}

401

Section titled “401 ”

Authentication required

Media type application/json
object
success
required
boolean
error
required

Human-readable message.

string
code
required

Machine-readable error code.

string
Example 
{
  "success": false
}

409

Section titled “409 ”

Slug taken or version conflict

Media type application/json
object
success
required
boolean
error
required

Human-readable message.

string
code
required

Machine-readable error code.

string
Example 
{
  "success": false
}