SHshareout
Artifacts

Update artifact metadata

Changed on

Update visibility, name, social link-preview fields, or anonymous-access opt-ins. When instance policy holds public visibility the write still succeeds with 202 VISIBILITY_HELD (or MODERATION_HELD while an automated safety check runs) and the page stays private for now.

patch/v1/artifacts/{id}

Request

  • Base URL
    https://shareout.site
  • URL
    https://shareout.site/v1/artifacts/{id}
  • Auth
    HTTP bearer

Request body

namestring
visibility'public' | 'workspace' | 'private'

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

allow_anon_writeboolean

Let anonymous visitors mutate json/tables/blobs/datasets on public artifacts.

allow_anon_emailboolean

Let anonymous visitors send contact-form email.

allow_anon_agentboolean

Let anonymous visitors use the in-artifact AI chat agent.

allow_anon_collabboolean

Let anonymous visitors join realtime collaboration.

social_titlestring nullable
social_descriptionstring nullable
social_image_urlstring nullable

Response

Updated

idstring
namestring
slugstring
visibility'public' | 'workspace' | 'private'

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

moderation_status'approved' | 'pending' | 'blocked'

Safety review state for open visibility.

allow_anon_writeboolean
allow_anon_emailboolean
allow_anon_agentboolean
allow_anon_collabboolean
urlstring uri
thumbnail_urlstring uri nullable
workspace_idstring nullable
artifact_typestring
pausedboolean
current_versioninteger

version_no live on the production deployment (reflects rollback).

live_messagestring nullable

Change note of the live version (detail endpoint only).

live_message_source'author' | 'ai' | 'null' nullable

author when the publisher wrote live_message, ai when it was generated (detail endpoint only).

user_rolestring

Caller's role (list endpoint only).

can_editboolean

Caller may update the artifact and use the editor (detail endpoint only).

can_deleteboolean

Caller may move the artifact to Trash (detail endpoint only).

can_manage_commentsboolean

Caller may change the artifact's comment settings, such as guest comments (owner; detail endpoint only).

pagesstring[]

HTML pages of the live version, entrypoint first (detail endpoint only; present when there are 2+).

entrypointstring

The live version's entrypoint (detail endpoint only; present with pages).

is_favoriteboolean
created_atstring date-time
updated_atstring date-time nullable

Changes

  • 10f3cba6ec07Revision changes
    • info

      added the optional property to the response with the status

  • 46103f506fcaRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status