Redactor API Toolkit¶

The Redactor API Toolkit is a distribution package for developers integrating with the Redactor API. It includes Docker Compose configurations, AI agent-optimized documentation, TypeScript type definitions, and the OpenAPI specification.

Obtaining the Toolkit¶

Contact sales@sighthound.com to obtain the toolkit zip file and an evaluation serial number.

Folder Structure¶

After extracting the zip, the toolkit contains the following:

redactor-api-toolkit/
├── sighthound-redactor-api-examples/   # Docker Compose configs
│   ├── docker-compose.yml
│   ├── config/                         # NGINX and example HTML files
│   └── volumes/
│       ├── data/                       # Mounted at /data/ in the container (output location)
│       └── redactor/                   # Application state and log files
├── llm/                                # AI agent-optimized documentation
│   └── index.md                        # Entry point for AI agents
├── reference/                          # API reference materials
│   ├── openapi.yaml                    # OpenAPI specification
│   └── sh-types.d.ts                   # TypeScript type definitions
├── AGENTS.md                           # AI agent quick reference pointer
└── README.md

`sighthound-redactor-api-examples/`¶

Docker Compose configurations with profiles for different deployment scenarios:

API-only — Run Redactor with the API enabled (docker compose up -d)
Same-domain proxy — NGINX reverse proxy on the same domain (docker compose --profile with-same-domain-proxy up -d)
Cross-domain proxy — NGINX reverse proxy on a separate domain (docker compose --profile with-cross-domain-proxy up -d)

See Embedded Redactor UI for details on the proxy deployment options.

`llm/`¶

Markdown documentation optimized for AI coding agents and LLMs, so you can ask your agent questions about Redactor as you work. See Using with AI Coding Agents below for setup.

`reference/`¶

API reference materials including the OpenAPI specification (openapi.yaml) and TypeScript type definitions (sh-types.d.ts).

Quick Start¶

Apple Silicon Not Supported

The Redactor server currently requires an Intel/AMD (x86_64) processor. M-series Macs (Apple Silicon) are not supported at this time.

Extract the toolkit zip to your computer
cd into the redactor-api-toolkit/sighthound-redactor-api-examples folder
Start the Redactor container:
```
docker compose up -d
```
If this is your first time running this instance of Redactor, set up your initial admin user and add a license at http://localhost:9000/admin

Redactor is now running and accessible at http://localhost:9000.

Volume Mounts¶

The Docker Compose configuration mounts two directories from your host into the Redactor container:

./volumes/data/ — Mounted at /data/ inside the container. This is used as an output location for redacted videos and other files generated by the API. Several of the API examples use this path, so you can easily access results from your host machine.

./volumes/redactor/ — Stores all application state and log files. If you encounter any issues, review the log file at ./volumes/redactor/logs/main.log or send it to support@redactor.com for assistance.

Using with AI Coding Agents¶

The llm/ folder contains Markdown documentation specifically structured for AI coding agents (such as Cursor, GitHub Copilot, Claude Code, etc.), giving them full context on the Redactor API so you can ask questions and get help as you build your integration.

Working directly in the toolkit¶

If you're working from within the redactor-api-toolkit/ folder, the included AGENTS.md at the root means most AI coding agents will automatically discover the LLM documentation — no extra configuration needed.

Copying the toolkit into your project¶

If you copy the redactor-api-toolkit/ folder into your own project's source code, add a reference to the LLM documentation in your project's AI agent configuration file (AGENTS.md, CLAUDE.md, .cursorrules, etc.):

## External Documentation

For Sighthound Redactor API integration or embedded Redactor UI development,
see: ./docs/redactor-api-toolkit/llm/index.md

Adjust the path to match where you placed the toolkit in your project.