API Reference

Query public notes, subjects, and topics directly from your code tools using our developer endpoints.

GET/api/notes

Retrieve a list of public notes, filtered by pagination, subject, or topic.

Request Parameters

Parameter	Type	Description
page	integer	Page number (default: 1)
limit	integer	Notes per page (default: 10)
subject	string	Subject slug filter

Example Response (JSON)

{
  "notes": [
    {
      "id": "cmqlccfr7001qwemo4ye3ozaz",
      "title": "The CAP Theorem",
      "slug": "the-cap-theorem",
      "excerpt": "Master consistency, availability, and partition tolerance...",
      "difficulty": "HARD",
      "views": 482,
      "topic": {
        "name": "Distributed Databases",
        "slug": "distributed-databases"
      }
    }
  ],
  "totalPages": 5,
  "currentPage": 1
}

GET/api/notes/:id

Retrieve comprehensive details of a single public note, including its content sections.

Request Parameters

Parameter	Type	Description
id	string	Unique UUID or Cuid of the note

Example Response (JSON)

{
  "id": "cmqlccfr7001qwemo4ye3ozaz",
  "title": "The CAP Theorem",
  "status": "PUBLISHED",
  "sections": [
    {
      "id": "sec-1",
      "title": "Deconstructing CAP",
      "contentType": "TEXT",
      "content": "Formulated by Eric Brewer..."
    }
  ]
}