Getting Started #

Prerequisites for using our APIs #

The API key is all you need to call any of our APIs. Once you sign up and send a request using your account email, the API key will be sent to you upon approval.

Build your first API call #

All endpoints referenced in our API documentation have the following base URL:

https://api.launchbrightly.com

All requests to Launchbrightly API are served over HTTPS. Unencrypted HTTP is not supported.

Once you have your API key, specify it as part of the HTTP header with the name X-API-Key in every API request. The following sample cURL demonstrates how to use an API Key to import a Help Center.

curl --location 'https://api.launchbrightly.com/helpcenter/import' \
--header 'X-API-Key: <API_KEY>' \
--header 'Content-Type: application/json' \
--data '{
    "url": "https://api.launchbrightly.com"
}'