Skip to content
Docs

Quickstart

Prerequisites

  • An account on the platform (Starter plan is free)
  • Your API base URL from the dashboard

1. Get your API key

Go to Dashboard → Developer Apps → [Your App] → API Keys and create a new key.

2. Make your first request

Terminal window
curl -H "Authorization: Bearer $API_KEY" \
     $API_BASE_URL/v1/ping

Expected response:

{ "status": "ok", "ts": 1719187200000 }

3. Install the TypeScript client (optional)

Terminal window
npm install @your-org/api-client
import { createClient } from "@your-org/api-client";


const client = createClient({ baseUrl: process.env.API_BASE_URL, apiKey: process.env.API_KEY });
const result = await client.get("/v1/ping");

Next: Authentication →