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.

Quick Start

  • 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 - Required to enable the Redactor API if set to '1'. Ensure you're licensed for API use. (default: '0')
  • REDACTOR_API_LOCALFS - 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/, if set to 1. (default: '0')
  • REDACTOR_API_OP_MAX_RUNNING - How many API operations to run in parallel. (default: '4')
  • REDACTOR_API_OP_QUEUE_LIMIT - How many API operations to queue if the system is busy. (default: '1024')
  • REDACTOR_API_OP_QUEUE_SYNC - Queue synchronous API operations (if set to '1'). (default: '0')
  • REDACTOR_API_TOKEN - If specified, all client API calls will require an Authorization: Bearer {TOKEN} header.
  • REDACTOR_LOG_LEVEL - Produces more or less log information (debug|info|warn|error). (default: 'info')