notes

Append by filename, creating the note on first touch

The stream primitive: the first call creates the note (append-only by default), every later call appends. Atomic: the text is added as a new entry (top or bottom per the note's direction). At the per-note byte cap an append-only note rolls over: the full note is renamed <filename>.<n>, a successor takes its name and settings, and rolled_over_from names the closed segment; an append addressed to a closed segment lands on the live note. Only a text that would not fit even an empty note, or a roll-over blocked by the note or storage cap, is refused with 413 content_too_large.

post/notes/by-filename/{filename}/append

Request

  • Base URL: https://freshjots.com/api/v1
  • URL: https://freshjots.com/api/v1/notes/by-filename/{filename}/append
  • Auth: HTTP bearer

Path parameters

filenamestring required

Exact filename (no slash).

Headers

Idempotency-Keystring

Any unique string per logical write; a replay with the same body returns the first response.

Request body

textstring required
append_onlyboolean

First touch only: lock the new note append-only.

client_encryptedboolean

First touch only: mark the new note client-encrypted (personal notes only).

Response

Appended to the existing note.

idinteger required

The note the text landed on (the successor after a roll-over).

append_onlyboolean required
byte_sizeinteger required
bytes_remaininginteger required
storage_usedinteger required
storage_capinteger nullable
updated_atstring date-time required
filenamestring required
createdboolean required
client_encryptedboolean required

Changes

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