/api/bsky-to-md

Description

The /api/bsky-to-md endpoint converts a Bluesky thread into a markdown document. It accepts various parameters to customize the output, including the URLs of the start and end posts, an optional title, and options for using markdown tables and adding a subtitle.

Method

• GET

Query Parameters

• start (string, optional): The URL of the first post in the Bluesky thread.
• end (string, optional): The URL of the last post in the Bluesky thread.
• title (string, optional): An optional title (header) for the markdown document.
• use-tables (boolean, optional, default: true): If set to true, multiple embedded images in a post are formatted as a markdown table. If set to false, images are displayed vertically.
• add-subtitle (boolean, optional, default: true): If set to true, adds a subtitle with post details at the top of the document.

Response

Success

• Status Code: 200 OK
• Content-Type: text/markdown; charset=utf-8
• Body: The generated markdown content of the Bluesky thread.

Error

• Status Code: 400 Bad Request
• Status Text: The error message indicating the cause of the failure.

Example Request

GET /api/bsky-to-md?start=https://bsky.app/profile/bsky.app/post/3kvu5vjfups25&end=https://bsky.app/profile/bsky.app/post/3kvu5zpgst32n&title=The+Great+Thread&use-tables=true&add-subtitle=true HTTP/1.1
    Host: yourdomain.com
    

Example Response

Success

HTTP/1.1 200 OK
    Content-Type: text/markdown; charset=utf-8

    # The Great Thread

    ###### [Posted](https://bsky.app/profile/did:plc:fuhe3c37a2ryxuf6zpkxfefb/post/3kvnyi7hzrk2g) by Shape [\@sxape.bsky.social](https://bsky.app/profile/did:plc:fuhe3c37a2ryxuf6zpkxfefb) on June 24 2024 to [Bluesky](https://bsky.app/)

    ...
    

Error

HTTP/1.1 400 Bad Request
    Content-Type: text/plain; charset=utf-8

    Error: Invalid URL provided.
    

Usage Notes

• The start and end parameters are optional but at least one should be provided to generate the markdown document.
• The use-tables parameter helps in formatting multiple images in a more visually appealing way but might not be supported by all markdown viewers.
• The add-subtitle parameter provides context about the post at the top of the document, which can be useful for readers.