Get link metadata | Memos unofficial

1 parameter

urlstringoptional

The link URL to retrieve metadata for.

2 status codes

200Returns the original link URL and its available title, description, and image URL.

urlstringoptional

The original link URL.

titlestringoptional

The link title.

descriptionstringoptional

The link description.

imagestringoptional

The link image URL.

defaultReturned when the request fails; includes an error code, a developer-facing message, and optional error details.

codeintegeroptional

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestringoptional

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsarray<object>optional

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Error handling

Supply url as the link URL whose metadata you want to retrieve.

import { Client } from "memos-unofficial-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
});

const result = await client.linkMetadata.list({ url: "https://api.example.com/v1" });

{
  "url": "https://example.com",
  "title": "Example Title",
  "description": "Example description",
  "image": "https://example.com/image.jpg"
}

Request

Response

Errors