Endpoints

DRAFT

These are placeholder shapes showing the intended documentation pattern. Replace each with the real contract.

List sessions

GET /v1/sessions

Query parameters

Parameter	Type	Default	Description
limit	integer	TODO	Maximum sessions to return
cursor	string	—	Pagination cursor from a previous response

Response

{
  "data": [{ "id": "sess_TODO", "startedAt": "2026-01-01T00:00:00Z" }],
  "nextCursor": null
}

Get a session

GET /v1/sessions/{sessionId}

TODO: Response shape, and whether shots are embedded or fetched separately.

List shots in a session

GET /v1/sessions/{sessionId}/shots

Returns Shot objects.

TODO: Pagination and ordering.

Get a single shot

GET /v1/shots/{shotId}

TODO

Stream live shots

TODO: Document the streaming transport — connection URL, authentication, message format, and reconnect behaviour.

// TODO: replace with the real client example
const socket = new WebSocket('wss://TODO/v1/stream')
socket.addEventListener('message', (event) => {
  const shot = JSON.parse(event.data)
  console.log(shot.id)
})

Device status

GET /v1/device

TODO: Firmware version, calibration state, connection health.