### Record

Source: https://ispysoftware.github.io/Agent_API/swagger.yaml

Starts recording for the device.

```APIDOC
## GET /command/record

### Description
Start recording for the device.

### Method
GET

### Endpoint
/command/record

### Parameters
#### Query Parameters
- **oid** (integer) - Required - Object ID
- **ot** (integer) - Required - Object TypeID

### Response
#### Success Response (200)
- description (string) - Start recording for the device.
```

--------------------------------

### Start RTMP Streaming

Source: https://ispysoftware.github.io/Agent_API/swagger.yaml

Starts streaming the device to the RTMP server. Requires the object ID and object type ID.

```APIDOC
## GET /command/start-rtmp

### Description
Starts streaming the device to the RTMP server.

### Method
GET

### Endpoint
/command/start-rtmp

### Parameters
#### Query Parameters
- **oid** (integer) - Required - Object ID
- **ot** (integer) - Required - Object TypeID

### Response
#### Success Response (200)
- description: Starts streaming the device to the RTMP server
```

--------------------------------

### Turn Record On Alert On

Source: https://ispysoftware.github.io/Agent_API

Enables recording to start when an alert is detected.

```APIDOC
## GET /command/recordOnDetectOn

### Description
Turn record on alert on for the device.

### Method
GET

### Endpoint
/command/recordOnDetectOn
```

--------------------------------

### Start RTMP View Streaming

Source: https://ispysoftware.github.io/Agent_API/swagger.yaml

Starts streaming a configured view to the RTMP server. Requires the RTMP server identifier and the view index.

```APIDOC
## GET /command/start-rtmp-view

### Description
Starts streaming the view to the RTMP server.

### Method
GET

### Endpoint
/command/start-rtmp-view

### Parameters
#### Query Parameters
- **ident** (string) - Required - Identifier of the RTMP server (shown in the RTMP servers list in server settings)
- **ind** (integer) - Required - View index

### Response
#### Success Response (200)
- description: Starts streaming the view to the RTMP server
```

--------------------------------

### Turn Record On Detection On

Source: https://ispysoftware.github.io/Agent_API

Enables recording to start when motion or sound is detected.

```APIDOC
## GET /command/reloadConfig

### Description
Turn record on detection on for the device.

### Method
GET

### Endpoint
/command/reloadConfig
```

--------------------------------

### Get System Stats

Source: https://ispysoftware.github.io/Agent_API/swagger.yaml

Returns the system usage statistics, including CPU, memory, and disk space.

```APIDOC
## GET /command/getSystemStats

### Description
Returns the system usage statistics, including CPU, memory, and disk space.

### Method
GET

### Endpoint
/command/getSystemStats

### Response
#### Success Response (200)
- **description** (string) - cpu/ memory and disk space.
```

--------------------------------

### Get Profiles

Source: https://ispysoftware.github.io/Agent_API/swagger.yaml

Retrieves the profiles configured on the agent.

```APIDOC
## GET /command/getProfiles

### Description
Retrieves the profiles configured on the agent.

### Method
GET

### Endpoint
/command/getProfiles

### Response
#### Success Response (200)
- **description** (string) - A description of the response.
```

--------------------------------

### Start RTMP Streaming

Source: https://ispysoftware.github.io/Agent_API/swagger.yaml

Initiates RTMP streaming for a specified device, requiring the RTMP server identifier.

```APIDOC
## GET /command/start-rtmp

### Description
Start RTMP streaming a device.

### Method
GET

### Endpoint
/command/start-rtmp

### Parameters
#### Query Parameters
- **ident** (string) - Required - Identifier of the RTMP server (shown in the RTMP servers list in server settings)
- **oid** (integer) - Required - Object ID
- **ot** (integer) - Required - Object TypeID (Enum: 1)

### Response
#### Success Response (200)
- Description: Start RTMP streaming a device.
```

--------------------------------

### Get Live Audio (MP3)

Source: https://ispysoftware.github.io/Agent_API/swagger.yaml

Returns a live audio stream from a specified microphone in MP3 format.

```APIDOC
## GET /audio.mp3

### Description
Returns live audio from the specified microphone in mp3 format.

### Method
GET

### Endpoint
/audio.mp3

### Parameters
#### Query Parameters
- **oid** (integer) - Required - Object ID of the microphone.

### Response
#### Success Response (200)
- The response will be an audio stream in MP3 format.
```

--------------------------------

### Get Camera Grabs

Source: https://ispysoftware.github.io/Agent_API

Returns JSON data containing the camera's photos.

```APIDOC
## GET /q/queryLevel

### Description
Returns JSON of the camera's photos

### Method
GET

### Endpoint
/q/queryLevel
```

--------------------------------

### Get Grab Image (Full Size)

Source: https://ispysoftware.github.io/Agent_API

Returns a full-size image for a specified object and filename.

```APIDOC
## GET /grabThumb.jpg

### Description
Returns a full size image for the specified object and filename

### Method
GET

### Endpoint
/grabThumb.jpg
```

--------------------------------

### Get Objects

Source: https://ispysoftware.github.io/Agent_API/swagger.yaml

Retrieves a list of objects managed by the agent.

```APIDOC
## GET /command/getObjects

### Description
Retrieves a list of objects managed by the agent.

### Method
GET

### Endpoint
/command/getObjects

### Response
#### Success Response (200)
- **description** (string) - A description of the response.
```

--------------------------------

### Get Grab Image

Source: https://ispysoftware.github.io/Agent_API

Returns a still image for the specified object(s).

```APIDOC
## GET /grabImage.jpg

### Description
Returns a still image for the specified object(s)

### Method
GET

### Endpoint
/grabImage.jpg
```

--------------------------------

### Get Photo Frame

