API Reference

Complete reference for the Community Notes API. All API endpoints require authentication using an API key. Learn how to obtain and use API keys in our Getting Started guide.

Authentication

All API requests must include your API key in the Authorization header:

Authorization: Bearer your_api_key_here

Available Endpoints

Notes

POST /v1/create - Create a new note →
GET /v1/[id] - Get note details →
POST /v1/vote - Vote on a note →
POST /v1/request - Request a note for content →
POST /v1/ai - Generate an AI-powered note →

Response Format

All API endpoints return JSON responses with a consistent format:

• Success responses include a status field and relevant data
• Error responses include an error field with a description
• HTTP status codes are used appropriately (200 for success, 4xx for client errors, 5xx for server errors)

Rate Limits

Rate limits may apply to API endpoints. Contact us for details about rate limits for your specific use case.