Skip to content

Libraries API ​

Search and query indexed library documentation.

List Libraries ​

GET /libraries

Query Parameters ​

ParameterTypeDescription
categorystringFilter by category
limitnumberMax results (1-50)
offsetnumberPagination offset

Response ​

json
{
  "data": {
    "libraries": [
      {
        "id": "react",
        "name": "React",
        "description": "A JavaScript library for building user interfaces",
        "snippets": 2341,
        "category": "frontend"
      }
    ],
    "total": 500
  }
}

Get Library ​

GET /libraries/:id

Response ​

json
{
  "data": {
    "id": "react",
    "name": "React",
    "description": "A JavaScript library for building user interfaces",
    "version": "18.2.0",
    "snippets": 2341,
    "category": "frontend",
    "sourceUrl": "https://react.dev"
  }
}

Query Documentation ​

POST /libraries/:id/query

Request Body ​

json
{
  "query": "useEffect cleanup function",
  "limit": 5,
  "tokens": "full"
}

Response ​

json
{
  "data": {
    "results": [
      {
        "title": "Cleaning up Effects",
        "content": "Return a cleanup function...",
        "source": "react.dev/reference/react/useEffect",
        "relevance": 0.95
      }
    ]
  }
}

Released under the MIT License.