Source: https://ispysoftware.github.io/Agent_API

Returns a photo frame for the specified camera (requires version 5.4.6.0+).

```APIDOC
## GET /video.gif

### Description
Returns a photo frame for the specified camera (5.4.6.0+)

### Method
GET

### Endpoint
/video.gif
```

--------------------------------

### Get Grab Thumbnail

Source: https://ispysoftware.github.io/Agent_API

Returns a thumbnail image for a specified object and filename.

```APIDOC
## GET /photo.jpg

### Description
Returns a thumbnail image for the specified object and filename

### Method
GET

### Endpoint
/photo.jpg
```

--------------------------------

### Get Status

Source: https://ispysoftware.github.io/Agent_API/swagger.yaml

Retrieves the current status of the agent.

```APIDOC
## GET /command/getStatus

### Description
Retrieves the current status of the agent.

### Method
GET

### Endpoint
/command/getStatus

### Response
#### Success Response (200)
- **description** (string) - A description of the response.
```

--------------------------------

### Get Alerts

Source: https://ispysoftware.github.io/Agent_API/swagger.yaml

Retrieves a collection of the current alerts from Agent DVR.

```APIDOC
## GET /alerts.json

### Description
Returns collection of the current alerts.

### Method
GET

### Endpoint
/alerts.json

### Response
#### Success Response (200)
- alerts (array) - A list of alert objects.

### Response Example
{
  "alerts": [
    {
      "ot": 2,
      "oid": 1,
      "reason": "Motion detected",
      "msg": "Motion detected on Front Door Camera",
      "time": "2023-10-27T10:00:00Z",
      "id": "alert-123",
      "read": false,
      "tags": "motion,camera"
    }
  ]
}
```

--------------------------------

### Get MJPEG Stream

Source: https://ispysoftware.github.io/Agent_API/swagger.yaml

Provides a grid of cameras in MJPEG format.

```APIDOC
## GET /video.mjpg

### Description
Grid of cameras

### Method
GET

### Endpoint
/video.mjpg
```

--------------------------------

### Get File Thumbnail

Source: https://ispysoftware.github.io/Agent_API

Returns a thumbnail image for a specified recording and filename.

```APIDOC
## GET /grab.jpg

### Description
Returns a thumbnail image for the specified recording and filename

### Method
GET

### Endpoint
/grab.jpg
```

--------------------------------

### Get WebM Stream

Source: https://ispysoftware.github.io/Agent_API/swagger.yaml

Retrieves a grid of cameras in WebM format. The first camera with audio provides the audio stream. Supports various query parameters for customization.

```APIDOC
## GET /video.webm

### Description
Returns a grid of cameras in MP4 form (the first camera with audio provides the audio stream).

### Method
GET

### Endpoint
/video.webm

### Parameters
#### Query Parameters
- **oids** (string) - Optional - Object IDs (1,2,3,4)
- **backColor** (string) - Optional - Background Color - RGB format (255,0,0)
- **size** (string) - Optional - Size (320x240)
- **viewIndex** (integer) - Optional - viewIndex (provide this to display a view from the default account instead of a set of cameras - 5.6.4.0+)

### Response
#### Success Response (200)
- **video/mp4** - Returns a grid of cameras in mp4 form (the first camera with audio provides the audio stream)
```

--------------------------------

### Get Session Count

Source: https://ispysoftware.github.io/Agent_API

Returns the number of active sessions.

```APIDOC
## GET /q/getSessionCount

### Description
Returns the number of active sessions.

### Method
GET

### Endpoint
/q/getSessionCount
```

--------------------------------

### Get Camera Grabs

Source: https://ispysoftware.github.io/Agent_API/swagger.yaml

Returns JSON data of a camera's photos. Requires object ID and object type ID. Supports pagination using an end date.

```APIDOC
## GET /q/getCameraGrabs

### Description
Returns JSON of the camera's photos. If you receive 800 grabs, you will need to make another call passing in `enddate=x` where `x` is the last received timestamp in the array to retrieve the next 800.

### Method
GET

### Endpoint
/q/getCameraGrabs

### Parameters
#### Query Parameters
- **oid** (integer) - Required - Object ID
- **ot** (integer) - Required - Object TypeID (1 or 2)
- **enddate** (integer) - Optional - End Date for pagination

### Response
#### Success Response (200)
- Returns camera grab JSON data.
```

--------------------------------

### Get Events

Source: https://ispysoftware.github.io/Agent_API

Retrieves a JSON list of recordings for the server or a specific device. Supports pagination by using `endDate` parameter for subsequent calls and filtering by `tag`.

```APIDOC
### Description
Get a JSON list of recordings for the server or specific device. If you receive 400 events you will need to make another call to getevents passing in enddate=x where x is the last received timestamp in the array to retrieve the next 400. Pass in tag=x to filter the results to recordings tagged with x

### Method
GET

### Endpoint
/q/getEvents
```

--------------------------------

### Get Events

Source: https://ispysoftware.github.io/Agent_API/swagger.yaml

Fetches a JSON list of recordings for a server or specific device. Supports pagination and filtering by tag. If 400 events are returned, subsequent calls should include the last timestamp as 'enddate'.

```APIDOC
## GET /q/getEvents

### Description
Get a JSON list of recordings for the server or specific device. If you receive 400 events you will need to make another call to getevents passing in enddate=x where x is the last received timestamp in the array to retrieve the next 400. Pass in tag=x to filter the results to recordings tagged with x

### Method
GET

### Endpoint
/q/getEvents

### Parameters
#### Query Parameters
- **oid** (integer) - Optional - Object ID
- **ot** (integer) - Optional - Object TypeID (enum: 1, 2)
- **tag** (string) - Optional - Filter
- **compress** (boolean) - Optional - Compresses the results using gzip

### Responses
#### Success Response (200)
- **description** (string) - Return json array
```

