Skip to main content

Endpoints

Grouped reference for the EyesOnIt REST API endpoints.

Endpoint Groups​

Image and Video​

Live Stream Processing

Video File Processing

Image Processing

Live Search

Archive Search

Face Recognition​

Group Management

Person Management

Status​

License​

Config​

Image and Video​

Live Stream Processing​

add_stream​

{
  "stream_url": "rtsp://camera/live",
  "name": "Warehouse Camera 01",
  "frame_rate": 5,
  "index_for_search": true,
  "search_index_types": ["image"],
  "regions": [
    {
      "name": "Front Entrance",
      "enabled": true,
      "polygon": [{ "x": 0, "y": 0 }, { "x": 200, "y": 0 }, { "x": 200, "y": 200 }],
      "motion_detection": {
        "enabled": true,
        "detection_threshold": 300,
        "regular_check_frame_interval": 5
      },
      "detection_configs": []
    }
  ],
  "lines": [
    {
      "name": "entry-line",
      "vertices": [{ "x": 50, "y": 50 }, { "x": 250, "y": 50 }]
    }
  ],
  "notification": {
    "include_image": true,
    "phone_number": "+15551234567"
  },
  "recording": {
    "enabled": false
  },
  "effects": {
    "show_bounding_boxes": true,
    "show_regions": true
  }
}

monitor_stream​

{
  "stream_url": "rtsp://camera/live",
  "duration_seconds": 300
}

stop_monitoring​

{
  "stream_url": "rtsp://camera/live"
}

remove_stream​

{
  "stream_url": "rtsp://camera/live"
}

get_video_frame​

{
  "stream_url": "rtsp://camera/live"
}

Video File Processing​

process_video​

{
  "name": "warehouse-shift-1",
  "input_video_path": "/input/warehouse.mp4",
  "rotate_video": 0,
  "output_video_path": "/output/warehouse_out.mp4",
  "frame_rate": 5,
  "index_for_search": false,
  "search_index_types": [],
  "regions": [
    {
      "name": "Front Entrance",
      "enabled": true,
      "polygon": [{ "x": 0, "y": 0 }, { "x": 200, "y": 0 }, { "x": 200, "y": 200 }],
      "motion_detection": {
        "enabled": true,
        "detection_threshold": 300,
        "regular_check_frame_interval": 5
      },
      "detection_configs": []
    }
  ],
  "lines": [],
  "real_time": false,
  "video_start_interval": 0,
  "output_all_frames": true,
  "effects": {
    "show_bounding_boxes": true,
    "show_regions": true
  },
  "recording": {
    "enabled": false
  },
  "video_start_local_time": "2025-03-17T22:27:33Z",
  "start_seconds": 0,
  "end_seconds": 30,
  "mode": "KNOWN_OBJECT_DETECTION",
  "base_image_path": null,
  "plugins": {},
  "validation": {
    "triggers": [
      {
        "class_name": "person",
        "start_seconds": 0,
        "end_seconds": 30
      }
    ]
  }
}

stop_video​

{
  "video_id": "f2d9a2d4f94a4d4da6d2a0a2f4d24f01"
}

get_video_status​

{
  "video_id": "f2d9a2d4f94a4d4da6d2a0a2f4d24f01"
}

Image Processing​

process_image​

{
  "file": "<base64 image>",
  "return_image": true,
  "regions": [
    {
      "name": "Front Entrance",
      "enabled": true,
      "polygon": [{ "x": 0, "y": 0 }, { "x": 200, "y": 0 }, { "x": 200, "y": 200 }],
      "detection_configs": []
    }
  ],
  "effects": {
    "show_bounding_boxes": true,
    "show_regions": true
  }
}

Search​

{
  "class_name": "person",
  "search_type": "face_recognition",
  "face_match_type": "group",
  "face_group_id": "employees",
  "alert_threshold": 80,
  "stream_list": ["rtsp://camera/live"],
  "duration_seconds": 600,
  "notification": {
    "include_image": true,
    "phone_number": "+15551234567"
  }
}
{
  "search_id": 42
}
{
  "search_id": 42
}
{
  "search_id": 42
}
{
  "class_name": "person",
  "search_type": "natural_language",
  "object_description": "person carrying a red bag",
  "alert_threshold": 80,
  "similarity": {
    "images": []
  },
  "stream_list": ["rtsp://camera/live"],
  "start_date_time": "2025-03-17T00:00:00Z",
  "end_date_time": "2025-03-18T00:00:00Z"
}

Face Recognition​

Group Management​

facerec_groups​

facerec_add_group​

{
  "group_id": "employees",
  "group_name": "Employees",
  "group_description": "Employees approved for entry checks"
}

facerec_remove_group​

{
  "group_id": "employees"
}

facerec_search_group_names​

{
  "search_text": "emp"
}

Person Management​

facerec_add_person​

{
  "person_id": "person-001",
  "person_display_name": "Alex Carter",
  "person_groups": ["employees"],
  "person_images": [
    {
      "image": "<base64 image>",
      "file_path": null,
      "capture_time": "2025-03-17T22:27:33Z"
    }
  ]
}

facerec_add_people​

{
  "file_path": "/input/facerec/import.csv"
}

facerec_remove_person​

{
  "person_id": "person-001"
}

facerec_person_details​

{
  "person_id": "person-001"
}

facerec_search_people_names​

{
  "search_text": "alex"
}

Status​

get_all_streams_info​

get_stream_details​

{
  "stream_url": "rtsp://camera/live"
}

get_last_detection_info​

{
  "stream_url": "rtsp://camera/live"
}

is_eoi_alive​

License​

is_license_valid​

get_license_status​

validate_license​

{
  "key": "<redacted-license-key>",
  "token": "<redacted-license-token>"
}

Config​

get_config​

update_config​

{
  "search": {
    "max_results": 100
  }
}

get_supported_classes​