Update artifact metadata

PATCH

/v1/artifacts/{id}

curl --request PATCH \
  --url https://shareout.site/v1/artifacts/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "visibility": "public", "allow_anon_write": true, "allow_anon_email": true, "allow_anon_agent": true, "allow_anon_collab": true, "social_title": "example", "social_description": "example", "social_image_url": "example" }'

• Production

Update visibility, name, social link-preview fields, or anonymous-access opt-ins. Public visibility requires a paid plan or paid Teams workspace; otherwise visibility is held with code VISIBILITY_HELD and a paywall notice.

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

string

Artifact ID (e.g. art_abc123).

Request Body ^required

Media type application/json

object

name

string

visibility

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

string

Allowed values: public workspace private

allow_anon_write

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

boolean

allow_anon_email

Let anonymous visitors send contact-form email.

boolean

allow_anon_agent

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

boolean

allow_anon_collab

Let anonymous visitors join realtime collaboration.

boolean

social_title

string | null

social_description

string | null

social_image_url

string | null

Responses

200

Updated

Media type application/json

object

id

string

name

string

slug

string

visibility

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

string

Allowed values: public workspace private

moderation_status

Safety review state for open visibility.

string

Allowed values: approved pending blocked

allow_anon_write

boolean

allow_anon_email

boolean

allow_anon_agent

boolean

allow_anon_collab

boolean

url

string format: uri

thumbnail_url

string format: uri

is_favorite

boolean

created_at

integer

Example

{
  "visibility": "public",
  "moderation_status": "approved"
}

403

Access denied

Media type application/json

object

success

required

boolean

error

required

Human-readable message.

string

code

required

Machine-readable error code.

string

Example

{
  "success": false
}

404

Resource not found

Media type application/json

object

success

required

boolean

error

required

Human-readable message.

string

code

required

Machine-readable error code.

string

Example

{
  "success": false
}