--------------------------------

### Get Graph

Source: https://ispysoftware.github.io/Agent_API/swagger.yaml

Retrieves a JSON description of a file, including a motion graph array and tag information with timestamps.

```APIDOC
## GET /q/getGraph

### Description
Get a JSON description of the file with a motion graph array and tag information (including timestamps)

### Method
GET

### Endpoint
/q/getGraph

### Parameters
#### Query Parameters
- **fn** (string) - Required - Filename (from getEvents call)

### Responses
#### Success Response (200)
- **description** (string) - Return json array
```

--------------------------------

### Get Audio Level

Source: https://ispysoftware.github.io/Agent_API/swagger.yaml

Retrieves the current audio level, where 1 represents the maximum and 0 represents the minimum.

```APIDOC
## GET /q/getAudioLevel

### Description
Retrieves the current audio level.

### Method
GET

### Endpoint
/q/getAudioLevel

### Responses
#### Success Response (200)
- **description** (string) - Audio level where 1 is max and 0 is min
```

--------------------------------

### Get MJPEG Stream

Source: https://ispysoftware.github.io/Agent_API/swagger.yaml

Retrieves a grid of cameras in MJPEG format. Supports various query parameters for customization.

```APIDOC
## GET /video.mjpg

### Description
Returns a grid of cameras in MJPEG form.

### Method
GET

### Endpoint
/video.mjpg

### Parameters
#### Query Parameters
- **oids** (string) - Optional - Object IDs (1,2,3,4)
- **backColor** (string) - Optional - Background Color - RGB format (255,0,0)
- **cycle** (integer) - Optional - Cycle (Seconds)
- **viewIndex** (integer) - Optional - viewIndex (provide this to display a view from the default account instead of a set of cameras - 5.6.4.0+)
- **group** (string) - Optional - Group
- **maintainAR** (boolean) - Optional - Maintain Aspect Ratio
- **size** (string) - Optional - Size (320x240)

### Response
#### Success Response (200)
- **image/jpeg** - Return a grid of cameras in mjpeg form
```

--------------------------------

### Get Graph Data

Source: https://ispysoftware.github.io/Agent_API

Retrieves a JSON description of the file containing a motion graph array and tag information, including timestamps.

```APIDOC
## GET /q/getEvents

### Description
Get a JSON description of the file with a motion graph array and tag information (including timestamps)

### Method
GET

### Endpoint
/q/getEvents
```

--------------------------------

### All On

Source: https://ispysoftware.github.io/Agent_API/swagger.yaml

Turns on all devices.

```APIDOC
## GET /command/allOn

### Description
Turns on all devices.

### Method
GET

### Endpoint
/command/allOn

### Response
#### Success Response (200)
- **description** (string) - Indicates that all devices have been turned on.
```

--------------------------------

### /command/ftpRecordingsOn

Source: https://ispysoftware.github.io/Agent_API/swagger.yaml

Turns on FTP recording uploads for the device.

```APIDOC
## GET /command/ftpRecordingsOn

### Description
Turn FTP recordings on for the device.

### Method
GET

### Endpoint
/command/ftpRecordingsOn

### Parameters
#### Query Parameters
- **oid** (integer) - Required - Object ID
- **ot** (integer) - Required - Object TypeID (enum: 1, 2)

### Response
#### Success Response (200)
- Description: Turn FTP recordings on for the device.
```

--------------------------------

### Switch On Device

Source: https://ispysoftware.github.io/Agent_API

Powers up the device.

```APIDOC
## GET /command/unblockExternal

### Description
Switch on the device.

### Method
GET

### Endpoint
/command/unblockExternal
```

--------------------------------

### /command/ftpFrame

Source: https://ispysoftware.github.io/Agent_API/swagger.yaml

Sends a live frame from the device via FTP.

```APIDOC
## GET /command/ftpFrame

### Description
Send a live frame via FTP.

### Method
GET

### Endpoint
/command/ftpFrame

### Parameters
#### Query Parameters
- **oid** (integer) - Required - Object ID
- **ot** (integer) - Required - Object TypeID (enum: 1, 2)

### Response
#### Success Response (200)
- Description: Send a live frame via FTP.
```

--------------------------------

### Turn Schedule On

Source: https://ispysoftware.github.io/Agent_API

Enables the recording schedule for the device.

```APIDOC
## GET /command/setProfile

### Description
Turn schedule on for the device.

### Method
GET

### Endpoint
/command/setProfile
```

--------------------------------

### Switch Action On

Source: https://ispysoftware.github.io/Agent_API

Activates a specified action.

```APIDOC
## GET /command/actionoff

### Description
Switches an action on

### Method
GET

### Endpoint
/command/actionoff
```

--------------------------------

### Run Storage Management

Source: https://ispysoftware.github.io/Agent_API

Executes the storage management process for the device.

```APIDOC
## GET /command/saveLocalOff

### Description
Run storage management.

### Method
GET

### Endpoint
/command/saveLocalOff
```

--------------------------------

### Turn Cloud Recordings On

Source: https://ispysoftware.github.io/Agent_API/swagger.yaml

Turns on cloud recording storage for a specific device. Requires Object ID and Object TypeID.

```APIDOC
## GET /command/cloudRecordingsOn

### Description
Turns on cloud recording storage for the device.

### Method
GET

### Endpoint
/command/cloudRecordingsOn

### Parameters
#### Query Parameters
- **oid** (integer) - Required - Object ID
- **ot** (integer) - Required - Object TypeID (enum: 1, 2)

### Response
#### Success Response (200)
- **description** (string) - Turn cloud recordings on for the device.
```

