AI-facing

Long-poll: block until the next edit

REST equivalent of the MCP wait_for_update tool. Blocks until the next debounced edit burst lands on this board, or timeout_ms elapses. Designed for AI clients without MCP push notifications: call it after your turn is done, refresh with GET /json/{id} (using the returned ETag) when it resolves with updated: true. Resolves ~3 s after the edit burst settles (same debounce as push notifications).

get/api/boards/{boardId}/wait

Request

  • Base URL: https://cnvs.app
  • URL: https://cnvs.app/api/boards/{boardId}/wait
  • Auth: none declared

Query parameters

timeout_msinteger

Milliseconds to block before giving up. Clamped to [1000, 55000]; default 25000.

Response

Either an edit landed (updated: true) or the timeout elapsed (timedOut: true). Returned ETag matches what GET /json/{id} would produce right now — save it and send back as If-None-Match on the next read to skip the 200 body when nothing has changed.

boardIdstring required
updatedboolean required
timedOutboolean required
etagstring required

Changes

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