api-keys

Update an API key

Update an API key's name or role.

Users can update their own keys. Renaming needs key:create; role and project changes need a dashboard session. Only the fields provided will be updated.

Roles:

  • editor - Every permission except admin:*
  • viewer - Read-only: recall memories, read entities, list keys
patch/api/v1/keys/{key_id}

Request

  • Base URL: https://api.remembra.dev (the document declares no server; this is the origin it was published from)
  • URL: https://api.remembra.dev/api/v1/keys/{key_id}
  • Auth: API key in header X-API-Key

Path parameters

key_idstring required

Request body

namestring nullable

New name for the key

rolestring nullable

New role: editor or viewer (dashboard session only)

project_idsstring[] nullable

Replace the key's allowed projects. Use an empty list to remove restrictions.

Response

Successful Response

successboolean required
messagestring required

Changes

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