Skip to content
ShareOut Docs
Search
Ctrl
K
Cancel
shareout.site
Select theme
Dark
Light
Auto
Select language
English
Español
Menu
✨ Get started
What is ShareOut?
What can you make?
Make your first page
Your workspace (Home)
Folder guides
Files & deliverables
🎨 Build your page
Change anything
Photos & content
Collect replies (forms)
Lists & data
Add a smart assistant
🔌 Connect your tools
Connect your tools
Connect Claude or ChatGPT
Google Sheets
Your store & other tools
⚡ Put it on autopilot
Automations
Receive email
🔗 Share & manage
Share it
Work together
Review & approvals
Version history
Show people only their data
Get help
Public artifacts (policy)
Start here
Introduction
Quickstart
Authentication
Self-host
Overview
Data plane smoke
Secrets
AI provider
Email
Architecture
Ops
Threat model
Guides
Publishing artifacts
Multi-page artifacts
Data provenance
Storing data
Scheduling jobs
Metric alerts
AI chat agent
Fast rendering
Telegram bot
Slack bot
Your data is portable
Browser SDK
Overview
JSON store
Libraries
Tables
Editable grid
Realtime
Blobs
Files
Email
Python
Comments
Google Sheets store
Connections
Data sources
Datasets
Live data
MCP connections
Secrets
AI agent
Page Pilot
Crew
Templates
Crew
Overview
Tools
Patterns & examples
SDK & API
Integrations
Overview
Google Sheets
BigQuery
Snowflake
S3, Supabase, Redshift & Aurora
Google Analytics
Google Ads
Facebook Ads
Shopify
Tienda Nube
Slack
GitHub
CORS proxy
Artifact spec
Overview
Manifest
Bindings
Templates
Pages
Access policy
Visual editor
Source editor
Slides
Overview
Authoring
SDK API
Presenter mode
Viewer analytics
Dashboards
Overview
Data sources
Widgets & charts
SDK API
Mobile & PWA
Overview
PWA
UI components
Overview
Components
Teams & Enterprise
Overview
Workspaces
Folders
Bring your files from Drive / SharePoint
External sharing
Client portals
Custom subdomain
Workspace SSO
Custom domain
Workspace connections
Workspace assistant
Skill Marketplace
Data catalog
Workspace Knowledge
Workspace Library
Templates
Homepage
Admin
Security & governance by plan
API
API reference
REST API
Overview
Publish
Overview
Publish an artifact
Artifacts
Overview
List artifacts
Get an artifact
Delete an artifact (soft delete)
Update artifact metadata
Export artifact as zip
Present this — AI-generate a slides deck
Archive all unused personal pages
Live concurrent viewer count
Deliver channel status
Deliver artifact now
List Slack channels for Deliver picker
List soft-deleted artifacts (trash)
Restore a soft-deleted artifact
Re-point production at an older version (deprecated)
List published versions
Read one version's source
Restore an older version (non-destructive)
Get artifact files
Request publish approval
Approve or reject a publish request
Upvote a skill
Remove skill upvote
Save skill to My Skills
Remove skill from My Skills
List skills attached to an artifact
Attach a skill to an artifact
Search
Overview
Ranked fuzzy search
Ask your workspace (single-turn Q&A)
Palette search index
Palette deep search
List recent palette searches
Record a palette search
Remove recent palette searches
Collaborators
Overview
List collaborators
Add collaborators
Remove a collaborator
Transfer ownership
Access requests
Overview
Request access to a private page
List pending access requests for your pages
Approve or deny an access request
Support
Overview
List support tickets
Create a support ticket
Get ticket and thread
Append a message (customer reply re-opens)
Staff approve and send reply on origin channel
Update ticket status (staff)
Favorites
Overview
Favorite an artifact
Unfavorite an artifact
Data
Overview
Read the artifact JSON store
Replace the artifact JSON store
List comments
Comments settings
Change comments settings
Guest comment status
Sign the guest out
Email a guest comment code
Confirm a guest comment code
Resolve or reopen a comment
Assign a comment (action item)
List tables
Share one of this artifact's tables with the workspace (Teams)
Query a workspace-shared table (Teams)
List tables shared into a workspace (Teams)
Run a platform connector endpoint
Blobs
Overview
List blobs
Request an upload URL
Confirm a direct upload
Storage usage
Get blob metadata
Delete a blob
Download blob bytes
Get a download URL
Jobs
Overview
List jobs
Create a job
Get a job
Delete a job
Update a job
Run a job now
Folders
Overview
List personal folders
Create a folder
Delete a folder
Rename or update a folder
Move an artifact into a folder
List Team Space folders
Create a Team Space folder
Get a Team Space folder by slug path
Get a Team Space folder
Delete a Team Space folder
Update a Team Space folder
Move a workspace artifact into a Team Space folder
Knowledge
Overview
Knowledge settings and counts
Turn Knowledge on or off
Learning progress (last 24h)
Re-learn the corpus, even at unchanged versions
Queue existing pages and Files for learning
All knowledge notes grouped by kind (no bodies)
Knowledge notes learned from one artifact
Read one knowledge note
Write a knowledge note
Delete a knowledge note
Search the workspace's Files and pages
List entities the workspace is about
One entity with facts, connections and evidence
Entity graph (nodes + edges)
Indexed sources
Knowledge cost for this workspace
Tokens
Overview
List my API tokens
Create an API token
Revoke one of my API tokens
Assets
Overview
Stream workspace file content (latest version)
List deliverables and loose files
Create a public delivery link
List sent delivery links
Revoke a delivery link
File imports
Overview
Configured drives, my connections, and imported folders
Start the read-only file consent
OAuth redirect URI (browser only)
Disconnect my drive
Browse my drive's folders
Import a folder
Stop syncing a folder
Change daily sync or conversion
Sync again
Run progress and per-file problems
External sharing
Overview
List client orgs
Create a client org
Get a client org
Delete a client org
Update a client org
List grants
Create a grant
Revoke a grant
Share a file or folder with one person by email
List read receipts across all clients
Who opened what in a shared folder
Folder guest comments
Turn folder guest comments on or off
List client note files
Read a client note
Create or replace a client note
Delete a client note
Metric alerts
Overview
List metric watches on an artifact
Create a metric watch
Delete a metric watch
List metric definitions
Create or update a metric definition
Delete a metric definition
List alert rules
Create an alert rule
Get an alert rule
Delete an alert rule
Update an alert rule
Evaluate an alert now
Recent evaluation history
Templates
Overview
List templates
Create a template
Get a template
Delete a template
Update a template
Preview an inline template
Preview a saved template
Artifact templates
Overview
List templates installable in a workspace (or your personal space)
Save an artifact or a folder as a template
Preview what a template would include and leave behind
Which template an artifact was installed from, and whether an update is available
Update an installed copy to the template's latest version
Get a template (items, schemas, setup steps, versions)
Delete a template (installed copies stay)
Change name, description, tags, scope, shares or preview image
Publish a new version from the template's source (or another artifact_id / folder_id)
Install a template into a workspace (or your personal space)
The template's preview image
Account
Overview
Which features are enabled
Auth
Overview
Who am I
Start CLI device login
Poll device login for token
Home
Overview
Activity feed (Needs You + Pulse)
Review state of an artifact
Approve a version (or withdraw approval)
Palette search index
Palette deep search
List recent palette searches
Record a palette search
Remove recent palette searches
Dismiss activity notifications
List activity visibility settings
Set activity visibility for one kind
Setup checklist status
Dismiss the setup checklist
Acknowledge the "Get the skill" onboarding task
Record the one-shot 100% celebration moment
Create a blank document or one from a template
Import a dropped or pasted file as an artifact
Proactive daily AI brief
Transcribe voice input for the Home agent
Workspaces
Overview
Invite people by email (bulk)
List pending invites
Revoke a pending invite
Resend an invite, or mint a shareable link
List workspace guidance (context) files
Set the entry file
Read a guidance file
Create or replace a guidance file
Delete a guidance file
Workspace audit log
Export all workspace artifacts as zip
Archive all unused workspace pages
List workspaces
Create a workspace
Get subdomain status
Enable a custom subdomain
Disable the custom subdomain
List workspace connectors
Create a workspace connector
Test connector credentials (no save)
Update a workspace connector
Workspace assistant chat (SSE)
Confirm a workspace assistant action
List workspace feature flags
Get workspace publish policy
Set workspace publish policy
List publish approval requests
List workspace Agent tokens (service accounts)
Mint a workspace Agent token
Revoke a workspace Agent token
List official Recommended by ShareOut skills
Browse skill marketplace catalog
Publish a new skill from markdown
List skill categories
List skills saved by the current user
Raw SKILL.md for in-Studio viewer
Agent-installable catalog of the workspace's skills
Set the default edit policy for new skills
Installer script for a workspace's skills
The skill as a markdown file
Set who may change this skill
List proposed changes to a skill
Propose a change to a skill
Read one proposed change, with the current body to compare against
Merge, reject or withdraw a proposed change
List skills attached to my agent
Attach a skill to my agent
Detach a skill from my agent
Catalog
Overview
Search the data catalog
Enable or disable the catalog
Seed catalog from workspace connectors
Catalog adoption manifest
Full lineage graph
Get one catalog entry
Upsert a catalog markdown file
Delete a catalog file
Instance admin
Overview
Provision a customer workspace in one step
Webhooks
Outbound artifact webhook
shareout.site
Select theme
Dark
Light
Auto
Select language
English
Español
Overview
Knowledge
Section titled “Knowledge”
Per-workspace learned knowledge — notes, search, entities.
Operations
Section titled “Operations”
GET
/v1/workspaces/{workspaceId}/knowledge
POST
/v1/workspaces/{workspaceId}/knowledge/enable
GET
/v1/workspaces/{workspaceId}/knowledge/status
POST
/v1/workspaces/{workspaceId}/knowledge/reindex
POST
/v1/workspaces/{workspaceId}/knowledge/backfill
GET
/v1/workspaces/{workspaceId}/knowledge/tree
GET
/v1/workspaces/{workspaceId}/knowledge/from/{artifactId}
GET
/v1/workspaces/{workspaceId}/knowledge/files/{path}
PUT
/v1/workspaces/{workspaceId}/knowledge/files/{path}
DELETE
/v1/workspaces/{workspaceId}/knowledge/files/{path}
GET
/v1/workspaces/{workspaceId}/knowledge/search
GET
/v1/workspaces/{workspaceId}/knowledge/entities
GET
/v1/workspaces/{workspaceId}/knowledge/entities/{entityId}
GET
/v1/workspaces/{workspaceId}/knowledge/graph
GET
/v1/workspaces/{workspaceId}/knowledge/sources
GET
/v1/workspaces/{workspaceId}/knowledge/usage