v1

latestOpenAPI 3.1.02026-07-17186070.1 KB

Update a note (body, title, or folder)

Updates a note. Two distinct modes based on what's in the body:

  • Content edit: provide body (with optional expectedRevision for optimistic-concurrency, exactly like the UI's autosave; omit it for last-write-wins). Bumps the note's revision.
  • Metadata edit: provide title and/or folder (rename and/or move). Does not bump revision.

If body is present, the call is treated as a content edit and title / folder are ignored. To rename or move alongside a content edit, send two requests.

Uses PUT, not PATCH — vere's runtime HTTP server rejects PATCH before it reaches the agent.

put/notes/~/v1/notebooks/{host}/{name}/notes/{id}

Path parameters

hoststring required
namestring required
idinteger required

Request body

bodystring nullable
expectedRevisioninteger nullable

Optional content-edit guard

titlestring nullable

New title (metadata-edit mode)

folderinteger nullable

New parent folder id (metadata-edit mode)

Response

Updated — response carries the note-updated update

requestIdstring required

Canonical Hoon @uv (base-32 with . separators every 5 chars from the right, prefixed 0v). A correlation id for the request. OPTIONAL on POST: if you omit it (or send something that isn't a valid @uv), the server mints one and returns it in the response. You only need to supply your own if you intend to poll GET /request/{requestId} or subscribe to the SSE request stream — for the common case (read the held-open POST response inline) you can leave it out entirely.

Example response

{
  "requestId": "0v3.1k7gh.j5b2m.r8nq9",
  "body": {
    "response": {
      "host": "~zod",
      "flagName": "my-notebook-1"
    }
  }
}