EyesOnIt REST API

Build integrations that connect your EyesOnIt cameras and video to your own applications. Start with a working request, follow a complete workflow, or look up an operation by resource.

Get startedSet up authentication and make your first camera requests.

Integration guidesConnect cameras, configure detections, search video, and review incidents.

API referenceFind operation parameters, cURL templates, and request and response models.

Make your first request

The API calls a camera source a stream. List the cameras available to your integration, choose one stream’s id, then retrieve its details.

1. Prepare your connection and authenticate.
2. List streams to find a camera you can access.
3. Get a stream using its ID.

Set up your connection

Use your server’s HTTPS address followed by /api/v1. The quickstart uses a bearer service token issued by your administrator with monitor:read and access to your chosen camera.

export EOI_API_BASE_URL="https://eyesonit.example/api/v1"
read -rsp "EyesOnIt service token: " EOI_SERVICE_TOKEN
printf '\n'
export EOI_SERVICE_TOKEN

The guides use Bash and cURL. Some workflows also use Python 3 to prepare JSON. The authentication guide covers cookie sessions, CSRF, and workspace context for user operations.

Choose a workflow

• Connect and manage cameras
• Configure detections and rules
• Receive alerts and review incidents
• Search recorded video
• Retrieve snapshots and video

These pages describe the /api/v1 REST surface for EyesOnIt 6.1. Examples use fictional identifiers and camera data. See Versions and compatibility for reference provenance.