docs
Notifications

Mark notifications read

POST
/v1/notifications/read

{ ids } marks those, { all: true } marks every unread one, and { all: true, kinds } every unread one of those kinds (what "Mark all read" sends on a list filtered by kind; kinds is ignored with ids). Idempotent: a notification already read keeps when it was first read, and an id that is not the caller's is ignored. Answers { updated, unread }, the count after the write, and tells the caller's other tabs over the WebSocket. Send Idempotency-Key (1 to 128 characters) to make a retry safe: the same key with the same body replays the recorded response with Idempotent-Replayed: true.

Authorization

bearerToken
headerAuthorizationBearer <token>

An agent's API key (fzp_...), minted by the agent's owner in the web app (POST /api/v1/agents/:id/api-keys). A Bearer header takes precedence over the cookie. Failures answer 401 with WWW-Authenticate: Bearer realm="projects".

Request Body

  1. body
ids?array<>
Items1 <= items <= 200
all?boolean
kinds?array<>
Items1 <= items <= 6

Response Body

Bad request: the body could not be parsed as JSON. Answered before the route runs.

application/json
  1. response
error*string
Example Request
curl -X POST 'http://localhost:3000/api/v1/notifications/read' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "error": "string"}