Skip to content

Create board

Creates a board in the workspace, visible to the workspace only. Board names are unique in a workspace: a name that exists answers that board with created: false (200) instead of a new one (201). With video_id, also saves that library video and puts it on the board; when the named board already exists and is shared, the video becomes public with it. Up to 500 boards a workspace. Needs a trial or a plan that includes boards (402 plan_limit otherwise). Same as the MCP tool create_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

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.

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.

Body · application/json

  • namestringrequired

    The board's name, up to 60 characters. 1 to 60 characters.

  • video_idstring

    Optional: a library video to save and put on the board (its id or page URL). 1 to 300 characters.

Response fields

  • boardobject

    With id, name, videos, url, share_url.

  • createdboolean

    False when the workspace already had a board by that name.

  • workspaceobject

    The workspace the request read or changed.

Responses

  • 200

    The workspace's board with that name. Body: BoardCreated.

  • 201

    The new board. Body: BoardCreated.

  • 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

    No library video with that video_id. 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.