Quickstart

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude

This quickstart guide will help you get started with Lipp Connect API, allowing you to make your first API call.

Step 1: Sign Up and Get Your API Key

1. Visit the Lipp Portal.
2. Log in and go to your enterprise settings.
3. Navigate to the bottom and create your API key.

Your API key is required to authenticate all API requests.

Step 2: Make Your First API Request

Let's start by making a simple request to the Lipp Connect API.

Get A Heartbeat

Use the following curl command to get a heartbeat message from the connect:

curl -X GET https://connect.lipp.cloud/api/heartbeat \
-H "Content-Type: application/json" \
-H "x-api-key: YOUR_API_KEY"

• YOUR_API_KEY: Replace with your generated API Key

Response Example

{
  "status": "ok",
  "service": "Lipp Connect Gateway",
  "timeUTC": "2025-11-06T14:42:45.4748856Z"
}

This response confirms that the api key generation was successfull.

Congratulations!

You’ve completed your first Lipp Connect API Call! Explore more advanced features in our documentation.

Start Your Next Mission