Skip to content

Share board

Turns on the board's public share link and returns it as board.shareUrl: anyone with the link sees the board, its videos and every board note, without an account. The workspace's own save notes stay private. A board already shared answers its current link unchanged. Needs a trial or a plan that includes share links (402 plan_limit otherwise). Same as the MCP tool share_board. Never counted against the allowance, as its MCP tool; the account still needs a plan (402 no_plan without one).

post/api/v1/boards/{board}/share

Authentication

OAuth token, API key or signed-in session, sent as Authorization: Bearer <token> (a session rides on its cookie). An OAuth token needs mcp:read and mcp:write. See authentication.

Path parameters

  • boardstringrequired

    The board's id, or its exact name (URL-encoded; case does not matter), from List boards. 1 to 120 characters.

Query parameters

  • workspacestring

    Optional: the workspace's id or exact name, from List workspaces. Without it, the current workspace (the one the account last opened in the app). Every answer names the workspace it acted in. 1 to 120 characters.

Response fields

  • boardobject

    With id, name, videos, url, share_url.

  • sharedboolean

  • workspaceobject

    The workspace the request read or changed.

Responses

  • 200

    Turn on a board's share link. Body: BoardShared.

  • 400

    The JSON body, an id in the path or a query parameter (workspace included) is not valid; detail names it. Body: Problem.

  • 401

    No account: send an API key, an OAuth access token or a session cookie. WWW-Authenticate names the protected-resource metadata. Body: Problem.

  • 402

    no_plan: the account has no plan, and the API comes with one. plan_limit: what this asks is not included in the account's current plan (saving videos, boards, share links or following creators), or the organization follows as many creators as its plan allows; show detail and resolution to the person. Body: Problem.

  • 403

    forbidden: the token lacks mcp:write (WWW-Authenticate carries the insufficient_scope step-up naming mcp:read mcp:write), a session call came from another site, or the account can read this workspace but not change it. workspace_locked: the workspace is past the plan's workspaces, so nothing was read or changed; use an open one (List workspaces marks the locked ones). Body: Problem.

  • 404

    The workspace has no board with that id or name; detail lists the boards it has. workspace_not_found: the organization has no workspace with that id or name (List workspaces lists them). Body: Problem.

  • 429

    Rate limit exceeded; wait Retry-After seconds. Body: Problem.

  • 500

    The request failed on our side. Body: Problem.