[GH-ISSUE #43] Feature Request: REST API #42

Closed
opened 2026-03-02 11:45:59 +03:00 by kerem · 6 comments
Owner

Originally created by @georgzoeller on GitHub (Mar 29, 2024).
Original GitHub issue: https://github.com/karakeep-app/karakeep/issues/43

This is really great software, I love the clear motivation and where it fits into the ecosystem.

I'd be lovely to get an API for some common actions, primarily retrieving content, searching, and addition from outside the API.

Use case:

Originally created by @georgzoeller on GitHub (Mar 29, 2024). Original GitHub issue: https://github.com/karakeep-app/karakeep/issues/43 This is really great software, I love the clear motivation and where it fits into the ecosystem. I'd be lovely to get an API for some common actions, primarily retrieving content, searching, and addition from outside the API. Use case: - Allow interaction from external channels such as slack/discord bots - Ability to integrate with AI orchestration tooling (like mine - https://github.com/omnitool-ai/omnitool)
kerem 2026-03-02 11:45:59 +03:00
Author
Owner

@MohamedBassem commented on GitHub (Mar 29, 2024):

REST API is definitely planned, and you can even get an API key from the settings. It's just blocked on one of our dependencies getting updated for TRPC v11 :) If it takes too long, I'll just fork it and add the necessary modifications myself.

Side note: You can actually right now interact with the TRPC based API today (by inspecting the requests that chrome does, but instead of cookies using an API key from the settings). It's actually not that hard. But I don't guarantee any backward compatibility there. So I'd recommend waiting for the REST API instead.

<!-- gh-comment-id:2027251748 --> @MohamedBassem commented on GitHub (Mar 29, 2024): REST API is definitely planned, and you can even get an API key from the settings. It's just blocked on one of our dependencies getting updated for TRPC v11 :) If it takes too long, I'll just fork it and add the necessary modifications myself. > Side note: You can actually right now interact with the TRPC based API today (by inspecting the requests that chrome does, but instead of cookies using an API key from the settings). It's actually not that hard. But I don't guarantee any backward compatibility there. So I'd recommend waiting for the REST API instead.
Author
Owner

@georgzoeller commented on GitHub (Mar 29, 2024):

Amazing, thank you!

On Fri, Mar 29, 2024 at 21:33 Mohamed Bassem @.***>
wrote:

REST API is definitely planned, and you can even get an API key from the
settings. It's just blocked on one of our dependencies getting updated for
TRPC v11 :) If it takes too long, I'll just fork it and add the necessary
modifications myself.

Side note: You can actually right now interact with the TRPC based API
today (by inspecting the requests that chrome does). It's actually not that
hard. But I don't guarantee any backward compatibility there. So I'd
recommend waiting for the REST API instead.


Reply to this email directly, view it on GitHub
https://github.com/MohamedBassem/hoarder-app/issues/43#issuecomment-2027251748,
or unsubscribe
https://github.com/notifications/unsubscribe-auth/AAUEYZY6MQ4KQUEFKYV7TOTY2VNR7AVCNFSM6AAAAABFON2CDGVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDAMRXGI2TCNZUHA
.
You are receiving this because you authored the thread.Message ID:
@.***>

<!-- gh-comment-id:2027333911 --> @georgzoeller commented on GitHub (Mar 29, 2024): Amazing, thank you! On Fri, Mar 29, 2024 at 21:33 Mohamed Bassem ***@***.***> wrote: > REST API is definitely planned, and you can even get an API key from the > settings. It's just blocked on one of our dependencies getting updated for > TRPC v11 :) If it takes too long, I'll just fork it and add the necessary > modifications myself. > > Side note: You can actually right now interact with the TRPC based API > today (by inspecting the requests that chrome does). It's actually not that > hard. But I don't guarantee any backward compatibility there. So I'd > recommend waiting for the REST API instead. > > — > Reply to this email directly, view it on GitHub > <https://github.com/MohamedBassem/hoarder-app/issues/43#issuecomment-2027251748>, > or unsubscribe > <https://github.com/notifications/unsubscribe-auth/AAUEYZY6MQ4KQUEFKYV7TOTY2VNR7AVCNFSM6AAAAABFON2CDGVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDAMRXGI2TCNZUHA> > . > You are receiving this because you authored the thread.Message ID: > ***@***.***> >
Author
Owner

@webserviceXXL commented on GitHub (Jul 13, 2024):

A simple REST API with API key authentication would be saving items so much easier 😍

<!-- gh-comment-id:2227118202 --> @webserviceXXL commented on GitHub (Jul 13, 2024): A simple REST API with API key authentication would be saving items so much easier 😍
Author
Owner

@zezretro commented on GitHub (Aug 27, 2024):

Bump for being very enthusiastic to have a REST API

<!-- gh-comment-id:2311656195 --> @zezretro commented on GitHub (Aug 27, 2024): Bump for being very enthusiastic to have a REST API
Author
Owner

@georgzoeller commented on GitHub (Aug 27, 2024):

Claude can synthesize an API client from the trpc definitions in like 20s,
so I just went that route

On Tue, Aug 27, 2024 at 14:14 zezretro @.***> wrote:

Bump for being very enthusiastic to have a REST API


Reply to this email directly, view it on GitHub
https://github.com/hoarder-app/hoarder/issues/43#issuecomment-2311656195,
or unsubscribe
https://github.com/notifications/unsubscribe-auth/AAUEYZ3O3BJEZFWWAG2XMXTZTQKKZAVCNFSM6AAAAABFON2CDGVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDGMJRGY2TMMJZGU
.
You are receiving this because you authored the thread.Message ID:
@.***>

<!-- gh-comment-id:2311787939 --> @georgzoeller commented on GitHub (Aug 27, 2024): Claude can synthesize an API client from the trpc definitions in like 20s, so I just went that route On Tue, Aug 27, 2024 at 14:14 zezretro ***@***.***> wrote: > Bump for being very enthusiastic to have a REST API > > — > Reply to this email directly, view it on GitHub > <https://github.com/hoarder-app/hoarder/issues/43#issuecomment-2311656195>, > or unsubscribe > <https://github.com/notifications/unsubscribe-auth/AAUEYZ3O3BJEZFWWAG2XMXTZTQKKZAVCNFSM6AAAAABFON2CDGVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDGMJRGY2TMMJZGU> > . > You are receiving this because you authored the thread.Message ID: > ***@***.***> >
Author
Owner

@MohamedBassem commented on GitHub (Oct 20, 2024):

Just done implementing the API. It'll be available in the next release. The docs are here: https://docs.hoarder.app/api

<!-- gh-comment-id:2425175102 --> @MohamedBassem commented on GitHub (Oct 20, 2024): Just done implementing the API. It'll be available in the next release. The docs are here: https://docs.hoarder.app/api
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
starred/karakeep#42
No description provided.