Unfurling

Describe Link

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.

post/v1/describeLink

Request

  • Base URL: https://api.lucid.co
  • URL: https://api.lucid.co/v1/describeLink
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://lucid.app/oauth2/authorize, token URL https://api.lucid.co/oauth2/token)

Request body

urlstring required

The URL of the Lucid document link to parse information from.

Response

Successfully retrieved information about the document link.

Example response

{
  "document": {
    "documentId": "110808fd-4553-4316-bccf-4f25ff59a532",
    "product": "lucidspark"
  },
  "invitation": {
    "invitationId": "inv_288b9365-685b-4bf2-9f6f-8aa9e2082542"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.