The API provides access to my library of highlights and titles. Highlights are short texts that capture something interesting or thought-provoking from a book, letter, article, podcast, or any other source. Titles represent all types of reading material I have in my library, including books, letters, blogs, transcripts, and reports. These are all organised into four categories: life, which contains ideas for living a better and happier life; business, which focuses on building better businesses and products; investing, which provides insights into investing and growing wealth; and technology, which explores technology-related ideas. Some titles may not have a category assigned and will have a null value.
https://michalsujka-main-55d81d3.zuplo.appHighlight is a short text that captures something interesting or, thought-provoking from a book, letter, article, podcast, or any other source. The highlights can be used to remember, share, or inspire. Over the years I have collected a lot of highlights, and I am in the process of digitising them. As of today, only some of them are available via this API.
| GET | /highlights |
| POST | /highlights |
| GET | /highlights/:id |
| PATCH | /highlights/:id |
| DELETE | /highlights/:id |
Titles represent all types of reading material I have in my library, including books, letters, blogs, transcripts, and reports. These are all organised into four categories: life, which contains ideas for living a better and happier life; business, which focuses on building better businesses and products; investing, which provides insights into investing and growing wealth; and technology, which explores technology-related ideas. Some titles may not have a category assigned and will have a null value. My current favorite titles have the category favorite assigned.
| GET | /titles |
| POST | /titles |
| GET | /titles/:id |
| PATCH | /titles/:id |
| DELETE | /titles/:id |
Returns a list of the highlights. You can filter the list by author, title, and highlighted text. You can also limit the number of objects returned and order them in ascending or random order. The default limit is 10 objects. The default order is random.
author
The name of the original author or authors.
category
Titles and highlights are categorised into four categories:
life, which contains ideas for living a better and happier life;
business, which focuses on building better businesses and products;
investing, which provides insights into investing and growing wealth;
technology, which explores technology-related ideas.
My current "best of" are labeled with category favorite.
Some may not have a category assigned and will have a null value.
life
business
investing
technology
favorite
limit
The number of objects to return.
order
The order in which to return the objects. ascending returns the highlights in the order they appear in the original text, sorted by the index property if specified. random returns the highlights in a random order. The default order is random.
ascending
random
text
The text of the highlight.
title
The main title of the book, letter, podcast, transcript or any other text.
1
Creates a new highlight object.
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
text
The text of the highlight.
title
The main title of the book, letter, podcast, transcript or any other text.
heading
The heading, subtitle, or chapter of the book, letter, podcast or any other source.
author
The name of the original author or authors.
category
Titles and highlights are categorised into four categories:
life, which contains ideas for living a better and happier life;
business, which focuses on building better businesses and products;
investing, which provides insights into investing and growing wealth;
technology, which explores technology-related ideas.
My current "best of" are labeled with category favorite.
Some may not have a category assigned and will have a null value.
life
business
investing
technology
favorite
index
The index defines the order of highlights as they appear on the source text.
notes
My notes to the highlight. Most often, I use the notes to add context to the highlight.
page
The page number makes it easier to find the highlighted text in the original text. Note that I do not always provide the page number and page numbers may differ for different editions of the same book.
1
{
"text": "Difference for the sake of it. In everything. Because it must be better. From the moment the idea strikes, to the running of the business. Difference, and retention of total control.",
"title": "Against The Odds",
"heading": "Introduction",
"author": "James Dyson",
"category": "business",
"index": 5,
"page": 9
}Retrieves the details of an existing highlight. Supply the unique highlight id from either a highlight creation request or the highlights list, and I will return the corresponding highlight information.
id
The unique identifier of the object.
1
Updates the specific highlight by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
id
The unique identifier of the object.
text
The text of the highlight.
title
The main title of the book, letter, podcast, transcript or any other text.
heading
The heading, subtitle, or chapter of the book, letter, podcast or any other source.
author
The name of the original author or authors.
category
Titles and highlights are categorised into four categories:
life, which contains ideas for living a better and happier life;
business, which focuses on building better businesses and products;
investing, which provides insights into investing and growing wealth;
technology, which explores technology-related ideas.
My current "best of" are labeled with category favorite.
Some may not have a category assigned and will have a null value.
life
business
investing
technology
favorite
index
The index defines the order of highlights as they appear on the source text.
notes
My notes to the highlight. Most often, I use the notes to add context to the highlight.
page
The page number makes it easier to find the highlighted text in the original text. Note that I do not always provide the page number and page numbers may differ for different editions of the same book.
1
{
"author": "James Dyson"
}Deletes the specific highlight. You need to supply the unique highlight id to delete the highlight.
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
id
The unique identifier of the object.
1
Returns a sorted list of titles. You can refine your search by specifying the author, title, or category. By default, the limit is 10 objects ordered alphabetically by title, with favorite titles appearing at the top.
author
The name of the original author or authors.
category
Titles and highlights are categorised into four categories:
life, which contains ideas for living a better and happier life;
business, which focuses on building better businesses and products;
investing, which provides insights into investing and growing wealth;
technology, which explores technology-related ideas.
My current "best of" are labeled with category favorite.
Some may not have a category assigned and will have a null value.
life
business
investing
technology
favorite
limit
The number of objects to return.
title
The main title of the book, letter, podcast, transcript or any other text.
1
Creates a new title object.
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
title
The main title of the book, letter, podcast, transcript or any other text.
author
The name of the original author or authors.
category
Titles and highlights are categorised into four categories:
life, which contains ideas for living a better and happier life;
business, which focuses on building better businesses and products;
investing, which provides insights into investing and growing wealth;
technology, which explores technology-related ideas.
My current "best of" are labeled with category favorite.
Some may not have a category assigned and will have a null value.
life
business
investing
technology
favorite
1
{
"title": "Against The Odds",
"author": "James Dyson",
"category": "business"
}Retrieves the details of an existing title. Supply the unique title id from either a title creation request or the title list, and I will return the corresponding title information.
id
The unique identifier of the object.
1
Updates the specific title by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
id
The unique identifier of the object.
title
The main title of the book, letter, podcast, transcript or any other text.
author
The name of the original author or authors.
category
Titles and highlights are categorised into four categories:
life, which contains ideas for living a better and happier life;
business, which focuses on building better businesses and products;
investing, which provides insights into investing and growing wealth;
technology, which explores technology-related ideas.
My current "best of" are labeled with category favorite.
Some may not have a category assigned and will have a null value.
life
business
investing
technology
favorite
1
{
"author": "James Dyson"
}Deletes the specific title. You need to supply the unique title id to delete the title.
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
id
The unique identifier of the object.
1