Getting Started with Community Notes

Welcome to Community Notes! This guide will help you get up and running with our platform in just a few minutes. Follow these steps to integrate community-driven content moderation into your application using our HTTP API.

Prerequisites

  • • A running web application or platform where you want to implement community notes

  • • An API key (get one by signing in)

  • • Basic understanding of REST APIs

Quick Start Steps

1. Authentication

All API requests require an API key passed in the Authorization header:

Authorization: Bearer YOUR_API_KEY

2. Base URL

All API endpoints are available at:

https://communitynotes.dev/v1

3. Create Your First Community Note

Here‘s an example of creating a community note using the HTTP API:

curl -X POST https://communitynotes.dev/v1/create \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "content": "This post is misleading.",
    "content_id": "unique-content-identifier"
  }'

Next Steps