--------------------------------

### Turn Save Local On

Source: https://ispysoftware.github.io/Agent_API

Enables saving recordings locally on the device.

```APIDOC
## GET /command/scheduleOff

### Description
Turn save local on for the device.

### Method
GET

### Endpoint
/command/scheduleOff
```

--------------------------------

### /command/ftpPhotosOn

Source: https://ispysoftware.github.io/Agent_API/swagger.yaml

Turns on FTP photo uploads for the device.

```APIDOC
## GET /command/ftpPhotosOn

### Description
Turn FTP photos on for the device.

### Method
GET

### Endpoint
/command/ftpPhotosOn

### Parameters
#### Query Parameters
- **oid** (integer) - Required - Object ID
- **ot** (integer) - Required - Object TypeID (enum: 1, 2)

### Response
#### Success Response (200)
- Description: Turn FTP photos on for the device.
```

--------------------------------

### Turn Sound Recognition On

Source: https://ispysoftware.github.io/Agent_API/swagger.yaml

Enables sound recognition functionality for the specified device.

```APIDOC
## GET /command/soundon

### Description
Turn sound recognition on.

### Method
GET

### Endpoint
/command/soundon

### Parameters
#### Query Parameters
- **oid** (integer) - Required - Object ID
- **ot** (integer) - Required - Object TypeID (Enum: 1, 2)

### Response
#### Success Response (200)
- Description: Turn sound recognition on for the device.
```

--------------------------------

### WebM Video Stream

Source: https://ispysoftware.github.io/Agent_API

Returns a grid of cameras in WebM format. The first camera with audio provides the audio stream.

```APIDOC
## GET /ptz.cgi

### Description
Returns a grid of cameras in mp4 form (the first camera with audio provides the audio stream)

### Method
GET

### Endpoint
/ptz.cgi
```

--------------------------------

### Turn Schedule On

Source: https://ispysoftware.github.io/Agent_API/swagger.yaml

Turns on the schedule for a specific device. Requires Object ID and Object TypeID.

```APIDOC
## GET /command/scheduleOn

### Description
Turn schedule on for the device.

### Method
GET

### Endpoint
/command/scheduleOn

### Parameters
#### Query Parameters
- **oid** (integer) - Required - Object ID
- **ot** (integer) - Required - Object TypeID (enum: 1, 2)

### Response
#### Success Response (200)
- Description: Turn schedule on for the device.
```

--------------------------------

### Turn Save Local On

Source: https://ispysoftware.github.io/Agent_API/swagger.yaml

Turns on the local saving feature for a specified device.

```APIDOC
## GET /command/saveLocalOn

### Description
Turns on the local saving feature for the device.

### Method
GET

### Endpoint
/command/saveLocalOn

### Parameters
#### Query Parameters
- **oid** (integer) - Required - Object ID
- **ot** (integer) - Required - Object TypeID (enum: 1, 2)

### Response
#### Success Response (200)
- Description: Turn save local on for the device.
```

--------------------------------

### Commands

Source: https://ispysoftware.github.io/Agent_API

A collection of commands to manage Agent DVR features, including device control, recording management, and system settings.

```APIDOC
## GET /command/addfolder

### Description
Add existing files from the devices folder to the database

### Method
GET

### Endpoint
/command/addfolder
```

```APIDOC
## GET /command/addrecording

### Description
Add an existing recording to a device

### Method
GET

### Endpoint
/command/addrecording
```

```APIDOC
## GET /command/alert

### Description
Trigger alert on the device.

### Method
GET

### Endpoint
/command/alert
```

```APIDOC
## GET /command/alertOff

### Description
Turn alerts off for the device.

### Method
GET

### Endpoint
/command/alertOff
```

```APIDOC
## GET /command/alertOn

### Description
Turn alerts on for the device.

### Method
GET

### Endpoint
/command/alertOn
```

```APIDOC
## GET /command/allOff

### Description
allOff

### Method
GET

### Endpoint
/command/allOff
```

```APIDOC
## GET /command/allOn

### Description
allOn

### Method
GET

### Endpoint
/command/allOn
```

```APIDOC
## GET /command/appendtimestamp

### Description
Appends text to the devices default timestamp

### Method
GET

### Endpoint
/command/appendtimestamp
```

```APIDOC
## GET /command/applySchedule

### Description
Apply schedule to all devices.

### Method
GET

### Endpoint
/command/applySchedule
```

```APIDOC
## GET /command/applyScheduleToDevice

### Description
Apply schedule to device.

### Method
GET

### Endpoint
/command/applyScheduleToDevice
```

```APIDOC
## GET /command/arm

### Description
Arm the system.

### Method
GET

### Endpoint
/command/arm
```

```APIDOC
## GET /command/armgroups

### Description
Arm system and groups of devices (enable alerts)

### Method
GET

### Endpoint
/command/armgroups
```

```APIDOC
## GET /command/disarmgroups

### Description
Disarm groups of devices (disable alerts)

### Method
GET

### Endpoint
/command/disarmgroups
```

```APIDOC
## GET /command/armProfile

### Description
Arm the system and apply the specified profile.

### Method
GET

### Endpoint
/command/armProfile
```

```APIDOC
## GET /command/disarmProfile

### Description
Disarm the system and apply the specified profile.

### Method
GET

### Endpoint
/command/disarmProfile
```

```APIDOC
## GET /command/blockExternal

### Description
Block external access to the system.

### Method
GET

### Endpoint
/command/blockExternal
```

```APIDOC
## GET /command/checkRemote

### Description
Check the status of the remote (web) connection

### Method
GET

### Endpoint
/command/checkRemote
```

