Turn a document's public link on or off | Basement Gateway

Enable or disable a document’s public link. When enabled, returns a public URL that serves the document as markdown (no login). Requires write access.

Authentication

AuthorizationBearer

A Basement key (bsmt_...), from Agents, Connect in the app.

Request

This endpoint expects an object.

docIdstringRequired

The document ID from list_docs

enabledbooleanRequired

true to share publicly, false to revoke

Response

The tool's answer.

sharedboolean

publicUrlstring or null

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

429

Too Many Requests Error

500

Internal Server Error