Skip to content

API documentation

Jump to bottom
Adam Tauber edited this page May 14, 2025 · 3 revisions

API documentation

Endpoints

Index GET

GET /

Landing page

Signup GET

GET /signup

Signup page

Signup processor POST

POST /signup

Signup form processor

Arguments

Name Type Required Description
username string true Username of the new account
email string true Email address of the new account

Login GET

GET /login

Login page

Login processor POST

POST /login

Login form processor

Arguments

Name Type Required Description
username string true Username or email address of the new account

Logout GET

GET /logout

Destroys user session

Snapshots GET

GET /snapshots

Search in snapshots by URL

Arguments

Name Type Required Description
query string false Search term to filter snapshots

User GET

GET /users/:username

User profile page

Public bookmarks GET

GET /bookmarks

List public bookmarks with optional filters

Arguments

Name Type Required Description
query string false Search term to filter bookmarks by title
owner string false Search term to filter bookmarks by username
tag string false Search term to filter bookmarks by tag
domain string false Search term to filter bookmarks by domain
from date false Display only newer bookmarks. (Format: YYYY.MM.DD)
to date false Display only older bookmarks. (Format: YYYY.MM.DD)
search_in_snapshots boolean false Query parameter also applied to snapshot content. (Values: 0, 1)
search_in_notes boolean false Query parameter also applied to bookmark notes. (Values: 0, 1)

Snapshot GET

GET /snapshot

Displays snapshots details with additional bookmark properties

Arguments

Name Type Required Description
sid string true Snapshot key
bid int true Bookmark ID

Download snapshot GET

GET /download_snapshot

Download a self contained single file version of a snapshot

Arguments

Name Type Required Description
sid string true Snapshot key

Snapshot details GET

GET /snapshot_details

View snapshot details and resources

Arguments

Name Type Required Description
sid string true Snapshot key

Add bookmark POST

POST /add_bookmark

Add new bookmark

Arguments

Name Type Required Description
token string true Extension token. It can be found on the profile page
url URL true URL of the bookmark
title string true Title of the bookmark
notes string false Bookmark notes
favicon string false Data URL encoded favicon (https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs)
public boolean false Marks bookmark as public
tags string false Comma separated list of tags
snapshot_title string false Title of the snapshot
snapshot_text string false Text content of the snapshot
snapshot multipart file false Snapshot file

Add resource POST

POST /add_resource

Add new resource to a snapshot

Arguments

Name Type Required Description
token string true Extension token. It can be found on the profile page
sid string true Snapshot ID
meta JSON string true List of resource metadata containing objects with mimetype, extension and filename information
resource[0-9]+ multipart files true Resource files

Check bookmark GET

GET /check_bookmark

Checks if a bookmark is already exists

Arguments

Name Type Required Description
token string true Extension token. It can be found on the profile page
url URL true URL of the bookmark

Bookmark GET

GET /bookmark

Displays all details of a bookmark

Arguments

Name Type Required Description
id int true Bookmark ID

API GET

GET /api

Displays API documentation (this page)

Oauth GET

GET /oauth

Creates OAuth requests

Arguments

Name Type Required Description
provider string true Oauth provider name

Oauth verification GET

GET /oauth_redirect_handler

Verifies OAuth requests

Check token POST

POST /check_token

Verifies addon tokens

Arguments

Name Type Required Description
token string true Addon token

ActivityPub inbox POST

POST /inbox/:username

Inbox for ActivityPub messages

Arguments

Name Type Required Description
message JSON true ActivityPub message

ActivityPub outbox GET

GET /outbox/:username

Outbox of ActivityPub messages

ActivityPub webfinger GET

GET /.well-known/webfinger

Webfinger response for ActivityPub

Arguments

Name Type Required Description
resource string true ActivityPub resource

Profile GET

GET /profile

Displays the user profile page

Authentication required

Profile page POST

POST /profile

Displays the profile page with addon tokens

Authentication required

Generate addon token GET

GET /generate_addon_token

Creates a new addon token

Authentication required

Delete addon token POST

POST /delete_addon_token

Deletes an addon token

Authentication required

Arguments

Name Type Required Description
id int true Token ID

Create bookmark form GET

GET /create_bookmark

Show create bookmark form

Authentication required

Create bookmark POST

POST /create_bookmark

Create new bookmark from webapp

Authentication required

Arguments

Name Type Required Description
url string true URL of the bookmark
title string true Title of the bookmark
notes string false Bookmark notes
public boolean false Bookmark is publicly accessible

My bookmarks GET

GET /my_bookmarks

Displays bookmarks belongs to the current user with optional filters

Authentication required

Arguments

Name Type Required Description
query string false Search term to filter bookmarks by title
tag string false Search term to filter bookmarks by tag
domain string false Search term to filter bookmarks by domain
from date false Display only newer bookmarks. (Format: YYYY.MM.DD)
to date false Display only older bookmarks. (Format: YYYY.MM.DD)
is_public boolean false Display only public bookmarks. (Values: 0, 1)
is_private boolean false Display only private bookmarks. (Values: 0, 1)
search_in_snapshots boolean false Query parameter also applied to snapshot content. (Values: 0, 1)
search_in_notes boolean false Query parameter also applied to bookmark notes. (Values: 0, 1)

Edit bookmark GET

GET /edit_bookmark

Displays a bookmark with all the editable properties

Authentication required

Arguments

Name Type Required Description
id int true Bookmark ID

Save bookmark POST

POST /save_bookmark

Saves an edited bookmark

Authentication required

Arguments

Name Type Required Description
id int true Bookmark ID
title string true Title of the bookmark
notes string false Bookmark notes
public boolean false Bookmark is publicly accessible. (Omit this argument in case of private bookmarks)

Delete snapshot POST

POST /delete_snapshot

Deletes a snapshot

Authentication required

Arguments

Name Type Required Description
bid int true Bookmark ID
sid int true Snapshot ID

Delete bookmark POST

POST /delete_bookmark

Deletes a bookmark

Authentication required

Arguments

Name Type Required Description
id int true Bookmark ID

Add tag POST

POST /add_tag

Add tag to a bookmark

Authentication required

Arguments

Name Type Required Description
bid int true Bookmark ID
tag string true Tag string

Delete tag POST

POST /delete_tag

Delete tag's bookmark

Authentication required

Arguments

Name Type Required Description
bid int true Bookmark ID
tid int true Tag ID
Clone this wiki locally