GET/api/v1/og/w/{workspace_id}/f/{folder_id}.png

Get a folder's preview image

The 1200×630 image link previews show for a folder's address, as PNG. It names the folder only when a signed-out visitor could already see it: the folder is shared with anyone with the link, or it holds items anyone can open on a workspace with a live domain. Otherwise the card is blank.

No token needed120 per minute per IP

Guide: Link previews

Code samples and Try it

Path parameters

#
  • workspace_idstringRequired

    The workspace's id, from the address of its settings page (markdrop.in/settings/workspaces/<workspace-id>) or from List workspaces.

  • folder_idstringRequired

    The folder's id, from List folders.

Responses

#
  • 200OK.
  • 422The request didn't validate. detail lists each problem, with where it is (loc) and why (msg).
  • 429Too many requests from your IP address. Wait the seconds in Retry-After.
Did this page help?