Link Create
Save a URL as a community bookmark and retrieve available page metadata. Requires Use Links permission. Only public HTTP(S) URLs with fully qualified DNS hostnames, no credentials, and no explicit ports are accepted, including redirect destinations. New bookmarks use the final URL reached after redirects. If that URL is already bookmarked, the existing link is returned. Paths, queries, and fragments distinguish bookmarks. Unavailable pages can still be bookmarked. Metadata may be refreshed asynchronously; failed refreshes preserve previously saved metadata. Submitted titles and descriptions are ignored.
Save a URL as a community bookmark and retrieve available page metadata. Requires Use Links permission. Only public HTTP(S) URLs with fully qualified DNS hostnames, no credentials, and no explicit ports are accepted, including redirect destinations.
New bookmarks use the final URL reached after redirects. If that URL is already bookmarked, the existing link is returned. Paths, queries, and fragments distinguish bookmarks.
Unavailable pages can still be bookmarked. Metadata may be refreshed asynchronously; failed refreshes preserve previously saved metadata. Submitted titles and descriptions are ignored.
storyden-session<token>application/json- body
url*URLA web address
urltitle?LinkTitledescription?LinkDescriptionLink indexed
application/json- response
A minimal object used to refer to a link without sending too much data.
id*IdentifierA unique identifier for this resource.
xidcreatedAt*stringThe time the resource was created.
date-timeupdatedAt*stringThe time the resource was updated.
date-timedeletedAt?stringThe time the resource was soft-deleted.
date-timemisc?Arbitrary extra data stored with the resource.
url*URLA web address
urlslug*LinkSlugdomain*LinkDomaintitle?LinkTitledescription?LinkDescriptionfavicon_image?primary_image?liveness_status?LinkLivenessStatusWhether the link is reachable, unreachable, or has no conclusive result. Liveness checks preserve saved page metadata.
"unknown""alive""offline"liveness_checked_at?stringWhen the link was last checked for reachability.
date-timescrape_status?LinkScrapeStatusWhether page metadata is awaiting retrieval, was retrieved successfully, or could not be retrieved. Failed refreshes preserve previously saved metadata.
"pending""success""failed"scrape_attempted_at?stringWhen the latest scrape attempt was recorded.
date-timescraped_at?stringWhen metadata was last successfully scraped.
date-timecurl -X POST 'https://example.com/api/links' \ -H 'Content-Type: application/json' \ -d '{ "url": "string"}'{ "id": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "deletedAt": "2019-08-24T14:15:22Z", "misc": {}, "url": "string", "slug": "string", "domain": "string", "title": "string", "description": "string", "favicon_image": { "id": "string", "filename": "string", "path": "string", "mime_type": "string", "width": 0, "height": 0, "parent": {} }, "primary_image": { "id": "string", "filename": "string", "path": "string", "mime_type": "string", "width": 0, "height": 0, "parent": {} }, "liveness_status": "unknown", "liveness_checked_at": "2019-08-24T14:15:22Z", "scrape_status": "pending", "scrape_attempted_at": "2019-08-24T14:15:22Z", "scraped_at": "2019-08-24T14:15:22Z"}Node Version Update Status PATCH
Update the lifecycle status of a checkpoint. This endpoint is separate from the content patch endpoint because status changes have side effects. For the initial checkpoint workflow, the only supported transition is draft to applied. Applying a version is restricted to members with `MANAGE_LIBRARY`. Applying a draft copies the full draft snapshot into the target node, applies properties as a complete desired-state list, marks the version immutable, and updates the node's `current_version_id` pointer to the applied version. This is a linear operation; applying a draft does not merge against other draft or historical versions. Clients must use this endpoint for lifecycle transitions and must not combine status changes with regular draft content updates.
Link Delete DELETE
Delete a community bookmark. Associated posts, replies, library pages, and uploaded assets are preserved. Requires Manage Links permission.