```APIDOC
## GET /command/cloudPhotosOff

### Description
Turn cloud photos off for the device.

### Method
GET

### Endpoint
/command/cloudPhotosOff
```

```APIDOC
## GET /command/cloudPhotosOn

### Description
Turn cloud photos on for the device.

### Method
GET

### Endpoint
/command/cloudPhotosOn
```

```APIDOC
## GET /command/cloudRecordingsOff

### Description
Turn cloud recordings off for the device.

### Method
GET

### Endpoint
/command/cloudRecordingsOff
```

```APIDOC
## GET /command/cloudRecordingsOn

### Description
Turn cloud recordings on for the device.

### Method
GET

### Endpoint
/command/cloudRecordingsOn
```

```APIDOC
## GET /command/detect

### Description
Trigger detection for the device.

### Method
GET

### Endpoint
/command/detect
```

```APIDOC
## GET /command/disarm

### Description
Disarm the system.

### Method
GET

### Endpoint
/command/disarm
```

```APIDOC
## GET /command/facedetecton

### Description
Turn facial recognition on

### Method
GET

### Endpoint
/command/facedetecton
```

```APIDOC
## GET /command/facedetectoff

### Description
Turn facial recognition off

### Method
GET

### Endpoint
/command/facedetectoff
```

```APIDOC
## GET /command/ftpFrame

### Description
Send a live frame via FTP.

### Method
GET

### Endpoint
/command/ftpFrame
```

```APIDOC
## GET /command/ftpPhotosOff

### Description
Turn FTP photos off for the device.

### Method
GET

### Endpoint
/command/ftpPhotosOff
```

```APIDOC
## GET /command/ftpPhotosOn

### Description
Turn FTP photos on for the device.

### Method
GET

### Endpoint
/command/ftpPhotosOn
```

```APIDOC
## GET /command/ftpRecordingsOff

### Description
Turn FTP recordings off for the device.

### Method
GET

### Endpoint
/command/ftpRecordingsOff
```

```APIDOC
## GET /command/ftpRecordingsOn

### Description
Turn FTP recordings on for the device.

### Method
GET

### Endpoint
/command/ftpRecordingsOn
```

```APIDOC
## GET /command/getObject

### Description
Get object by ID.

### Method
GET

### Endpoint
/command/getObject
```

```APIDOC
## GET /command/getObjects

### Description
getObjects

### Method
GET

### Endpoint
/command/getObjects
```

```APIDOC
## GET /command/getProfiles

### Description
getProfiles

### Method
GET

### Endpoint
/command/getProfiles
```

```APIDOC
## GET /command/getStatus

### Description
getStatus

### Method
GET

### Endpoint
/command/getStatus
```

```APIDOC
## GET /command/getSystemStats

### Description
Return the system usage stats

### Method
GET

### Endpoint
/command/getSystemStats
```

```APIDOC
## GET /command/lpron

### Description
Turn LPR on

### Method
GET

### Endpoint
/command/lpron
```

```APIDOC
## GET /command/lproff

### Description
Turn lpr off

### Method
GET

### Endpoint
/command/lproff
```

```APIDOC
## GET /command/objectdetecton

### Description
Turn object recognition on

### Method
GET

### Endpoint
/command/objectdetecton
```

```APIDOC
## GET /command/objectdetectoff

### Description
Turn object recognition off

### Method
GET

### Endpoint
/command/objectdetectoff
```

```APIDOC
## GET /command/ping

### Description
ping

### Method
GET

### Endpoint
/command/ping
```

```APIDOC
## GET /command/ptzscheduleon

### Description
enable the ptz scheduler or enable a specific ptz schedule entry (5.9.4.0+)

### Method
GET

### Endpoint
/command/ptzscheduleon
```

```APIDOC
## GET /command/ptzscheduleoff

### Description
disable the ptz scheduler or disable a specific ptz schedule entry (5.9.4.0+)

### Method
GET

### Endpoint
/command/ptzscheduleoff
```

```APIDOC
## GET /command/record

### Description
Start recording for the device.

### Method
GET

### Endpoint
/command/record
```

```APIDOC
## GET /command/recordRestart

### Description
Restart recording for the device.

### Method
GET

### Endpoint
/command/recordRestart
```

```APIDOC
## GET /command/setAIFind

### Description
Set the object list you want the AI model to look for, for example: person,car

### Method
GET

### Endpoint
/command/setAIFind
```

```APIDOC
## GET /command/setAIModel

### Description
Set the AI model to use for object recognition. Models are used in the endpoints for the AI server. To use the default (/v1/vision/detection) pass in the name default. Otherwise the model url will use the format /v1/vision/custom/name

### Method
GET

### Endpoint
/command/setAIModel
```

```APIDOC
## GET /command/setInterval

### Description
Set the interval for the specified field

### Method
GET

### Endpoint
/command/setInterval
```

```APIDOC
## GET /command/setSensitivity

### Description
Set the motion detector sensitivity on the selected device

### Method
GET

### Endpoint
/command/setSensitivity
```

```APIDOC
## GET /command/soundon

### Description
Turn sound recognition on

### Method
GET

### Endpoint
/command/soundon
```

```APIDOC
## GET /command/soundoff

### Description
Turn sound recognition off

### Method
GET

### Endpoint
/command/soundoff
```

```APIDOC
## GET /command/settimestamp

### Description
Change the timestamp display on the camera

### Method
GET

### Endpoint
/command/settimestamp
```

```APIDOC
## GET /command/start-rtmp

### Description
Start RTMP streaming a device

### Method
GET

### Endpoint
/command/start-rtmp
```

```APIDOC
## GET /command/start-rtmp-view

### Description
Start RTMP streaming a configured view

### Method
GET

### Endpoint
/command/start-rtmp-view
```

