Describe Link

post https://api.lucid.co/describeLink

Parses and retrieves information from the provided Lucid document link.

This does not confirm that the document or resource exists.

Valid Authentication Methods

Api Key Grants:

Unrestricted

OAuth 2.0 User Token and Account Token Scopes:

Unrestricted

Responses

403

The URL is not a valid Lucid link.

Language

Credentials


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.lucid.co/describeLink \
3
     --header 'Lucid-Api-Version: 1' \
4
     --header 'accept: application/json' \
5
     --header 'content-type: application/json'


xxxxxxxxxx
10
 
1
{
2
  "document": {
3
    "documentId": "110808fd-4553-4316-bccf-4f25ff59a532",
4
    "page": "string",
5
    "product": "lucidspark"
6
  },
7
  "invitation": {
8
    "invitationId": "inv_288b9365-685b-4bf2-9f6f-8aa9e2082542"
9
  }
10
}

Valid Authentication Methods

Api Key Grants:

OAuth 2.0 User Token and Account Token Scopes:

200Successfully retrieved information about the document link.