Skip to content

Source editor

Non-HTML artifacts have a browser-based source editor at /a/{slug}/edit. It shares the same URL pattern and access rules as the visual studio but opens instead of it when the artifact type is markdown, txt, json, or csv.

URLPurposeAccess
/a/{slug}/editSource editorOwner and editor collaborators (session required)
/a/{slug}/Live viewerBased on artifact visibility

Unauthenticated requests redirect to Google login with redirect=/a/{slug}/edit.

TypeDefault entry pointMIME
markdownindex.mdtext/markdown
txtindex.txttext/plain
jsonindex.jsonapplication/json
csvindex.csvtext/csv

HTML artifacts route to the visual studio instead. Sending an HTML artifact’s slug to /edit opens the visual studio, not this editor.

POST /a/{slug}/edit/source/publish
Content-Type: application/json
Cookie: shareout_session=…
{ "content": "# Updated doc\n\nNew content here." }

Response (200):

{
"success": true,
"versionNo": 3,
"url": "https://shareout.site/a/my-doc/"
}

Each publish creates a new artifact version, updates type metadata (row counts, table of contents, etc.), and invalidates deployment caches.

Errors:

CodeStatusCause
INVALID_REQUEST400Missing content field
UNSUPPORTED400Artifact type is not source-editable (e.g. html)
ARTIFACT_NOT_FOUND404Slug does not resolve

Agents should use POST /v1/publish to create or update text artifacts programmatically — not the source editor endpoint. The source editor is for human owners editing in the browser.

To update an existing text artifact via the API, re-publish with the same slug in the same workspace. Dedup matches on display_slug and versions in place.