Redactor Agent Toolkit

Redactor API toolkit

Download the Redactor Agent Toolkit to give developers and AI coding agents the Docker Compose examples, AI-optimized documentation, TypeScript definitions, and OpenAPI reference needed for Redactor API integrations.

Download toolkit zip

What is the Redactor Agent Toolkit?

The Redactor Agent Toolkit is a developer package for building Redactor API integrations with Docker Compose and AI coding agents. It includes deployment examples, AI agent-optimized documentation, TypeScript type definitions, and the OpenAPI specification so developers can understand the Redactor API before writing integration code.

Use the toolkit when you want a faster path from local setup to the first Redactor API call. The package includes agent instruction files, Markdown context in ai-context/, Redactor Docker examples, API reference files, and setup guidance for Claude Code, OpenAI Codex CLI, Cursor, GitHub Copilot, Gemini, Warp, Windsurf, OpenCode, and other agents that can discover AGENTS.md.

AI-assisted Redactor API setup

Use this path when you want a coding agent to help configure a Redactor API integration from the toolkit package.

Download the toolkit zip. Use the Redactor Agent Toolkit package: redactor-agent-toolkit.zip.
Extract it locally. Open the extracted redactor-agent-toolkit/ folder in your IDE or coding agent.
Give the agent this page. Click Copy agent prompt below, then paste the copied prompt into your coding agent.
Run /get-started. Use the toolkit-aware slash command after the agent has read the local toolkit context.

What’s inside the Redactor Agent Toolkit

Agent instructions

Root-level files such as AGENTS.md, CLAUDE.md, .cursorrules, and Copilot instructions tell coding agents how to use the Redactor API context.

AI context

The ai-context/ folder contains LLM-ready Markdown that agents can read before writing integration code.

API reference

The reference/ folder includes the OpenAPI specification and TypeScript definitions for request and response shapes.

Docker examples

The deployment-examples/ folder includes Compose profiles for API-only usage and proxy-backed embedded UI testing.

Setup options

Recommended: local toolkit plus AI agent

Use this option for the best Redactor API setup experience. The agent can inspect the downloaded directory tree, read the local context, and tailor commands to your environment.

curl -L -o redactor-agent-toolkit.zip "https://sh-io-downloads.s3.amazonaws.com/redactor/toolkit/redactor-agent-toolkit.zip"
unzip redactor-agent-toolkit.zip
cd redactor-agent-toolkit

Then open the folder in your coding agent and run /get-started. The agent should ask for your deployment mode, local project path, Docker availability, Redactor base URL, and token environment variable name before suggesting commands.

Alternative: SSH context only

Use the public SSH context only when you cannot download the zip yet but still need current Redactor API context in an agent session.

ssh toolkit.redactor.com setup | claude
ssh toolkit.redactor.com agents
ssh toolkit.redactor.com cat /toolkit/ai-context/index.md
ssh toolkit.redactor.com cat /toolkit/reference/openapi-spec.yaml

For most integrations, the downloaded toolkit is preferred because it gives your agent the full local directory tree, Docker examples, and reference files.

Run Redactor locally with Docker

Apple Silicon not supported

Redactor Server currently requires an Intel or AMD x86_64 processor. Apple Silicon M-series Macs are not supported for the Redactor server container.

Use the downloaded toolkit when you want a local Redactor server for development:

Download and extract the toolkit zip.
Open redactor-agent-toolkit/deployment-examples.
Start the API-only deployment:
```
docker compose up -d
```
If this is the first run for this instance, create the initial admin user and add the license at http://localhost:9000/admin.
Open Redactor at http://localhost:9000.

After Redactor is running, continue with Redactor API Basics, the videos:process reference, or Embedded Redactor UI if your integration needs an embedded review workflow.

Troubleshooting and safety

Logs: Check redactor-agent-toolkit/deployment-examples/volumes/redactor/logs/main.log when debugging local Docker runs.
Output files: API examples write generated media under redactor-agent-toolkit/deployment-examples/volumes/data/.
Secrets: Store Redactor tokens in environment variables such as REDACTOR_API_TOKEN.
No token pasting: Do not paste API tokens, license keys, or credentials into chat.
Hardware: Use an x86_64 host for the Redactor server container. Apple Silicon M-series Macs are not supported.
Official download: Use only the official toolkit zip URL: redactor-agent-toolkit.zip.

If you need support, include relevant log context when contacting [email protected], but do not send tokens, license keys, or credentials.

Agent compatibility

The toolkit is designed to work with agents that can read local instruction files or copied Markdown context.

Agent configuration files

Claude Code — reads CLAUDE.md and AGENTS.md; the toolkit provides /get-started and /redactor slash commands.
OpenAI Codex CLI — reads AGENTS.md.
Cursor — reads .cursorrules.
GitHub Copilot — reads .github/copilot-instructions.md.
Gemini — use AGENTS.md or copied Markdown context where supported.
Warp — use AGENTS.md or copied Markdown context where supported.
Windsurf — use .windsurfrules, AGENTS.md, or copied Markdown context where supported.
OpenCode — use AGENTS.md or copied Markdown context where supported.
Other AI coding agents — use AGENTS.md or copied Markdown context where supported.

If you copy the toolkit into your own project, reference the toolkit path from your project's agent instruction file.

Cursor — add to .cursorrules or .cursor/rules/*.mdc:

For Sighthound Redactor API integration, read docs/redactor-agent-toolkit/AGENTS.md

GitHub Copilot — add to .github/copilot-instructions.md:

For Sighthound Redactor API integration, read docs/redactor-agent-toolkit/AGENTS.md

Windsurf — add to .windsurfrules:

For Sighthound Redactor API integration, read docs/redactor-agent-toolkit/AGENTS.md

Adjust the path to match where you placed the toolkit.