Overview #

The LaunchBrightly Product Screenshots API is uniquely focused on capturing screenshots from password-gated Web Applications for use in your knowledge-base articles. This includes features like:

• Set up a login profile for your Demo Account (username/password)
• Render the page in any mode such as Light/Dark, Mobile/Desktop, US/DE/FR etc.
• Remove unwanted elements from the page before capturing a screenshot
• Execute automated input actions before the screenshot is captured to set up a specific state
• Capture a screenshot of a section of the page using Selectors (or custom data-lb attributes)
• Style the output image according to your brand guidelines
• Annotate images with text, shapes, arrows etc. so you can speak to specific parts
• Request screenshots in bulk and save them directly to your cloud

The API is designed and built in conjunction with the Help Center Sync API and we try by choice to make them complement each other. These two APIs are also the foundation for our screenshot automation platform for customer support teams.

The API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses the well-recognized header convention x-api-key for passing your API key. All properties on our endpoints are case-insensitive. We try hard to use standard HTTP response codes and verbs.

The bare minimum required to take a screenshot #

POST api.launchbrightly.com/screenshot

Request #

{
  "url": "https://convertkit.baremetrics.com/stats/arr",
  "elementSelector": [".main-graph"]
}

Supported Application types #

• Ungated Web Application
• Password-gated Web Applications
• Token-based authentication Web Applications (request access)
• Native Applications (on the roadmap)