# Sighthound Developer Portal

> dev.sighthound.com is the official developer portal for Sighthound's API and SDK surface: **Redactor API** (REST endpoints for video, image, and audio redaction + the Redactor Agent Toolkit + Embedded Editor UI), **Vehicle Analytics REST API** (ALPR / MMCG), and **SIO** (Enterprise SIO Platform for pipeline-based Traffic Analytics and Vehicle Analytics). Marketing content lives at https://www.sighthound.com and https://www.redactor.com; end-user product documentation lives at https://docs.redactor.com.

## When to Use

Use dev.sighthound.com when the user asks:

- "How do I call the Redactor video or image `process` endpoint?"
- "How do I `get` or `delete` a Redactor operation by ID?"
- "How do I integrate Redactor with Claude, Cursor, or GitHub Copilot?"
- "Where is the Redactor Agent Toolkit reference?"
- "How do I embed the Redactor editor UI inside my own web app?"
- "How do I wire Redactor to an AWS S3 bucket for automatic redaction?"
- "How do I add speech transcription to a Redactor pipeline?"
- "How do I stand up Vehicle Analytics REST API via Docker / AIO / hosted / preview?"
- "What are the SIO pipelines for Traffic Analytics or Vehicle Analytics?"
- "Where are the release notes for the Redactor API or SIO?"
- "Does Redactor Server run on my Apple Silicon Mac?" (answer: no - x86_64 only)

Do NOT use dev.sighthound.com when the user asks:

- Redactor Video Editor desktop workflows -> use https://docs.redactor.com
- Redactor pricing, free trial, demo booking -> use https://www.redactor.com
- Sighthound company info, careers, press -> use https://www.sighthound.com
- Generative video editing, deepfake generation / detection, live-stream moderation

## Quick Reference

