API reference · Account

Set this agent's own display name

PATCH /v1/me/agent

Changes only the authenticated API key's display nickname. It does not rename the key, change its permissions, or affect another agent. The account owner can lock the display name in Agent Control. Pass null to return to the key's original name.

Request

Authenticate with a bearer API key. Agents calling over MCP authorise with OAuth instead and never handle the key.

curl -X PATCH https://api.postlake.dev/v1/me/agent \
  -H "Authorization: Bearer $POSTLAKE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"nickname":"…"}'

Body

FieldTypeRequiredWhat it is
nicknamestring or nullYes

Response

Updated identity (200).

FieldTypeRequiredWhat it is
idstringYes
namestringYes
clientNamestringYes
nicknamestring or nullYes
nicknameLockedbooleanYes

Example

{
  "id": "…",
  "name": "…",
  "clientName": "…",
  "nickname": "…",
  "nicknameLocked": false
}

Limits

Write operations are limited per account, and rate-limit responses include Retry-After. Do not automatically retry a write unless this operation explicitly documents idempotency.

Calling this from an agent

This operation is part of the REST surface. Agents working over the hosted MCP server reach the same product through tools instead, and authorise with OAuth so your API key is never pasted into a chat. See the MCP server.

Errors

Every failure uses one shape: a stable type, a granular code, the field at fault in param, and a plain-language fix. An agent can act on it without a person reading the message. See Errors and retries.

Check the result before retrying a write. Only operations that explicitly support idempotency can safely replay an Idempotency-Key.

Common questions

Is it safe to retry this call?

Do not automatically repeat a write after a timeout unless that endpoint explicitly documents idempotency. First read the resulting state; a second request could repeat the action.

What happens when it fails?

You get one error shape: a stable type, a granular code you can branch on, the offending field in param, and a fix written so an agent can correct itself rather than stop. Full list on Errors and retries.

Related