API Reference
Community

Direct Embed

get
https://api.lucid.co/v1/embeds/link

Display an embed within an iframe. If the clientId is valid with the registered embed domain in the developer portal, the iframe will show either a login page or an embedded document viewer depending on the user's authorization status via browser cookies.

Display an embed within an <iframe>.

  • If the clientId is valid with the registered embed domain in the developer portal, the <iframe> displays a login page or an embedded document viewer based on the user's authorization cookie.
<iframe
  src='https://lucid.app/embeds/link?document=:document&clientId=:clientId'
></iframe>

Valid Authentication Methods

  • This endpoint does not require API Key or OAuth 2.0 authentication and utilizes browser cookies instead.
Query Params
string
required

The URL of the Lucid document link or the documentId retrieved from the Describe Link endpoint.

string
required

The client ID obtained during App registration.

Responses
200

OK - The iframe content displaying the embedded document picker or viewer.

400

Bad Request

Updated 23 days ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here!

Updated 23 days ago

Privacy
Legal
Cookie privacy choices
Cookie policy