Create a share link and embed code
create_share_linkUse when the user wants to send a saved design to someone, post it, or embed it on a site: returns the share page, the iframe embed snippet, the oEmbed endpoint and a poster image URL. Unlisted (default) works for anyone holding the link without making the project public; public makes the page indexable. Reuses the project's active link of the same visibility, so calling twice is safe. The project must have been opened and saved once. Owner only. Do not use to let someone edit; create_invite_link does that.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| title | No | Title on the share page; defaults to the project title | |
| visibility | No | unlisted | |
| allow_download | No | Let viewers download the file from the page |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | The share page | |
| kind | Yes | ||
| title | Yes | ||
| token | Yes | ||
| status | Yes | ||
| embedUrl | Yes | The iframe source | |
| modelUrl | Yes | The GLB, for shares of generated meshes | |
| videoUrl | Yes | Turntable MP4, when one has been rendered | |
| createdAt | Yes | ||
| embedHtml | Yes | Copy-paste iframe snippet with attribution | |
| expiresAt | Yes | ||
| oembedUrl | Yes | oEmbed endpoint for this share | |
| posterUrl | Yes | Rendered still of the design, when one exists | |
| projectId | Yes | ||
| viewCount | Yes | ||
| visibility | Yes | ||
| embedEnabled | Yes | ||
| allowDownload | Yes |