```APIDOC
## GET /command/stop-rtmp

### Description
Stop RTMP streaming a device

### Method
GET

### Endpoint
/command/stop-rtmp
```

```APIDOC
## GET /q/tagrecording

### Description
Tag a previous or current recording. Omit fn parameter to tag current recording.

### Method
GET

### Endpoint
/q/tagrecording
```

```APIDOC
## GET /q/untagrecording

### Description
Remove a tag from a recording

### Method
GET

### Endpoint
/q/untagrecording
```

```APIDOC
## GET /command/triggerLPR

### Description
Trigger LPR recognition for the device.

### Method
GET

### Endpoint
/command/triggerLPR
```

```APIDOC
## GET /command/triggerFace

### Description
Trigger facial recognition for the device.

### Method
GET

### Endpoint
/command/triggerFace
```

```APIDOC
## GET /command/triggerObject

### Description
Trigger object recognition for the device

### Method
GET

### Endpoint
/command/triggerObject
```

```APIDOC
## GET /command/triggerScene

### Description
Trigger scene recognition for the device.

### Method
GET

### Endpoint
/command/triggerScene
```

--------------------------------

### Add IP Camera

Source: https://ispysoftware.github.io/Agent_API

Adds a new IP camera to the system.

```APIDOC
## GET /command/addOnvif

### Description
Add an IP camera

### Method
GET

### Endpoint
/command/addOnvif
```

--------------------------------

### Apply Schedule to All Devices

Source: https://ispysoftware.github.io/Agent_API/swagger.yaml

Applies a schedule to all connected devices. This command is useful for setting up consistent operational times across the entire system.

```APIDOC
## GET /command/applySchedule

### Description
Apply schedule to all devices.

### Method
GET

### Endpoint
/command/applySchedule

### Responses
#### Success Response (200)
- description (string) - Apply schedule to all devices.
```

--------------------------------

### Get Streaming Status

Source: https://ispysoftware.github.io/Agent_API

Retrieves a JSON list of configured RTMP servers, including their status and an `ident` field for use in subsequent requests.

```APIDOC
## GET /q/getStreamingStatus

### Description
Get a JSON list of configured RTMP servers (with status). This provides an ident field you use in subsequent requests.

### Method
GET

### Endpoint
/q/getStreamingStatus
```

--------------------------------

### Take Snapshot

Source: https://ispysoftware.github.io/Agent_API

Captures a still image (snapshot) from the device.

```APIDOC
## GET /command/stopCloudUploads

### Description
Take a photo on a device

### Method
GET

### Endpoint
/command/stopCloudUploads
```

--------------------------------

### Turn Object Detection On

Source: https://ispysoftware.github.io/Agent_API/swagger.yaml

Turns on object recognition for a specified device.

```APIDOC
## GET /command/objectdetecton

### Description
Turns on object recognition for a specified device.

### Method
GET

### Endpoint
/command/objectdetecton

### Parameters
#### Query Parameters
- **oid** (integer) - Required - Object ID
- **ot** (integer) - Required - Object TypeID (enum: 1, 2)

### Response
#### Success Response (200)
- **description** (string) - Turn object recognition on for the device.
```

--------------------------------

### Switch Action On

Source: https://ispysoftware.github.io/Agent_API/swagger.yaml

Switches a specified action on. You can identify the action by its ID or name.

```APIDOC
## GET /command/actionon

### Description
Switches a specified action on. You can identify the action by its ID or name.

### Method
GET

### Endpoint
/command/actionon

### Parameters
#### Query Parameters
- **ID** (string) - Optional - ID (from the Action configuration in the UI)
- **name** (string) - Optional - Name (name of the action in the UI) - create multiple actions with the same name across devices to run groups of actions.
```

--------------------------------

### Turn Cloud Photos On

Source: https://ispysoftware.github.io/Agent_API/swagger.yaml

Turns on cloud photo storage for a specific device. Requires Object ID and Object TypeID.

```APIDOC
## GET /command/cloudPhotosOn

### Description
Turns on cloud photo storage for the device.

### Method
GET

### Endpoint
/command/cloudPhotosOn

### Parameters
#### Query Parameters
- **oid** (integer) - Required - Object ID
- **ot** (integer) - Required - Object TypeID (enum: 1, 2)

### Response
#### Success Response (200)
- **description** (string) - Turn cloud photos on for the device.
```

--------------------------------

### Action On

Source: https://ispysoftware.github.io/Agent_API/swagger.yaml

Switches an action on. Can be identified by ID or Name.

```APIDOC
## GET /command/actionon

### Description
Switches an action on

### Method
GET

### Endpoint
/command/actionon

### Parameters
#### Query Parameters
- **ID** (string) - Optional - ID (from the Action configuration in the UI)
- **Name** (string) - Optional - Name (name of the action in the UI) - create multiple actions with the same name across devices to run groups of actions.
```

--------------------------------

### Arm Profile

Source: https://ispysoftware.github.io/Agent_API/swagger.yaml

Arms the system and applies a specified profile. This command can also optionally disarm the system after a delay.

```APIDOC
## GET /command/armProfile

### Description
Arm the system and apply the specified profile.

### Method
GET

### Endpoint
/command/armProfile

### Parameters
#### Query Parameters
- **ind** (integer) - Required - profile index
- **disarmdelay** (integer) - Optional - Optionally disarm after a delay (minutes)

### Responses
#### Success Response (200)
- description (string) - Armed the system and applied the specified profile.
```

--------------------------------

### Enable PTZ Scheduler

Source: https://ispysoftware.github.io/Agent_API/swagger.yaml

Enables the PTZ scheduler or a specific PTZ schedule entry.

