MomentLens Device API

Integrate MomentLens device management into your systems

API Overview

The MomentLens Device API provides programmatic access to manage your MomentLens devices, retrieve device status, assign devices to users, and configure settings. This API is designed for enterprise integrations and custom applications.

Base URL:

https://api.echoeye.ca/v1

Authentication

All API requests must be authenticated using an API Key provided by EchoEye. Include your API Key in the `Authorization` header as a Bearer token.

Example Header:

Authorization: Bearer YOUR_API_KEY

Contact your EchoEye account manager to obtain your API Key.

API Endpoints

GET /devices

Retrieve a list of all MomentLens devices.

GET /v1/devices

Response: `200 OK` with an array of device objects.

GET /devices/{id}

Retrieve details for a specific device by ID.

GET /v1/devices/ML-PRO-2024-001

Response: `200 OK` with a single device object.

POST /devices/{id}/assign

Assign a device to a user, optionally clearing memories.

POST /v1/devices/ML-MINI-2024-007/assign

Request Body:

{
  "userId": "user_abc123",
  "clearMemories": true,
  "notificationPreferences": ["battery", "storage"]
}

Response: `200 OK` on success, `400 Bad Request` on error.

GET /users, POST /users, PUT /users/{id}

Manage user profiles associated with devices.

GET /v1/users

Response: `200 OK` with user data.

POST /devices/{id}/storage/clear

Trigger a remote storage clear for a device.

POST /v1/devices/ML-PRO-2024-001/storage/clear

Response: `202 Accepted` if command is queued.

Error Handling

The API uses standard HTTP status codes to indicate the success or failure of an API request. Errors will include a `code` and `message` in the response body.

Example Error Response:

{
  "code": "DEVICE_NOT_FOUND",
  "message": "The requested device could not be found."
}

Refer to the specific endpoint documentation for a full list of possible error codes.

Need More Help?

For advanced integration scenarios or specific API requirements, please contact our enterprise support team.