---
title: "Describe Link"
method: POST
path: "/v1/describeLink"
tags: ["Unfurling"]
---

# Describe Link

`POST /v1/describeLink`

Retrieve metadata about a Lucid document from its URL, including the document title, product, and type. Use this to generate rich link previews (unfurling) in external applications.

## Request body

- object
  - `url` string, required — The URL of the Lucid document link to parse information from.

## Response `200`

Successfully retrieved information about the document link.

- LinkResource — Resource representing information contained in a Lucid link.
  - `document` LinkDocument — Information about the Document contained in the link if it exists.
    - `documentId` string, uuid — Unique identifier of the document.
    - `page` string, nullable — Page information of the document, if applicable.
    - `product` string — The Lucid product the document belongs to.
  - `invitation` LinkInvitation — Information about the Invitation contained in the link if it exists.
    - `invitationId` string, uuid — Unique identifier of the invitation.

## Other responses

- `403` — The URL is not a valid Lucid link.

---

[API](https://skmtc.net/lucid/apis/lucid-rest-api.md) · [All operations](https://skmtc.net/lucid/apis/lucid-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lucid/lucid-rest-api/revisions/6a32cb9e1aa7/schema)