Users

Update the current user

Edits the account's display name and whether it receives usage alerts. At least one field is required, so a request that misspelled a field is rejected rather than answered with a silent 200. Send name: null to clear the name.

With usage_alerts on, the account is emailed once each time its model credit, its runs this month or its indexed storage reaches 75%, 90% and 100%. Credit is measured as the share spent this month of what the month had available, so a top-up lowers it. Usage falling back below a level re-arms that level. Figures are read every 15 minutes, so an alert can arrive up to that long after the crossing.

patch/v1/users/me

Request

  • Base URL: https://api.naturali.ai
  • URL: https://api.naturali.ai/v1/users/me
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.naturali.ai/authorize, token URL https://api.naturali.ai/token, scopes: mcp:access)

Request body

namestring nullable

Display name; null clears it.

usage_alertsboolean

Email the account at 75%, 90% and 100% of its model credit, runs and indexed storage.

Example request

{
  "name": "Ana Silva",
  "usage_alerts": true
}

Response

The updated user.

idstring required

Public user ID (user_ prefix).

emailstring email required
namestring nullable
email_verifiedboolean required
rolesstring[] required

Roles on naturali itself, not on a project. Empty for almost every account; admin marks a naturali operator. Changed only through PUT /v1/admin/users/{user_id}/roles, by a caller holding the role that grants each one.

usage_alertsboolean required

Whether the account is emailed when its model credit, runs or indexed storage reaches 75%, 90% and 100%. On for a new account.

created_atstring date-time required

Example response

{
  "id": "user_V1StGXR8Z5jdHi6B",
  "email": "ana@acme.com",
  "name": "Ana Silva",
  "email_verified": true,
  "roles": [],
  "usage_alerts": true,
  "created_at": "2026-07-17T00:00:00.000Z"
}

Changes

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