Storyden
Links

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.

POST
/links

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.

Authorization

cookiestoryden-session<token>

Request Body

application/json
  1. body
url*URL

A web address

Formaturl
title?LinkTitle
description?LinkDescription

Response Body

Link indexed

application/json
  1. response

A minimal object used to refer to a link without sending too much data.

id*Identifier

A unique identifier for this resource.

Formatxid
createdAt*string

The time the resource was created.

Formatdate-time
updatedAt*string

The time the resource was updated.

Formatdate-time
deletedAt?string

The time the resource was soft-deleted.

Formatdate-time
misc?

Arbitrary extra data stored with the resource.

url*URL

A web address

Formaturl
slug*LinkSlug
domain*LinkDomain
title?LinkTitle
description?LinkDescription
favicon_image?
primary_image?
liveness_status?LinkLivenessStatus

Whether the link is reachable, unreachable, or has no conclusive result. Liveness checks preserve saved page metadata.

Value in"unknown""alive""offline"
liveness_checked_at?string

When the link was last checked for reachability.

Formatdate-time
scrape_status?LinkScrapeStatus

Whether page metadata is awaiting retrieval, was retrieved successfully, or could not be retrieved. Failed refreshes preserve previously saved metadata.

Value in"pending""success""failed"
scrape_attempted_at?string

When the latest scrape attempt was recorded.

Formatdate-time
scraped_at?string

When metadata was last successfully scraped.

Formatdate-time
Example Request
curl -X POST 'https://example.com/api/links' \  -H 'Content-Type: application/json' \  -d '{  "url": "string"}'
Example Response
{  "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"}