← Tools Reference

Getnote

Getnote integration (AI, Productivity). Imported from open-connector.

API key23 toolshttps://openapi.biji.com
POST
getnote_save_note
Save a plain-text, link, or image-URL note to Getnote. Plain text and Getnote share links are synchronous; regular links and image notes may return tasks.

/open/api/v1/resource/note/save

8 parameters
ParamTypeRequiredDescription
noteTypestringoptionalThe note type to save.
titlestringoptionalOptional note title.
contentstringoptionalMarkdown content or image note description.
tagsarrayoptionalTag names to attach to the note.
parentIdstringoptionalParent note ID. Treat this as a string because upstream IDs are int64.
linkUrlstringoptionalURL to save when noteType is `link`.
imageUrlsarrayoptionalImage URLs to save when noteType is `img_text`; use URLs from Getnote upload to…
topicIdstringoptionalKnowledge base topic ID to save the note into.
POST
getnote_get_save_task
Check the progress of an asynchronous Getnote link or image save task.

/open/api/v1/resource/note/task/progress

1 parameter
ParamTypeRequiredDescription
taskIdstringoptionalGetnote asynchronous save task ID.
GET
getnote_list_notes
List recent Getnote notes using the official cursor pagination endpoint.

/open/api/v1/resource/note/list

1 parameter
ParamTypeRequiredDescription
cursorstringoptionalPagination cursor returned by the previous page.
GET
getnote_get_note
Get one Getnote note detail, including fields that are not present in lists.

/open/api/v1/resource/note/detail

2 parameters
ParamTypeRequiredDescription
noteIdstringrequiredGetnote note ID. Treat this as a string because upstream IDs are int64.
imageQualitystringoptionalSet to `original` to request original image links.
POST
getnote_update_note
Update a Getnote note title, plain-text content, or tags. Tags replace the existing tag list.

/open/api/v1/resource/note/update

4 parameters
ParamTypeRequiredDescription
noteIdstringrequiredGetnote note ID. Treat this as a string because upstream IDs are int64.
titlestringoptionalNew note title.
contentstringoptionalNew note content. Upstream only supports this for plain-text notes.
tagsarrayoptionalReplacement tag names.
POST
getnote_delete_note
Move a Getnote note to trash.

/open/api/v1/resource/note/delete

1 parameter
ParamTypeRequiredDescription
noteIdstringoptionalGetnote note ID. Treat this as a string because upstream IDs are int64.
POST
getnote_share_note
Generate or retrieve the idempotent public share link for a Getnote note.

/open/api/v1/resource/note/sharing

2 parameters
ParamTypeRequiredDescription
noteIdstringrequiredGetnote note ID. Treat this as a string because upstream IDs are int64.
excludeAudiobooleanoptionalWhether to exclude audio from the public share.
GET
getnote_list_note_tags
List tags attached to one Getnote note.

/open/api/v1/resource/note/detail

1 parameter
ParamTypeRequiredDescription
noteIdstringoptionalGetnote note ID. Treat this as a string because upstream IDs are int64.
POST
getnote_add_note_tags
Add one or more tags to a Getnote note.

/open/api/v1/resource/note/tags/add

2 parameters
ParamTypeRequiredDescription
noteIdstringoptionalGetnote note ID. Treat this as a string because upstream IDs are int64.
tagsarrayoptionalTag names to add.
POST
getnote_remove_note_tag
Remove one Getnote tag by tag ID. System tags cannot be deleted upstream.

/open/api/v1/resource/note/tags/delete

2 parameters
ParamTypeRequiredDescription
noteIdstringoptionalGetnote note ID. Treat this as a string because upstream IDs are int64.
tagIdstringoptionalTag ID to remove, as returned by list_note_tags or note detail.
POST
getnote_search_notes
Run Getnote semantic search globally, or within one knowledge base when topicId is provided.

/open/api/v1/resource/recall/knowledge

