Skip to main content
Open Notes is a moderation platform that combines AI classification with community review. Integrations wire Open Notes into your platform so that flagged content enters a bridging-based review loop, and consensus decisions flow back as moderation actions.

Who this is for

Forum admin running Discourse

You’re installing, configuring, or troubleshooting the Open Notes plugin on your Discourse forum. Jump to Existing Integrations → Discourse.

Engineer building a new integration

You’re wiring Open Notes into a new platform. Start with the Integration Guide — concepts, onboarding, and the end-to-end walkthrough.

API consumer needing endpoint reference

You already have a platform:adapter API key and need endpoint reference. Head to the API Reference.

How it all fits together

  • opennotes-server is the hosted REST API and scoring engine. It runs at https://api.opennotes.ai today.
  • platform:adapter-scoped API keys are the public API boundary. You mint them on platform.opennotes.ai after registering your community.
  • Integrations (like the Discourse plugin) translate between your platform’s content model and the Open Notes REST API. They use X-Adapter-* headers to carry end-user identity.
  • The Integration Guide documents the public API contract. The Discourse plugin is the reference implementation — see the Integration Guide overview for the canonical statement on how the plugin serves as the tie-breaker for ambiguity.
SectionCovers
Integration GuideOnboarding via platform.opennotes.ai, auth, scopes, X-Adapter-* headers, endpoint walkthrough, webhooks, errors
Existing IntegrationsPer-integration docs (install, configure, upgrade, troubleshoot). Discourse today.
API ReferenceExhaustive endpoint reference generated from the /api/public/v1 OpenAPI schema

Something missing?

This site is published at docs.opennotes.ai. The docs source lives at opennotes-docs/ in the opennotes monorepo. Open a PR or file an issue — these pages are intentionally co-located with the code they document.