Reference

Profile

Your profile is your identity on novem — the name, picture, bio and contact details that show up wherever your shared content appears.

AI assisted, human approved — novem uses AI to review and keep our documentation up to date.

Your profile is how you appear to the rest of novem. It collects your display name, picture, bio and registered e-mail addresses, and it backs your public profile page at https://novem.io/u/<your_username> — the page other users land on when they follow a link to your shared visualisations.

Like everything else on the platform the profile is a hierarchical folder, rooted at /admin/profile/. Each field is a file you read with GET and update with POST; folders such as emails and picture group the more involved settings.

profile                       => Your profile (/admin/profile)
├── name                      => Display name
├── bio                       => Short bio
├── description               => Longer free-form description
├── timezone                  => Your timezone (e.g. Europe/Oslo)
├── picture                   => Profile imagery
│   ├── image                 => Profile picture / avatar
│   ├── banner                => Profile banner
│   └── mask                  => Crop/framing for the picture (x,y,r)
├── emails                    => Your registered e-mail addresses
│   └── <email>               => A single address
│       ├── address           => The address itself
│       ├── status            => Verification status / challenge
│       ├── primary           => Whether this is your primary address
│       └── log               => Delivery & verification log
├── email                     => Your primary e-mail (read-only)
├── public                    => Public/private profile toggle
├── options                   => Per-field visibility on your public profile
│   ├── show_name             => Show your display name
│   ├── show_email            => Show your e-mail
│   └── show_description       => Show your description
├── password                  => Change your password (write-only)
├── overview                  => Human-readable summary (read-only)
├── url                       => Your public profile URL (read-only)
└── log                       => Profile activity log (read-only)

The fields that describe you are plain text files you write with POST.

  • name — your display name, shown alongside your username wherever your content surfaces.
  • bio — a short bio. This is the line that appears on your public profile and in your profile overview.
  • description — a longer, free-form description for when a single line isn't enough.
  • timezone — an IANA timezone such as Europe/Oslo, used to render dates and schedule-related times in your local time.
novem --post /admin/profile/name "Ada Lovelace"
novem --post /admin/profile/bio "Numbers, engines and the occasional chart."
novem --post /admin/profile/timezone "Europe/London"

Your imagery lives under picture/. Both the avatar and the banner are uploaded by POSTing the image to the corresponding endpoint, read back with GET, and removed with DELETE.

  • picture/image — your profile picture (avatar).
  • picture/banner — the wide banner shown across the top of your public profile.
  • picture/mask — controls how the picture is framed. It's a plain-text x,y,r triple giving the crop centre and radius, as percentages (e.g. 50,50,40) or pixels (120px,80px,90px).
POST/v1/admin/profile/picture/image

Note: Your avatar is also served at the convenience URL https://novem.io/v1/u/<your_username>/img, which is what embeds and link previews point at.

You can register more than one e-mail address. Each lives under emails/ as its own folder, named by the address.

  • Add an address by PUTting its name under emails/, then POST the address to its address file.
  • status drives verification: POST verify to (re)send a verification e-mail, then POST the 6-digit code from that e-mail to complete the challenge.
  • primary marks which verified address is your primary one.
  • log records delivery and verification events for that address.

The read-only email file at the profile root resolves to your effective address — your primary if set, otherwise your first verified address, otherwise the first one you added.

# register a new address
novem --put  /admin/profile/emails/work
novem --post /admin/profile/emails/work/address "ada@example.com"

# send the verification e-mail, then submit the code you receive
novem --post /admin/profile/emails/work/status verify
novem --post /admin/profile/emails/work/status 123456

# make it your primary address
novem --post /admin/profile/emails/work/primary true

A verified e-mail address is required to send mails — see the recipients page for the rules on who you're allowed to mail.

By default a profile is private. The public toggle controls whether your profile page is visible to others at all — POST true to make it public or false to take it private again.

When your profile is public, the options/ folder gives you per-field control over what's actually shown:

  • options/show_name — show your display name.
  • options/show_email — show your e-mail address.
  • options/show_description — show your description.

Each is a true/false toggle, so you can have a public profile that still keeps, say, your e-mail address hidden.

POST/v1/admin/profile/public
true

Note: Even with a private profile, content you explicitly share — publicly or with a group — stays reachable by the people you shared it with. Privacy here governs the profile page, not your individual visualisations. See social for how profiles and connections interact.

The write-only password endpoint changes your account password. It only accepts POST and never returns the current value.

POST/v1/admin/profile/password

Three read-only endpoints summarise your profile:

  • overview — a human-readable summary of your account: display name, username, e-mail, bio, avatar, subscription, member-since date and remaining invites. Handy for a quick GET to confirm how your profile looks.
  • url — your canonical public profile URL, https://novem.io/u/<your_username>.
  • log — an activity log of changes to your profile.
novem --get /admin/profile/overview

To push to a repo over SSH, register a public key on your account. Keys live under /admin/keys, addressed by name, and a single key works for all of your repos.

VerbPathDescription
GET/admin/keysList your keys
PUT/admin/keys/:keyRegister a key by name
GET/admin/keys/:keyThe key's folder
DELETE/admin/keys/:keyRemove the key
POST / GET/admin/keys/:key/keyThe public key material (e.g. an ssh-ed25519 … line)
POST / GET / DELETE/admin/keys/:key/nameDisplay name
POST / GET / DELETE/admin/keys/:key/descriptionLonger description
POST / GET / DELETE/admin/keys/:key/summaryOne-line summary
GET/admin/keys/:key/infoKey metadata (fingerprint, added date)
GET/admin/keys/:key/logThe key's activity log
GET/admin/keys/:key/shortnameUnique short id

See registering an SSH key in the repo guide for a worked example.

Two trees under /admin/notifications govern what novem tells you about and let you read what it already has.

control holds one setting per event type, grouped by class. Each leaf is a plain-text file you GET to read and POST to set to one of the option values ignore, info (default) or important. A GET on control or any class folder lists its members.

ClassPathCovers
Commentscontrol/comment/*Topics, comments, replies, mentions, reactions
Contentcontrol/content/*Created / deleted, data and config updates, theme and space changes
Jobscontrol/job/*Start, success, fail, rejected, repo / schedule / type changes
Mailscontrol/mail/*mail_sent, mail_test
Sharescontrol/share/*Something shared with you
Socialcontrol/social/*Connection and follow events, likes/faves, group and org invites
Systemcontrol/system/*Platform announcements

For example, to stop being notified when a job starts but stay notified when one fails:

novem --post /admin/notifications/control/job/job_start ignore
novem --post /admin/notifications/control/job/job_fail important

Per-resource overrides live on each resource's own notifications file (e.g. a single plot or grid), which takes precedence over these account defaults.

VerbPathDescription
GET/admin/notifications/listYour notifications
GET/admin/notifications/list/:notification/infoOne notification's detail
GET / POST/admin/notifications/list/:notification/statusRead or set read/unread status
DELETE/admin/notifications/list/:notificationDismiss a notification

  • Social — connect with and follow other users from your profile.
  • Authentication — tokens, login and the whoami endpoint.