3 parameters
ParamTypeRequiredDescription
querystringrequiredNatural language search query.
topicIdstringoptionalKnowledge base topic ID for scoped search.
topKintegeroptionalMaximum number of results to return. Getnote allows up to 10.
GET
getnote_list_knowledge_bases
List knowledge bases owned by the authenticated Getnote account.

/open/api/v1/resource/knowledge/subscribe/list

1 parameter
ParamTypeRequiredDescription
pageintegeroptionalPage number to request.
GET
getnote_list_subscribed_knowledge_bases
List knowledge bases subscribed by the authenticated Getnote account. These are read-only unless the user is an admin.

/open/api/v1/resource/knowledge/subscribe/list

1 parameter
ParamTypeRequiredDescription
pageintegeroptionalPage number to request.
POST
getnote_create_knowledge_base
Create a Getnote knowledge base. Upstream limits creation to 50 per day.

/open/api/v1/resource/knowledge/create

2 parameters
ParamTypeRequiredDescription
namestringrequiredKnowledge base name.
descriptionstringoptionalKnowledge base description.
GET
getnote_list_knowledge_base_notes
List notes in one Getnote knowledge base.

/open/api/v1/resource/knowledge/notes

2 parameters
ParamTypeRequiredDescription
topicIdstringrequiredGetnote knowledge base topic ID.
pageintegeroptionalPage number to request.
POST
getnote_add_notes_to_knowledge_base
Add up to 20 notes to one Getnote knowledge base. Subscribed knowledge bases are read-only unless the user is an admin.

/open/api/v1/resource/knowledge/note/batch-add

2 parameters
ParamTypeRequiredDescription
topicIdstringoptionalGetnote knowledge base topic ID.
noteIdsarrayoptionalNote IDs to add.
POST
getnote_remove_notes_from_knowledge_base
Remove notes from one Getnote knowledge base.

/open/api/v1/resource/knowledge/note/remove

2 parameters
ParamTypeRequiredDescription
topicIdstringoptionalGetnote knowledge base topic ID.
noteIdsarrayoptionalNote IDs to remove.
GET
getnote_list_knowledge_base_bloggers
List bloggers subscribed in one Getnote knowledge base.

/open/api/v1/resource/knowledge/bloggers

2 parameters
ParamTypeRequiredDescription
topicIdstringrequiredGetnote knowledge base topic ID.
pageintegeroptionalPage number to request.
GET
getnote_list_blogger_contents
List content items for a subscribed blogger in a Getnote knowledge base.

/open/api/v1/resource/knowledge/blogger/contents

3 parameters
ParamTypeRequiredDescription
topicIdstringrequiredGetnote knowledge base topic ID.
followIdstringrequiredBlogger follow ID returned by list_knowledge_base_bloggers.
pageintegeroptionalPage number to request.
GET
getnote_get_blogger_content
Get one Getnote blogger content detail, including original text when returned.

/open/api/v1/resource/knowledge/blogger/content/detail

2 parameters
ParamTypeRequiredDescription
topicIdstringoptionalGetnote knowledge base topic ID.
postIdstringoptionalBlogger post ID alias returned by list_blogger_contents.
GET
getnote_list_knowledge_base_lives
List completed live sessions in one Getnote knowledge base.

/open/api/v1/resource/knowledge/lives

2 parameters
ParamTypeRequiredDescription
topicIdstringrequiredGetnote knowledge base topic ID.
pageintegeroptionalPage number to request.
GET
getnote_get_live_detail
Get one Getnote live detail, including AI summary and transcript when returned.

/open/api/v1/resource/knowledge/live/detail

2 parameters
ParamTypeRequiredDescription
topicIdstringoptionalGetnote knowledge base topic ID.
liveIdstringoptionalLive ID returned by list_knowledge_base_lives.
POST
getnote_follow_live
Subscribe a Dedao live channel link into one Getnote knowledge base. Upstream currently supports Dedao App live links.

/open/api/v1/resource/knowledge/live/follow

3 parameters
ParamTypeRequiredDescription
topicIdstringrequiredGetnote knowledge base topic ID.
linkstringrequiredDedao live link to subscribe.
platformstringoptionalOptional upstream platform value.