List documents in the uselink workspace bound to the active PAT. Returns id, title, slug, status, and timestamps. Supports filtering by status and free-text search.

Read the full content of a uselink document by id OR slug (exactly one is required). Returns title, content, format, published status, and metadata.

Free-text search across documents in the workspace bound to the active PAT. Thin wrapper over uselink_list_documents with the search field set.

List threaded comments on a document.

List assets (images, files) attached to a document.

Create a new draft document in the uselink workspace bound to the active PAT. Returns the created document including its id, slug, and edit URL. Content can be omitted and added later via uselink_update_document. Pass project_id and/or folder_id to drop the doc directly into that location; otherwise it lands in the user's default project at the root.

Move a document into a different project and/or folder. Pass project_id (required) plus an optional folder_id; omit folder_id to land at the project root.

Update an existing uselink document's title, content, or format. Only provided fields are changed. This updates the draft only — call uselink_publish_document to make changes public.

Publish a uselink document. Snapshots the current draft into the published version and makes it accessible via the public URL. Returns the document with its public URL.

Unpublish a uselink document, removing it from public access. The draft is preserved.

Delete a uselink document. The document is removed and the public URL stops working.

Upload a single image or file from the local filesystem and attach it to a uselink document. Returns the asset with its CDN URL. Use the returned URL in your document's HTML/Markdown.

Upload a zip archive containing an HTML page and its referenced assets. The server extracts the zip, stores every asset, rewrites references to CDN URLs, and returns the rewritten HTML plus the list of assets created and skipped.

Post a reply to an existing comment thread on a uselink document. Replies are nested under the parent comment.

Mark a comment thread on a uselink document as resolved.

List projects the active PAT can see. Workspace-scoped tokens see projects in that workspace; personal tokens see the user's personal projects. Returns id, name, slug, default flag, archive state, document count.

Read a single project by id.

Create a new project. Workspace is inferred from the PAT — workspace-scoped tokens create inside that workspace, personal tokens create a personal project. Slug is auto-generated from the name if omitted.

Update a project's name and/or slug. Only provided fields change.

Soft-archive a project. Its documents stay accessible by direct URL but no longer appear in listings.

Restore a previously archived project.

Rename a project's URL slug. The old slug stops resolving immediately.

Check whether a project slug is available in the PAT's workspace. Returns { available, suggestion? }.

Make this the user's default project. Newly created documents (when no explicit project is given) land here.

Move a personal project into a workspace.

Remove a project from its workspace and return it to the user's personal projects.

List folders in a project. Pass parent_folder_id to list children of a specific folder; omit it to list folders at the project root. Returns folders plus a parent_breadcrumb for navigation.

Read a single folder by id, including doc / live / draft counts.

Create a new folder inside a project. Omit parent_folder_id to create at the project root, or pass a folder id to nest. Slug is auto-generated from the name if omitted.

Update a folder's name, slug, or color. Only provided fields change.

Re-parent a folder. Omit parent_folder_id to move the folder to the project root, or pass a folder id to nest under it.

Delete a folder. Documents inside the folder are NOT deleted — they are moved back to the project root.

Set the user's public URL handle. Required once before publishing the first document. Call this when publish returns USERNAME_REQUIRED. Handle format: 3-30 lowercase letters/digits/hyphens (no leading/trailing hyphen). Returns the updated user.

One-shot publish: create a draft document, upload every local referenced in the HTML as an asset, rewrite the HTML to point to CDN URLs, save the rewritten HTML to the document, and publish it. Returns the public URL plus a list of assets uploaded and any rewrites applied. Use this when you have an HTML document with relative image paths and want to publish it to uselink in a single step.