Search
Hybrid search over titles, saved copies, highlights and notes, with the passage that matched and why.
get /v1/search
Hybrid search (full text + meaning) with the matched passage per bookmark. Free plans get keyword search.
Key or token with bookmarks:read Returns 200
Parameters
| Name | Type | Description |
|---|---|---|
qrequired | string | 1–500 characters. |
scope | enum | One of current, all. Default "current". |
collection | uuid | |
tag | string | 1–50 characters. |
kind | enum | One of link, note. |
source | enum | One of web, extension, slack, email, zapier, api, import, shortcut, share_target. |
unread | enum | One of true, false. |
archived | enum | One of true, false. |
ribboned | enum | One of true, false. |
savedAfter | timestamp | |
savedBefore | timestamp | |
match | enum | One of ranked, exact_url. Default "ranked". |
cursor | string | Up to 300 characters. |
limit | integer | Default 20. 1–50. |
Example
curl 'https://api.bkmark.it/v1/search?q=reciprocal%20rank%20fusion' \
-H "Authorization: Bearer $BKMARK_TOKEN" Response fields (4)
| Name | Type | Description |
|---|---|---|
resultsrequired | object[] | |
bookmarkrequired | object | |
idrequired | uuid | |
libraryIdrequired | uuid | |
kindrequired | enum | One of link, note. |
urlrequired | string or null | |
canonicalUrlrequired | string or null | |
titlerequired | string or null | |
descriptionrequired | string or null | |
summaryrequired | string or null | |
siteNamerequired | string or null | |
faviconUrlrequired | string or null | |
imageUrlrequired | string or null | |
sourcerequired | enum | One of web, extension, slack, email, zapier, api, import, shortcut, share_target. |
sourceDetailrequired | string or null | |
sourceAuthorrequired | string or null | |
fetchStatusrequired | enum | One of pending, ok, failed, gone. |
readAtrequired | string or null | |
archivedAtrequired | string or null | |
ribbonedAtrequired | string or null | |
deletedAtrequired | string or null | |
lastCheckedAtrequired | string or null | |
createdByrequired | uuid or null | |
createdAtrequired | string | |
updatedAtrequired | string | |
tagsrequired | string[] | |
collectionIdsrequired | uuid[] | |
hasSavedCopyrequired | boolean | |
libraryIdrequired | uuid | |
scorerequired | number | |
matchedInrequired | enum | One of title, url, description, saved_copy, highlight, note, meaning. |
passagerequired | object or null | |
textrequired | string | |
marksrequired | integer[][] | |
nextCursorrequired | string or null | |
moderequired | enum | One of hybrid, keyword. |
tookMsrequired | number |