```APIDOC
## GET /command/ptzscheduleon

### Description
Enables the PTZ scheduler or a specific PTZ schedule entry (5.9.4.0+).

### Method
GET

### Endpoint
/command/ptzscheduleon

### Parameters
#### Query Parameters
- **oid** (integer) - Required - Object ID
- **ot** (integer) - Required - Object TypeID (enum: 1, 2)
- **Identifier of the PTZ Schedule entry (from the copy button on the PTZ Schedule list in the UI)** (string) - Required - Description of the parameter.
```

--------------------------------

### /command/getObject

Source: https://ispysoftware.github.io/Agent_API/swagger.yaml

Retrieves object information by its ID.

```APIDOC
## GET /command/getObject

### Description
Get object by ID.

### Method
GET

### Endpoint
/command/getObject

### Parameters
#### Query Parameters
- **oid** (integer) - Required - Object ID
- **ot** (integer) - Required - Object TypeID (enum: 1, 2)

### Response
#### Success Response (200)
- Description: Get object by ID.
```

--------------------------------

### Set Profile

Source: https://ispysoftware.github.io/Agent_API

Applies a specified profile to the device using its index.

```APIDOC
## GET /command/snapshot

### Description
Apply the specified profile with an index.

### Method
GET

### Endpoint
/command/snapshot
```

--------------------------------

### PTZ Scheduler On

Source: https://ispysoftware.github.io/Agent_API/swagger.yaml

Enables the PTZ Scheduler or a specific entry.

```APIDOC
## GET /command/ptzscheduleon

### Description
Enables the PTZ Scheduler or a specific entry.

### Method
GET

### Endpoint
/command/ptzscheduleon

### Parameters
#### Query Parameters
- **oid** (integer) - Required - Object ID
- **ot** (integer) - Required - Object TypeID
- **ident** (string) - Optional - Identifier of the PTZ Schedule entry

### Response
#### Success Response (200)
- description (string) - Enables the PTZ Scheduler or a specific entry
```

--------------------------------

### Run Action

Source: https://ispysoftware.github.io/Agent_API

Executes a specified action, bypassing any filtering.

```APIDOC
## GET /command/addCamera

### Description
Executes an action (bypasses filtering)

### Method
GET

### Endpoint
/command/addCamera
```

--------------------------------

### Query Level

Source: https://ispysoftware.github.io/Agent_API

Returns the detected motion or sound level of the device.

```APIDOC
## GET /q/getGraph

### Description
Returns the detected motion or sound level of the device

### Method
GET

### Endpoint
/q/getGraph
```

--------------------------------

### Add ONVIF Camera

Source: https://ispysoftware.github.io/Agent_API

Adds a new ONVIF camera to the system.

```APIDOC
## GET /command/switchDetector

### Description
Add an ONVIF camera

### Method
GET

### Endpoint
/command/switchDetector
```

--------------------------------

### Add Folder to Database

Source: https://ispysoftware.github.io/Agent_API/swagger.yaml

Adds existing files from a device's folder to the Agent DVR database, generating necessary metadata.

```APIDOC
## GET /command/addfolder

### Description
Add existing files from the devices folder to the database. Copy files into the devices folder (available via the storage tab) and then call this command to scan the folder and add the recordings to the database so they are available in the UI. Agent will generate missing data like thumbnails and duration. v5.5.5.0+.

### Method
GET

### Endpoint
/command/addfolder

### Parameters
#### Query Parameters
- **oid** (integer) - Required - Object ID of the device.
- **ot** (integer) - Required - Object Type ID (1 for Microphones, 2 for Cameras).

### Response
#### Success Response (200)
- The response indicates the success of the operation.
```

--------------------------------

### Switch On Device

Source: https://ispysoftware.github.io/Agent_API/swagger.yaml

Switches on the specified device. Requires Object ID and Object TypeID.

```APIDOC
## GET /command/switchOn

### Description
Switch on the device.

### Method
GET

### Endpoint
/command/switchOn

### Parameters
#### Query Parameters
- **oid** (integer) - Required - Object ID
- **ot** (integer) - Required - Object TypeID (enum: 1, 2)

### Response
#### Success Response (200)
- Description: Switch on the device.
```

--------------------------------

### Add Recording to Device

Source: https://ispysoftware.github.io/Agent_API/swagger.yaml

Adds an existing recording file to a specified device in Agent DVR.

```APIDOC
## GET /command/addrecording

### Description
Add an existing recording to a device.

### Method
GET

### Endpoint
/command/addrecording

### Parameters
#### Query Parameters
- **oid** (integer) - Required - Object ID of the device.
- **ot** (integer) - Required - Object Type ID (1 for Microphones, 2 for Cameras).
- **path** (string) - Required - Local path to the recording file.
```

--------------------------------

### Record Restart

Source: https://ispysoftware.github.io/Agent_API/swagger.yaml

Restarts recording for the device.

```APIDOC
## GET /command/recordRestart

### Description
Restart recording for the device.

### Method
GET

### Endpoint
/command/recordRestart

### Parameters
#### Query Parameters
- **oid** (integer) - Required - Object ID
- **ot** (integer) - Required - Object TypeID

### Response
#### Success Response (200)
- description (string) - Restarted recording for the device.
```

--------------------------------

### File Thumbnail

Source: https://ispysoftware.github.io/Agent_API/swagger.yaml

Returns a thumbnail image for a specified recording and filename. Large versions can be requested by appending '_large.jpg' to the filename.

```APIDOC
## GET /fileThumb.jpg

### Description
Returns a thumbnail image for the specified recording and filename

### Method
GET

### Endpoint
/fileThumb.jpg

### Parameters
#### Query Parameters
- **oid** (integer) - Required - Object ID
- **fn** (string) - Required - Filename (3_2021-01-19_12-22-55_125.jpg) (use ..._large.jpg for a large version)

### Response
#### Success Response (200)
- Description: Returns a thumbnail image for the specified recording and filename
```

