Skip to content
LydieDevelopers
Menu

Create a public link

View as Markdown
POST/v1/documents/{documentId}/share-links

Creates a view-only public link to the page (and, by default, its unrestricted subpages). The token is returned only once. Needs full access.

docs:write
Request
curl -X POST "https://api.lydie.co/v1/documents/01JCQ3V5MZ8G4ZK2X7T9R6N1PB/share-links" \
  -H "Authorization: Bearer $LYDIE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

Path parameters

Body

Response

200
{
  "shareLink": {
    "id": "string",
    "documentId": "01JCQ3V5MZ8G4ZK2X7T9R6N1PB",
    "tokenHint": "string",
    "includeSubpages": false,
    "expiresAt": null,
    "hasPassword": false,
    "createdBy": null,
    "createdAt": "2026-11-12T09:30:00.000Z"
  },
  "token": "string",
  "url": "string"
}

Errors use one envelope for every endpoint. See Errors and versions.