Skip to content

Sighthound Redactor API Overview

Sighthound Redactor v4 offers an API that developers can use to add video redaction to their workflows and applications. The API is only available in Redactor Server, not Redactor Desktop.

Quickstart

  • Contact sales@sighthound.com to obtain a Redactor API serial number
  • Install Redactor Server (Windows or Docker)
  • Complete the initial configuration (authentication and licensing)
  • Add the required environment variable REDACTOR_API_ENABLE=1 to the host instance, and review the list of optional variables below to see if any others are desired (restart recommended)

Environment Variables

  • REDACTOR_API_ENABLE=1 Required to enable the Redactor API (default 0) Ensure you're licensed for API use.
  • REDACTOR_API_LOCALFS=1 Allows Redactor API to load/save videos on the local filesystem or network using paths such as file:///example/linux/path/video.mp4 or file:///C:/example/windows/path/ (default 0 does not allow file:/// paths)
  • REDACTOR_API_TOKEN=SomeSecret - If specified, all client API calls will require an Authorization: Bearer SomeSecret header. (disabled by default)
  • REDACTOR_LOG_LEVEL=debug - Produces more logs to assist during development. (default info)