Skip to content

Set video note

Writes the workspace's note on a saved video (why it's worth keeping, what to borrow), or with board that board's own note on it. Replaces the note there, and the old text is not kept; an empty note clears it. A board's own note is public when the board is shared. The video must be saved, or on the board, first (404 otherwise). Up to 500 characters. Open on every plan. Same as the MCP tool set_video_note. Never counted against the allowance, as its MCP tool; the account still needs a plan (402 no_plan without one).

put/api/v1/saved-videos/{id}/note

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

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

  • notestringrequired

    The note; "" clears it.

  • boardstring

    Optional: the board (id or exact name, from List boards) whose own note to write. Without it, the note on the saved video. 1 to 120 characters.

Response fields

  • videoobject

    With id, url.

  • boardobject

    With id, name.

  • notestring or null

    The note as stored; null once cleared.

  • workspaceobject

    The workspace the request read or changed.

Responses

  • 200

    Write the note on a saved video. Body: VideoNote.

  • 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 video is not saved, or not on the board named, or the workspace has no board by that id or name. 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.