Account

Whether this workspace's learned routes are shared to the public registry, and why

Acts on the workspace of the API key (or sign-in) making the call. Free workspaces share by default; a workspace that has ever paid is private by default and shares only after opting in. Run results and inputs are never published.

get/api/v1/workspace/sharing

Request

  • Base URL: https://unbrowse.ai
  • URL: https://unbrowse.ai/api/v1/workspace/sharing
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://unbrowse.ai/authorize, token URL https://unbrowse.ai/oauth/token, scopes: unbrowse)
    • HTTP bearer

Response

The effective setting

workspaceIdstring required
shareLearnedboolean required

Effective: whether a learned public read-only route is shared after its first verified run.

explicitboolean nullable

What the workspace set; null when it never chose (the plan default applies).

paidboolean required

The workspace has paid credits or a completed purchase.

reasonstring required
sharedinteger

Routes this workspace has shared so far.

publishedstring

What sharing publishes: the scrubbed route only, never run results or inputs.

Example response

{
  "reason": "paid workspace: private by default"
}

Changes

No recorded changes to this operation across all 1 revision of this API.