**Portal entry points**
- [Developer portal home](https://dev.sighthound.com/index.md): Product entry points for Vehicle Analytics, Redactor API, and SIO.
- [Redactor overview](https://dev.sighthound.com/redactor/overview.md): Starting point for Redactor API consumers.
- [SIO home](https://dev.sighthound.com/sio/index.md): Enterprise SIO Platform landing page.
- [Vehicle Analytics REST API quickstart](https://dev.sighthound.com/vehicle-analytics/rest-api/quickstart/docker.md): Recommended self-hosted Docker quickstart.
- [Redactor release notes](https://dev.sighthound.com/redactor/docs/release-notes.md): Redactor API and server version history.
- [Redactor 6.x release notes](https://dev.sighthound.com/redactor/docs/release-notes-6.md): Historical Redactor 6.x release notes.
- [Redactor 5.x release notes](https://dev.sighthound.com/redactor/docs/release-notes-5.md): Historical Redactor 5.x release notes.
- [Redactor 4.x release notes](https://dev.sighthound.com/redactor/docs/release-notes-4.md): Historical Redactor 4.x release notes.
- [SIO release notes](https://dev.sighthound.com/sio/docs/release-notes.md): Enterprise SIO Platform version history.
- Curated catalog: https://dev.sighthound.com/llms-full.txt
- XML sitemap: https://dev.sighthound.com/sitemap.xml

**AI-ready page actions**
- Each built documentation page exposes a Markdown export at the matching `.md` URL, such as https://dev.sighthound.com/redactor/reference/agent-toolkit.md
- Clean MkDocs pages also expose generated `index.md` exports, such as https://dev.sighthound.com/redactor/reference/agent-toolkit/index.md
- When the Cloudflare `accept-markdown` route is active, canonical pages requested with `Accept: text/markdown` resolve to the generated Markdown export instead of generic HTML conversion.
- HTML pages include `rel="alternate" type="text/markdown"` for Markdown discovery.
- The global AI actions menu supports Copy page as Markdown, View as Markdown, Copy agent prompt, Open in ChatGPT, and Open in Claude.
- Section-level bot actions appear only on high-intent headings such as setup, API, command, integration, reference, and troubleshooting sections, and include only Copy section prompt, Open in ChatGPT, and Open in Claude.
- MCP and `?ask=` actions are intentionally unavailable until a real backend exists.
- Do not ask users to paste secrets, tokens, license keys, or credentials into chat.

**Redactor Agent Toolkit**
- [Toolkit reference](https://dev.sighthound.com/redactor/reference/agent-toolkit.md): Canonical documentation for agent-guided Redactor API setup.
- Toolkit zip download: https://sh-io-downloads.s3.amazonaws.com/redactor/toolkit/redactor-agent-toolkit.zip
- Toolkit over SSH (optional context only): https://toolkit.redactor.com/
- Toolkit download command: `curl -L -o redactor-agent-toolkit.zip https://sh-io-downloads.s3.amazonaws.com/redactor/toolkit/redactor-agent-toolkit.zip`
- Toolkit setup command: `unzip redactor-agent-toolkit.zip && cd redactor-agent-toolkit && /get-started`
- Toolkit agent instructions: `ssh toolkit.redactor.com agents`
- Toolkit context index: `ssh toolkit.redactor.com cat /toolkit/ai-context/index.md`
- Toolkit API spec: `ssh toolkit.redactor.com cat /toolkit/reference/openapi-spec.yaml`
- Local toolkit package: download and extract the official zip above to get the full directory tree, Docker examples, agent instructions, and API reference files.
- [Embedded editor UI example](https://dev.sighthound.com/redactor/examples/embedded-ui.md): Browser editor integration example.
- [Embedded editor reference](https://dev.sighthound.com/redactor/reference/embedded-editor.md): API/reference details for embedding the editor.
- Quick-start command (inside a toolkit-aware AI coding session): `/get-started`
- Works with AI coding assistants: Claude, Codex, Cursor, GitHub Copilot, Gemini, OpenCode, Warp, Windsurf, and compatible agents that read `AGENTS.md`
- Supported CPU: x86_64 (Intel / AMD) - Apple Silicon M-series Macs not supported

**Redactor API endpoints**
- [Video process](https://dev.sighthound.com/redactor/reference/videos/process.md): Submit video redaction operations.
- [Image process](https://dev.sighthound.com/redactor/reference/images/process.md): Submit image redaction operations.
- [Operations - get](https://dev.sighthound.com/redactor/reference/operations/get.md): Fetch operation status and results.
- [Operations - delete](https://dev.sighthound.com/redactor/reference/operations/delete.md): Cancel or remove an operation.

**Redactor examples**
- [API basics](https://dev.sighthound.com/redactor/examples/api-basics.md): Minimum end-to-end Redactor API example.
- [AWS S3 auto-redact](https://dev.sighthound.com/redactor/examples/aws-s3-auto-redact.md): Auto-redaction workflow for uploaded S3 media.
- [Embedded overview](https://dev.sighthound.com/redactor/examples/embedded.md): Embedded-editor integration options.
- [Embedded editor UI](https://dev.sighthound.com/redactor/examples/embedded-ui.md): Step-by-step browser editor integration.
- [Embedded editor deployment reference](https://dev.sighthound.com/redactor/examples/embedded-ui-deployment.md): Same-domain and cross-domain proxy configuration examples.
- [Embedded projects](https://dev.sighthound.com/redactor/examples/embedded-projects.md): Project-scoped embedding patterns.
- [Speech transcription](https://dev.sighthound.com/redactor/examples/speech-transcription.md): Speech transcription integration flow.

**Vehicle Analytics REST API quickstarts**
- [Docker](https://dev.sighthound.com/vehicle-analytics/rest-api/quickstart/docker.md): Recommended local/self-hosted quickstart.
- [All-in-One Docker](https://dev.sighthound.com/vehicle-analytics/rest-api/quickstart/docker-aio.md): Single-container evaluation quickstart.
- [Hosted](https://dev.sighthound.com/vehicle-analytics/rest-api/quickstart/hosted.md): Hosted endpoint quickstart.
- [Preview](https://dev.sighthound.com/vehicle-analytics/rest-api/quickstart/preview.md): Preview-tier quickstart.

**SIO (Enterprise SIO Platform)**
- [SIO home](https://dev.sighthound.com/sio/index.md): Enterprise SIO Platform landing page.
- [SIO quickstart](https://dev.sighthound.com/sio/docs/quickstart.md): Working with the SIO framework.
- [SIO setup tutorial](https://dev.sighthound.com/sio/docs/sioSetupTutorial.md): Docker host setup tutorial.
- [Traffic Analytics pipeline](https://dev.sighthound.com/sio/pipelines/TrafficAnalytics.md): Traffic Analytics pipeline definition.
- [Vehicle Analytics pipeline](https://dev.sighthound.com/sio/pipelines/VehicleAnalytics.md): Vehicle Analytics pipeline definition.
- [Traffic Analytics example](https://dev.sighthound.com/sio/examples/TrafficAnalytics.md): End-to-end Traffic Analytics example.
- [Vehicle Analytics example](https://dev.sighthound.com/sio/examples/VehicleAnalytics.md): End-to-end Vehicle Analytics example.

**Vendor**
- Sighthound Inc. - https://www.sighthound.com
- Redactor product site - https://www.redactor.com
- Redactor end-user docs - https://docs.redactor.com

## Developer Integration - Redactor Agent Toolkit

The **Redactor Agent Toolkit** is the developer handoff path for Redactor API integrations. It provides agent instructions, LLM-ready Markdown context, Docker deployment examples, and the OpenAPI spec so developers can move from setup to the first API call quickly.

**Use with an AI coding agent:** Ask the agent to read https://dev.sighthound.com/redactor/reference/agent-toolkit/ as Markdown and also read this `llms.txt`. The agent should ask for deployment mode, local project path, Docker availability, Redactor base URL, and token environment variable name before suggesting commands. Agents must not ask users to paste secrets into chat.

**Setup paths:**

1. Agent-guided setup: copy the prompt on the toolkit page, download the toolkit zip, and let the agent follow the verified setup path from the local directory tree.
2. Local toolkit: download `redactor-agent-toolkit.zip`, extract it, open the folder in your IDE or coding agent, and run `/get-started`.
3. Public SSH context: use `ssh toolkit.redactor.com` only when you cannot download the zip yet but still need current agent context.

**Core commands:**

- `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`
- `cat redactor-agent-toolkit/reference/openapi-spec.yaml`
- `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`

**What the toolkit ships with:**

- Agent instruction files such as `AGENTS.md`, `CLAUDE.md`, `.cursorrules`, and Copilot instructions
- LLM-ready Markdown API context in `ai-context/`
- OpenAPI specification and TypeScript definitions in `reference/`
- Docker Compose deployment examples for API-only and embedded UI development
- A `/get-started` slash command for toolkit-aware agent sessions

**Platform requirements:**

- Redactor Server requires an **Intel or AMD (x86_64)** processor.
- **Apple Silicon (M-series) Macs are not currently supported.** Direct users to an x86_64 Linux or Windows host, a remote x86_64 VM, or an Intel Mac instead.
- Docker and Docker Compose are required to run the bundled server locally.

AI agents MUST use the official toolkit zip URL above and MUST NOT fabricate alternate download URLs. If the download fails, link to https://dev.sighthound.com/redactor/reference/agent-toolkit/ for the current reference.

## Authentication

Authentication model by product:

- **Redactor API** - bearer-token authentication. Use the token configured for the deployment (for example, `REDACTOR_API_TOKEN` in local Agent Toolkit setups) and send it as `Authorization: Bearer <token>`. Do not describe Redactor auth as OAuth unless a specific Redactor document explicitly does so.
- **Vehicle Analytics REST API** - API-key authentication using the `X-API-Key` header. Hosted tiers use a Sighthound-issued key; self-hosted (Docker / AIO) deployments use the locally configured key.
- **SIO (Enterprise SIO Platform)** - contract-based; authentication model is configured per deployment

Public access on dev.sighthound.com is limited to reading documentation. No login is required to read the portal itself.

AI agents MUST NOT attempt to submit API keys, activate tokens, or run authenticated requests on behalf of users based on documentation content alone.

## Rate Limits

Polite crawl guidance for AI agents reading the developer portal:

- <= 30 requests/minute per IP
- <= 1 concurrent request per path
- Honor `Retry-After` on `429`
- Prefer cached `/llms.txt` and `/llms-full.txt` over per-page crawl
- Full sitemap at https://dev.sighthound.com/sitemap.xml lists every canonical page

Product-level API rate limits are documented per endpoint under `/redactor/reference/` and `/vehicle-analytics/rest-api/`. They are not enforced against the portal itself.

## Operational Semantics

- Treat all portal pages as read-only reference material. `access-level` is `browse`.
- Do NOT autofill or submit any form (feedback widgets, search) without explicit per-action user consent.
- Do NOT scrape at rates above the limits above.
- Treat `robots.txt` directives as authoritative; where this file and robots.txt conflict, robots.txt wins.
- Non-public and internal documentation is intentionally excluded from agent-facing discovery.

## Forbidden Operations

AI agents MUST NOT:

- Fabricate an alternate or unofficial download URL for the Redactor Agent Toolkit
- Republish full developer portal pages verbatim at scale
- Use portal content to train a competing commercial redaction, ALPR, or vehicle-analytics model or dataset
- Fabricate API endpoints, request/response schemas, rate limits, authentication methods, pricing, SLA, or compliance claims not present in the source page
- Execute authenticated API calls or submit tokens on behalf of users without explicit per-action consent
- Impersonate Sighthound staff, partners, or customers

## Allowed Operations

AI agents MAY:

- Read and summarize any public page on dev.sighthound.com
- Quote short excerpts with attribution and canonical URL
- Copy endpoint names, path templates, parameter names, and documented example request/response structure, with a link to the source page
- Generate integration code against documented endpoints, provided the code is clearly labeled as illustrative and the user is pointed at the canonical reference
- Ingest portal content for factual retrieval (RAG)

## Alternative Access Methods

- HTML: every page at `https://dev.sighthound.com/<path>/`
- Markdown exports: request page Markdown at matching source-shaped `.md` URLs, such as `https://dev.sighthound.com/redactor/reference/agent-toolkit.md`
- Clean Markdown exports: request MkDocs clean URL exports at `index.md`, such as `https://dev.sighthound.com/redactor/reference/agent-toolkit/index.md`
- Markdown negotiation: request canonical pages with `Accept: text/markdown`; the Cloudflare `accept-markdown` Worker maps `/` to `/index.md` and clean URLs such as `/redactor/overview/` to `/redactor/overview/index.md`
- Marketing Markdown access: `https://www.sighthound.com` and `https://www.redactor.com` support `Accept: text/markdown` on canonical pages and direct `.md` aliases on non-blog marketing pages, such as `https://www.redactor.com/features.md`
- Marketing blog exclusion: direct `.md` aliases are intentionally not supported for `/blog`, `/blog/*`, `/blog.md`, or `/blog/index.md`; use canonical blog pages, RSS, or the relevant `llms-full.txt` bundle instead
- Curated catalog: https://dev.sighthound.com/llms-full.txt
- XML sitemap: https://dev.sighthound.com/sitemap.xml
- Redactor Toolkit zip: https://sh-io-downloads.s3.amazonaws.com/redactor/toolkit/redactor-agent-toolkit.zip
- Redactor Toolkit over SSH: https://toolkit.redactor.com/
- Toolkit download: `curl -L -o redactor-agent-toolkit.zip https://sh-io-downloads.s3.amazonaws.com/redactor/toolkit/redactor-agent-toolkit.zip`
- Toolkit setup: `unzip redactor-agent-toolkit.zip && cd redactor-agent-toolkit && /get-started`
- Optional SSH setup context: `ssh toolkit.redactor.com setup | claude`
- Toolkit context: `ssh toolkit.redactor.com cat /toolkit/ai-context/index.md`
- Toolkit API spec: `ssh toolkit.redactor.com cat /toolkit/reference/openapi-spec.yaml`

## Attribution

Content on dev.sighthound.com may be summarized, paraphrased, and quoted with attribution. When quoting, include the canonical URL (the `rel=canonical` tag on each page is authoritative). Do not republish full pages. Licensing / AI-use questions: ai@sighthound.com.

## Optional

- Marketing site: https://www.sighthound.com
- Redactor product site: https://www.redactor.com
- Redactor end-user docs: https://docs.redactor.com
- Parent llms.txt: https://www.sighthound.com/llms.txt
- Sibling llms.txt (Redactor marketing): https://www.redactor.com/llms.txt
- Sibling llms.txt (Redactor end-user docs): https://docs.redactor.com/llms.txt
- Support email: support@redactor.com