Skip to main content

Class: EyesOnItAPI

Main client for the EyesOnIt REST API.

Namespace: EyesOnItSDK.API

Constructor​

  • public EyesOnItAPI(string baseUrl)

Create the client with the base URL of your EyesOnIt server, for example http://localhost:8000.

Method Groups​

Image and Video​

  • ProcessImage(string base64Image, EOIRegion[] regions)
  • ProcessImage(EOIProcessImageInputs inputs)
  • AddStream(...)
  • AddStream(EOIAddStreamInputs inputs)
  • ProcessVideo(EOIProcessVideoInputs inputs)
  • RemoveStream(string streamUrl)
  • RemoveStream(EOIRemoveStreamInputs inputs)
  • GetVideoFrame(string streamUrl)
  • GetVideoFrame(EOIVideoFrameInputs inputs)
  • SearchArchive(EOIArchiveSearchInputs inputs)
  • SearchLive(EOILiveSearchInputs inputs)
  • PauseLiveSearch(EOIUpdateLiveSearchInputs inputs)
  • ResumeLiveSearch(EOIUpdateLiveSearchInputs inputs)
  • CancelLiveSearch(EOIUpdateLiveSearchInputs inputs)

Face Recognition​

  • GetFacerecGroups()
  • AddFacerecGroup(EOIAddFacerecGroupInputs inputs)
  • RemoveFacerecGroup(string groupId)
  • AddFacerecPerson(EOIAddFacerecPersonInputs inputs)
  • AddFacerecPeople(EOIAddFacerecPeopleInputs inputs)
  • RemoveFacerecPerson(string personId)
  • SearchFacerecGroupNames(string search)
  • SearchFacerecPeopleNames(string search)
  • GetFacerecPersonDetails(string personId)

Status​

  • MonitorStream(string streamUrl, int? durationSeconds)
  • MonitorStream(EOIMonitorStreamInputs inputs)
  • StopMonitoringStream(string streamUrl)
  • StopMonitoringStream(EOIStopMonitoringStreamInputs inputs)
  • GetAllStreamsInfo()
  • GetStreamDetails(string streamUrl)
  • GetStreamDetails(EOIGetStreamDetailsInputs inputs)
  • GetLastDetectionInfo(string streamUrl)
  • GetLastDetectionInfo(EOIGetLastDetectionInfoInputs inputs)

Config​

  • UpdateConfig(EOIUpdateConfigInputs inputs)

Methods​

Image and Video​

ProcessImage(string base64Image, EOIRegion[] regions)​

Processes one base64-encoded image with the supplied regions.

Returns: EOIProcessImageResponse

Endpoint: POST /process_image

ProcessImage(EOIProcessImageInputs inputs)​

Processes one image using the full request model.

Returns: EOIProcessImageResponse

Endpoint: POST /process_image

AddStream(...)​

Registers a stream so it can be monitored, searched, and queried later.

Returns: EOIAddStreamResponse

Endpoint: POST /add_stream

AddStream(EOIAddStreamInputs inputs)​

Registers a stream using the full request model.

Returns: EOIAddStreamResponse

Endpoint: POST /add_stream

ProcessVideo(EOIProcessVideoInputs inputs)​

Starts a video-processing job.

Returns: EOIProcessVideoResponse

Endpoint: POST /process_video

RemoveStream(string streamUrl)​

Removes a previously registered stream.

Returns: EOIRemoveStreamResponse

Endpoint: POST /remove_stream

RemoveStream(EOIRemoveStreamInputs inputs)​

Removes a previously registered stream using the typed request model.

Returns: EOIRemoveStreamResponse

Endpoint: POST /remove_stream

GetVideoFrame(string streamUrl)​

Gets the latest frame for a stream.

Returns: EOIGetVideoFrameResponse

Endpoint: POST /get_video_frame

GetVideoFrame(EOIVideoFrameInputs inputs)​

Gets the latest frame for a stream using the typed request model.

Returns: EOIGetVideoFrameResponse

Endpoint: POST /get_video_frame

Search​

SearchArchive(EOIArchiveSearchInputs inputs)​

Searches archived results.

Returns: EOISearchResponse

Endpoint: POST /archive_search

SearchLive(EOILiveSearchInputs inputs)​

Starts a live search.

Returns: EOILiveSearchResponse

Endpoint: POST /live_search

PauseLiveSearch(EOIUpdateLiveSearchInputs inputs)​

Pauses a live search by ID.

Returns: EOIResponse

Endpoint: POST /pause_live_search

ResumeLiveSearch(EOIUpdateLiveSearchInputs inputs)​

Resumes a live search by ID.

Returns: EOIResponse

Endpoint: POST /resume_live_search

CancelLiveSearch(EOIUpdateLiveSearchInputs inputs)​

Cancels a live search by ID.

Returns: EOIResponse

Endpoint: POST /cancel_live_search

Face Recognition​

GetFacerecGroups()​

Lists face recognition groups.

Returns: EOIGetFacerecGroupsResponse

Endpoint: GET /facerec_groups

AddFacerecGroup(EOIAddFacerecGroupInputs inputs)​

Creates a face recognition group.

Returns: EOIBaseOutputs

Endpoint: POST /facerec_add_group

RemoveFacerecGroup(string groupId)​

Removes a face recognition group.

Returns: EOIRemoveFacerecGroupResponse

Endpoint: POST /facerec_remove_group

AddFacerecPerson(EOIAddFacerecPersonInputs inputs)​

Creates a person profile with one or more images.

Returns: EOIBaseOutputs

Endpoint: POST /facerec_add_person

AddFacerecPeople(EOIAddFacerecPeopleInputs inputs)​

Imports people in bulk from a file.

Returns: EOIBaseOutputs

Endpoint: POST /facerec_add_people

RemoveFacerecPerson(string personId)​

Removes a person profile.

Returns: EOIBaseOutputs

Endpoint: POST /facerec_remove_person

Searches face recognition group names.

Returns: EOISearchFacerecNamesResponse

Endpoint: POST /facerec_search_group_names

Searches face recognition person names.

Returns: EOISearchFacerecNamesResponse

Endpoint: POST /facerec_search_people_names

GetFacerecPersonDetails(string personId)​

Gets one person profile and its groups and images.

Returns: EOIFacerecPersonDetailsResponse

Endpoint: POST /facerec_person_details

Status​

MonitorStream(...)​

Starts stream monitoring.

Returns: EOIMonitorStreamResponse

Endpoint: POST /monitor_stream

StopMonitoringStream(...)​

Stops stream monitoring.

Returns: EOIStopMonitoringStreamResponse

Endpoint: POST /stop_monitoring

GetAllStreamsInfo()​

Lists all registered streams.

Returns: EOIGetAllStreamsInfoResponse

Endpoint: GET /get_all_streams_info

GetStreamDetails(...)​

Gets one registered stream.

Returns: EOIGetStreamDetailsResponse

Endpoint: POST /get_stream_details

GetLastDetectionInfo(...)​

Gets the most recent detection information for a stream.

Returns: EOIGetLastDetectionInfoResponse

Endpoint: POST /get_last_detection_info

Config​

UpdateConfig(EOIUpdateConfigInputs inputs)​

Sends a configuration payload to the server.

Returns: EOIUpdateConfigResponse

Endpoint: POST /update_config