Adds summarize action to the public API (proxy to TRPC mutation) #1088

erik-nilcoast · 2025-03-02T23:38:37Z

I added this in two commits. One is just for me. I had a few issues getting this running locally on a Linux box. It could just be a me problem :|

The second commit has the addition of a subroute for the summary mutation. It should return the bookmark object with the summarized contents. Please feel free to add or remove any commits and I'll do my best to address any feedback.

Thanks for a fantastic project.

Addresses: #523

erik-nilcoast · 2025-03-02T23:41:43Z

apps/web/app/api/v1/bookmarks/summary/route.ts

+export const POST = (req: NextRequest) =>
+  buildHandler({
+    req,
+    searchParamsSchema: z.object({ bookmarkId: z.string() }),


I put this in a query param for now testing, but let me know if it'd be more idiomatic for this code base to use a routeParam (e.g. /api/v1/bookmarks/summary/:bookmark-id), a queryParam, or a structured POST body like: { bookmarkId: foo-id }. Let me know what you prefer.

I think it'll be more idiomatic if we do it as

POST /bookmarks/[bookmarkId]/summarize

to do that, you can move this file to

apps/web/app/api/v1/bookmarks/[bookmarkId]/summarize/route.ts

Works for me!

Do you want a GET then?

No POST is still the right verb here.

erik-nilcoast · 2025-03-02T23:42:15Z

package.json

@@ -32,10 +32,5 @@
    "turbo": "^2.1.2"
  },
  "prettier": "@hoarder/prettier-config",
-  "packageManager": "pnpm@9.0.0-alpha.8+sha256.a433a59569b00389a951352956faf25d1fdf43b568213fbde591c36274d4bc30",


I'll remove all of these once the question above is resolved. I just need this for now to keep working :)

MohamedBassem

Hey, thanks for opening the PR. Left a small comment about the endpoint!

MohamedBassem · 2025-03-08T10:54:48Z

apps/web/app/api/v1/bookmarks/summary/route.ts

+export const POST = (req: NextRequest) =>
+  buildHandler({
+    req,
+    searchParamsSchema: z.object({ bookmarkId: z.string() }),


I think it'll be more idiomatic if we do it as

POST /bookmarks/[bookmarkId]/summarize

to do that, you can move this file to

apps/web/app/api/v1/bookmarks/[bookmarkId]/summarize/route.ts

erik-nilcoast · 2025-03-08T14:31:22Z

Switched to a ~~GET~~ POST subroute, let me know if this needs anything else and I've removed my build hacks.

erik-nilcoast · 2025-03-08T15:29:40Z

Looks green. I'll test locally. Is there somewhere I need to add for docs or are those all autogenerated?

MohamedBassem · 2025-03-08T15:36:04Z

@erik-nilcoast Oh good catch, we need to update the docs here: https://github.com/hoarder-app/hoarder/blob/main/packages/open-api/lib/bookmarks.ts

and then call pnpm run generate inside packages/open-api to generate the openAPI files.

Also, can we call the endpoint summarize instead of summary? I feel like here you're not posting a summary but instead triggering a summarize action.

erik-nilcoast · 2025-03-08T16:27:35Z

Will do. I’ll see if I can actually get the build running locally. It didn’t work well with my setup. Probably a me problem.

…

On Sat, Mar 8, 2025, at 9:36 AM, Mohamed Bassem wrote: @erik-nilcoast <https://github.com/erik-nilcoast> Oh good catch, we need to update the docs here: https://github.com/hoarder-app/hoarder/blob/main/packages/open-api/lib/bookmarks.ts and then call `pnpm run generate` inside `packages/open-api` to generate the openAPI files. Also, can we call the endpoint `summarize` instead of `summary`? I feel like here you're not posting a summary but instead triggering a summarize action. — Reply to this email directly, view it on GitHub <#1088 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/BA5MB3OEFQTGJKQPE7FZ7LD2TME7VAVCNFSM6AAAAABYFYU6X2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDOMBYGM2TOMZQGQ>. You are receiving this because you were mentioned.Message ID: ***@***.***> MohamedBassem*MohamedBassem* left a comment (karakeep-app/karakeep#1088) <#1088 (comment)> @erik-nilcoast <https://github.com/erik-nilcoast> Oh good catch, we need to update the docs here: https://github.com/hoarder-app/hoarder/blob/main/packages/open-api/lib/bookmarks.ts and then call `pnpm run generate` inside `packages/open-api` to generate the openAPI files. Also, can we call the endpoint `summarize` instead of `summary`? I feel like here you're not posting a summary but instead triggering a summarize action. — Reply to this email directly, view it on GitHub <#1088 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/BA5MB3OEFQTGJKQPE7FZ7LD2TME7VAVCNFSM6AAAAABYFYU6X2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDOMBYGM2TOMZQGQ>. You are receiving this because you were mentioned.Message ID: ***@***.***>

erik-nilcoast · 2025-03-09T15:02:31Z

Build works great on a mac. ¯_(ツ)_/¯

@MohamedBassem docs are updated and I moved the route to summarize

Proxy to the TRPC Summarize mutation for use in the public API

erik-nilcoast · 2025-03-09T15:10:50Z

I think this is likely good to go. Let me know if there's anything else I can do to get this on the release schedule (I'd love to get off my fork).

I may need to add some additional API endpoints in the near future. I'm looking at deploying Hoarder for a client, but would love to give back where I can.

RSS of bookmark collections and email newsletter hoarding are things I'm looking to add.

MohamedBassem · 2025-03-09T15:20:55Z

Thanks a lot @erik-nilcoast (hope your client enjoys hoarder!). If you're planning to be active in the development, you might want to join us in the #development channel on discord :) Also I'd highly recommend before working on a new feature to make sure we have an issue for it with the status/approved tag, to make sure we're aligned on how this feature will look like!

erik-nilcoast · 2025-03-09T21:41:18Z

@MohamedBassem Will do, I'll join y'all.

erik-nilcoast mentioned this pull request Mar 2, 2025

Request: Use LLM (if provided) to generate a summary of the bookmark #523

Closed

erik-nilcoast commented Mar 2, 2025

View reviewed changes

MohamedBassem requested changes Mar 8, 2025

View reviewed changes

ebenoist force-pushed the erik/subscribe branch from 54bb9e1 to d1f4536 Compare March 8, 2025 14:30

ebenoist force-pushed the erik/subscribe branch 3 times, most recently from c9fcd1d to c6eb789 Compare March 8, 2025 14:35

ebenoist force-pushed the erik/subscribe branch from c6eb789 to 988ae51 Compare March 9, 2025 15:01

feat: adds /summarize route to /api/v1/bookmarks/[id]/

66726ee

Proxy to the TRPC Summarize mutation for use in the public API

ebenoist force-pushed the erik/subscribe branch from 988ae51 to 66726ee Compare March 9, 2025 15:06

erik-nilcoast changed the title ~~Adds /summary as a subroute of api/v1/bookmarks for triggering the summary mutation~~ Adds summarize action to the public API (proxy to TRPC mutation) Mar 9, 2025

MohamedBassem merged commit 9fb8051 into karakeep-app:main Mar 9, 2025
4 checks passed

Uh oh!

Adds summarize action to the public API (proxy to TRPC mutation) #1088

Adds summarize action to the public API (proxy to TRPC mutation) #1088

Uh oh!

Conversation

erik-nilcoast commented Mar 2, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

MohamedBassem left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

erik-nilcoast commented Mar 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

erik-nilcoast commented Mar 8, 2025

Uh oh!

MohamedBassem commented Mar 8, 2025

Uh oh!

erik-nilcoast commented Mar 8, 2025 via email

Uh oh!

erik-nilcoast commented Mar 9, 2025

Uh oh!

erik-nilcoast commented Mar 9, 2025

Uh oh!

Uh oh!

MohamedBassem commented Mar 9, 2025

Uh oh!

erik-nilcoast commented Mar 9, 2025

Uh oh!

Uh oh!

erik-nilcoast commented Mar 8, 2025 •

edited

Loading