Create Note
Create a new community note for specific content. Notes can include context, fact-checking, or additional information about the content.
Endpoint
POST /v1/create
Creates a new community note.
Request Body
The request body should be a JSON object with the following properties:
{
"content": "string", // Required: The note text (max 2000 chars)
"content_id": "string", // Required: ID of the content being annotated
"author": { // Optional: Author information
"id": "string", // Optional: External author ID
"name": "string" // Optional: Author name
}
}
Note: The author object is optional. If not provided, the note will be associated with the API key‘s user.
Response
Success Response (200 OK):
{
"status": "created",
"id": "note_id"
}
Error Responses:
•
400 Bad Request
- Invalid input data•
401 Unauthorized
- Invalid or missing API key•
500 Internal Server Error
- Server error while creating note
Example
Request:
curl -X POST https://communitynotes.dev/v1/create \
-H "Authorization: Bearer your_api_key" \
-H "Content-Type: application/json" \
-d '{
"content": "This claim needs context. According to official sources...",
"content_id": "post_123",
"author": {
"id": "external_user_123",
"name": "John Doe"
}
}'
Success Response:
{
"status": "created",
"id": "note_abc123"
}