Documentation Powered by ReDoc

SmartFace REST API (v5_4.18.0.2906)

Download OpenAPI specification:Download

Camera

Retrieves the camera by its Id.

path Parameters
id
required
string <uuid>

Id of the camera.

Responses

200

Returns the found frame.

404

The frame with given Id was not found.

get/api/v1/Cameras/{id}
/api/v1/Cameras/{id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "spoofDetectorResourceIds":
    [
    ],
  • "id": "string",
  • "name": "string",
  • "source": "string",
  • "enabled": true,
  • "faceDetectorConfig":
    {
    },
  • "pedestrianDetectorConfig":
    {
    },
  • "faceDetectorResourceId": "string",
  • "templateGeneratorResourceId": "string",
  • "pedestrianDetectorResourceId": "string",
  • "redetectionTime": 0,
  • "templateGenerationTime": 0,
  • "trackMotionOptimization": "string",
  • "trackSpeedAccuracyMode": "string",
  • "faceSaveStrategy": "All",
  • "maskImagePath": "string",
  • "saveFrameImageData": true,
  • "imageQuality": 0,
  • "mpeG1PreviewEnabled": true,
  • "mpeG1PreviewPort": 0,
  • "mpeG1VideoBitrate": 0,
  • "previewMaxDimension": 0,
  • "serviceName": "string",
  • "spoofDetectorConfig":
    {
    },
  • "previewAttributesConfig":
    {
    }
}

Deletes a camera by its id.

path Parameters
id
required
string <uuid>

Id of the camera.

Responses

204

The camera with given id was deleted successfully.

404

The individual with given id was not found.

delete/api/v1/Cameras/{id}
/api/v1/Cameras/{id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Retrieves all cameras.

Responses

200

Returns the found cameras.

get/api/v1/Cameras
/api/v1/Cameras

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Updates the specified camera.

Supported values for FaceDetectorResourceId are:

none, cpu, gpu, accurate_cpu, accurate_gpu, cpu_remote, gpu_remote, any_remote, accurate_cpu_remote, accurate_gpu_remote, accurate_any_remote

Supported values for TemplateGeneratorResourceId are:

cpu, gpu, any

Supported values for PedestrianDetectorResourceId are:

none, cpu_remote, gpu_remote, any_remote, body_parts_cpu_remote

Supported values for SpoofDetectorResourceIds are:

none, body_parts_cpu_remote, liveness_distant_cpu_remote, liveness_distant_any_remote, liveness_distant_gpu_remote, liveness_nearby_cpu_remote, liveness_nearby_gpu_remote, liveness_nearby_any_remote, external
Request Body schema:
application/json-patch+json

New camera configuration.

id
required
string <uuid>
name
required
string
source
required
string
enabled
required
boolean
faceDetectorConfig
required
object (VideoFaceDetectorConfig)
pedestrianDetectorConfig
object (VideoPedestrianDetectorConfig)
faceDetectorResourceId
required
string
templateGeneratorResourceId
required
string
pedestrianDetectorResourceId
string