Tags
Tags with live counts. Renaming to a name that exists asks you to merge instead.
get /v1/tags
Tags with live bookmark counts.
Key or token with tags:read Returns 200
Example
curl 'https://api.bkmark.it/v1/tags' \
-H "Authorization: Bearer $BKMARK_TOKEN" Response fields (1)
| Name | Type | Description |
|---|---|---|
datarequired | object[] | |
idrequired | uuid | |
namerequired | string | |
bookmarkCountrequired | integer | -9007199254740991–9007199254740991. |
createdAtrequired | string |
post /v1/tags
Create a tag.
Key or token with tags:write Returns 201
Body
| Name | Type | Description |
|---|---|---|
namerequired | string | 1–50 characters. |
Example
curl -X POST 'https://api.bkmark.it/v1/tags' \
-H "Authorization: Bearer $BKMARK_TOKEN" \
-H 'Content-Type: application/json' \
-d '{"name":"Hybrid search with pgvector"}' Response fields (4)
| Name | Type | Description |
|---|---|---|
idrequired | uuid | |
namerequired | string | |
bookmarkCountrequired | integer | -9007199254740991–9007199254740991. |
createdAtrequired | string |
patch /v1/tags/{id}
Rename a tag (409 if the name is taken: merge instead).
Key or token with tags:write Returns 200
Parameters
| Name | Type | Description |
|---|---|---|
idrequired | uuid | In the path. |
Body
| Name | Type | Description |
|---|---|---|
namerequired | string | 1–50 characters. |
Example
curl -X PATCH 'https://api.bkmark.it/v1/tags/0c9d3a52-6f1e-4b8a-9d2f-5e7a1b3c4d6e' \
-H "Authorization: Bearer $BKMARK_TOKEN" \
-H 'Content-Type: application/json' \
-d '{"name":"Hybrid search with pgvector"}' Response fields (4)
| Name | Type | Description |
|---|---|---|
idrequired | uuid | |
namerequired | string | |
bookmarkCountrequired | integer | -9007199254740991–9007199254740991. |
createdAtrequired | string |
delete /v1/tags/{id}
Delete a tag (bookmarks keep everything else).
Key or token with tags:write Returns 200
Parameters
| Name | Type | Description |
|---|---|---|
idrequired | uuid | In the path. |
Example
curl -X DELETE 'https://api.bkmark.it/v1/tags/0c9d3a52-6f1e-4b8a-9d2f-5e7a1b3c4d6e' \
-H "Authorization: Bearer $BKMARK_TOKEN" Response fields (1)
| Name | Type | Description |
|---|---|---|
messagerequired | string |
post /v1/tags/{id}/merge
Merge this tag into another and delete it.
Key or token with tags:write Returns 200
Parameters
| Name | Type | Description |
|---|---|---|
idrequired | uuid | In the path. |
Body
| Name | Type | Description |
|---|---|---|
intoTagIdrequired | uuid |
Example
curl -X POST 'https://api.bkmark.it/v1/tags/0c9d3a52-6f1e-4b8a-9d2f-5e7a1b3c4d6e/merge' \
-H "Authorization: Bearer $BKMARK_TOKEN" \
-H 'Content-Type: application/json' \
-d '{"intoTagId":"0c9d3a52-6f1e-4b8a-9d2f-5e7a1b3c4d6e"}' Response fields (4)
| Name | Type | Description |
|---|---|---|
idrequired | uuid | |
namerequired | string | |
bookmarkCountrequired | integer | -9007199254740991–9007199254740991. |
createdAtrequired | string |