--------------------------------

### Grab Image

Source: https://ispysoftware.github.io/Agent_API/swagger.yaml

Returns a still image for the specified object(s). Allows customization of background color, aspect ratio, and size.

```APIDOC
## GET /grab.jpg

### Description
Returns a still image for the specified object(s)

### Method
GET

### Endpoint
/grab.jpg

### Parameters
#### Query Parameters
- **oid** (integer) - Optional - Object ID
- **oids** (string) - Optional - Object IDs (1,2,3,4)
- **backColor** (string) - Optional - Background Color - RGB format (255,0,0)
- **maintainAR** (boolean) - Optional - Maintain Aspect Ratio
- **size** (string) - Optional - Size (320x240)
```

--------------------------------

### Turn Alerts On

Source: https://ispysoftware.github.io/Agent_API/swagger.yaml

Turns on alerts for a specific device identified by its Object ID and Object TypeID.

```APIDOC
## GET /command/alertOn

### Description
Turns alerts on for the specified device.

### Method
GET

### Endpoint
/command/alertOn

### Parameters
#### Query Parameters
- **oid** (integer) - Required - Object ID
- **ot** (integer) - Required - Object TypeID (enum: 1, 2)

### Response
#### Success Response (200)
- **description** (string) - Indicates that alerts have been turned on for the device.
```

--------------------------------

### Apply Schedule to Device

Source: https://ispysoftware.github.io/Agent_API/swagger.yaml

Applies a schedule to a specific device identified by its Object ID and Object Type ID. This allows for granular control over individual device schedules.

```APIDOC
## GET /command/applyScheduleToDevice

### Description
Apply schedule to device.

### Method
GET

### Endpoint
/command/applyScheduleToDevice

### Parameters
#### Query Parameters
- **oid** (integer) - Required - Object ID
- **ot** (integer) - Required - Object TypeID (enum: 1, 2)

### Responses
#### Success Response (200)
- description (string) - Apply schedule to device.
```

--------------------------------

### Reload Configuration

Source: https://ispysoftware.github.io/Agent_API

Reloads the device's configuration.

```APIDOC
## GET /command/reloadObjects

### Description
reloadConfig

### Method
GET

### Endpoint
/command/reloadObjects
```

--------------------------------

### Restart Device

Source: https://ispysoftware.github.io/Agent_API

Restarts the device.

```APIDOC
## GET /command/rtmpStop

### Description
restart

### Method
GET

### Endpoint
/command/rtmpStop
```

--------------------------------

### PTZ Controls

Source: https://ispysoftware.github.io/Agent_API/swagger.yaml

Provides PTZ (Pan-Tilt-Zoom) controls for cameras. Requires object ID and optionally accepts command and direction parameters.

```APIDOC
## GET /ptz.cgi

### Description
PTZ controls for cameras.

### Method
GET

### Endpoint
/ptz.cgi

### Parameters
#### Query Parameters
- **oid** (integer) - Required - Object ID
- **cmd** (string) - Optional - Command (the url encoded portion in the extended commands options from the PTZ2.xml)
- **dir** (integer) - Optional - Direction (0 for center, 1 = left, 2=up left, 3 = up, 4 = up right, 5 = right, 6 = down right, 7 = down, 8 = down left, 9 = zoom in, 10 = zoom out, 11 = stop)

### Response
#### Success Response (200)
- OK
```

--------------------------------

### MP4 Video Stream

Source: https://ispysoftware.github.io/Agent_API

Returns a grid of cameras in MP4 format. The first camera with audio provides the audio stream.

```APIDOC
## GET /video.webm

### Description
Returns a grid of cameras in mp4 form (the first camera with audio provides the audio stream)

### Method
GET

### Endpoint
/video.webm
```

--------------------------------

### Generate Animated GIF

Source: https://ispysoftware.github.io/Agent_API

Generates an animated GIF from the live camera stream.

```APIDOC
## GET /video.mjpg

### Description
Generate an animated gif from the live camera stream

### Method
GET

### Endpoint
/video.mjpg
```

--------------------------------

### Add ONVIF Camera

Source: https://ispysoftware.github.io/Agent_API/swagger.yaml

Adds an ONVIF camera to the system using its device management endpoint URI.

```APIDOC
## GET /command/addOnvif

### Description
Adds an ONVIF camera to the system using its device management endpoint URI.

### Method
GET

### Endpoint
/command/addOnvif

### Parameters
#### Query Parameters
- **uri** (string) - Required - URL for the ONVIF device management endpoint
- **name** (string) - Optional - name of camera
- **substream** (int) - Optional - Profile index for the live stream (0)
```

--------------------------------

### Audio Stream (MP3)

Source: https://ispysoftware.github.io/Agent_API

Provides a live audio stream from a specified microphone in MP3 format.

```APIDOC
## GET /audio.mp3

### Description
Returns live audio from the specified microphone in mp3 format

### Method
GET

### Endpoint
/audio.mp3
```

--------------------------------

### Grab Image

Source: https://ispysoftware.github.io/Agent_API/swagger.yaml

Retrieves a full-size image for a specified object and filename. Requires object ID and filename.

```APIDOC
## GET /grabImage.jpg

### Description
Returns a full-size image for the specified object and filename.

### Method
GET

### Endpoint
/grabImage.jpg

### Parameters
#### Query Parameters
- **oid** (integer) - Required - Object ID
- **fn** (string) - Required - Filename (e.g., 2021-01-19_12-22-55_125.jpg)

### Response
#### Success Response (200)
- Returns a JPEG image.
```