REST API Overview

OpenAPI Documentation

OpenAPI documentation is available for SAFR services in the SAFR Cloud via HTTPS.

SAFR Cloud

Access to OpenAPI documentation in the SAFR Cloud can be found at the following locations:

OpenAPI Doc URL
SAFR Computer Vision API (COVI) https://covi.real.com/docs/index.html
SAFR Computer Vision Events Server API (CVEV) https://cv-event.real.com/docs/index.html
SAFR VIRGA Server API (VIRGA) https://virga.real.com/docs/index.html
SAFR Object Server API (CVOS) https://cvos.real.com/docs/index.html

Local Access

If you're using an on-premises license, API documentation can be accessed locally at the following locations. (Substitute the server's IP address or DNS name as needed.)

OpenAPI Doc URL
SAFR Computer Vision API (COVI) https://<ipaddress or localhost>:8080/docs/index.html or
http://<ipaddress or localhost>:8081/docs/index.html
SAFR Computer Vision Events Server API (CVEV) https://<ipaddress or localhost>:8082/cv-event/docs/index.html or
http://<ipaddress or localhost>:8083/cv-event/docs/index.html
SAFR VIRGA Server API (VIRGA) https://<ipaddress or localhost>:8084/virga/docs/index.html or
http://<ipaddress or localhost>:8085/virga/docs/index.html
SAFR Object Server API (CVOS) https://<ipaddress or localhost>:8086/cvos/docs/index.html or
http://<ipaddress or localhost>:8087/cvos/docs/index.html

Video Demos

To assist in using SAFR OpenAPI documentation, view the following video demos:

System Logs and Privacy

To protect privacy, SAFR limits retention of system logs associated with events to a time frame configured using an admin system API. When used in conjunction with eventArchiveTimeLimit in the Admin Tenant API, no trace of individual whereabouts is kept beyond the configured retention time.

Recognition logs are reduced in their default logging level not to include any personally identifiable information (PII).

See Also