Request Note

Request a community note for specific content. This is useful when you want to indicate that a piece of content needs additional context or fact-checking.

Endpoint

POST /v1/request

Request a note for specific content.

Request Body

The request body should be a JSON object with the following properties:

{
  "content_id": "string", // Required: ID of the content to request a note for
  "context": "string"     // Optional: Additional context about why a note is needed
}

Response

Success Response (200 OK):

{
  "status": "accepted",
  "id": "request_id"
}

Error Responses:

• 400 Bad Request - Invalid input data
• 401 Unauthorized - Invalid or missing API key
• 500 Internal Server Error - Server error while creating request

Example

Request with context:

curl -X POST https://communitynotes.dev/v1/request \
  -H "Authorization: Bearer your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "content_id": "post_123",
    "context": "This post makes claims about climate change that need verification"
  }'

Simple request:

curl -X POST https://communitynotes.dev/v1/request \
  -H "Authorization: Bearer your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "content_id": "post_123"
  }'

Success Response:

{
  "status": "accepted",
  "id": "request_abc123"
}

Notes