Skip to main content

LiveBy API QuickStart Guide

At a Glance​

This guide offers a concise yet comprehensive overview of integrating the LiveBy API into your projects. We'll walk you through the essentials - from initial setup and authentication to executing basic operations. Our goal is to equip you with the knowledge and tools needed to quickly leverage the LiveBy API, enhancing your applications with its powerful features. Get ready to unlock new possibilities in a few simple steps!

Acquire an API Key​

The simplest way to access the LiveBy API directly is with an API key. Currently, a member of our team will need to create an API key for you. Please email Support@LiveBy.com to request API access.

warning

Make sure to save this somewhere safe, and do not share it with anyone.

Make Your First API Call​

To test that you have everything set up correctly, we have created a test endpoint that will let you ping the LiveBy API servers.

token="YOUR_API_TOKEN"

curl -sS \
  "https://api.liveby.com/health/auth" \
  -H "Authorization: Bearer ${token}" | jq -r

If everything was set up correctly, a successful response should look like the following:

{
  "status": "ok",
  "info": {
    "postgres": {
      "status": "up"
    },
    "liveby.com": {
      "status": "up"
    }
  },
  "error": {},
  "details": {
    "postgres": {
      "status": "up"
    },
    "liveby.com": {
      "status": "up"
    }
  }
}