REST API

The EyesOnIt REST API exposes the same operations documented in the TypeScript SDK API reference. Use this section if you are calling EyesOnIt directly over HTTP from your own application or integration.

All REST responses follow the same envelope:

{
  "success": true,
  "message": null,
  "data": {}
}

In This Section

• Endpoints
• API Reference
• Inputs
• Outputs
• JSON Elements
• Configuration

How To Read These Docs

• Use Endpoints to find the HTTP method, path, request body, and response shape for an operation.
• Use API Reference for field-by-field reference pages organized by endpoint group, shared elements, request bodies, and response bodies.
• Use Inputs to compare request payloads across endpoints.
• Use Outputs to compare response payloads across endpoints.
• Use JSON Elements for shared body fragments such as regions, detection configuration, lines, notifications, search results, and recording settings.