Skip to main content

​
Prerequisites

  • A Puffle account — sign up here
  • An API key — generate one from Settings → API in the dashboard

​
Step 1 — Get Your API Key

From the Puffle dashboard, navigate to Settings → API and click Generate API Key. Your key will be prefixed with pk_live_. Store it securely — it won’t be shown again.
Never commit your API key to source control. Use environment variables instead.

​
Step 2 — Make Your First Request

Fetch your signal feed to verify authentication is working: 
curl -s \
  -H "Authorization: Bearer pk_live_YOUR_KEY" \
  "https://app.getlima.ai/api/v1/signals?limit=5"
Expected response: 
{
  "signals": [
    {
      "id": "660e8400-e29b-41d4-a716-446655440001",
      "signal_type_id": "550e8400-e29b-41d4-a716-446655440000",
      "signal_type_label": "Hiring",
      "headline": "Acme Corp is hiring a VP of Engineering",
      "summary": "Acme Corp posted a VP of Engineering role on LinkedIn...",
      "score": 87,
      "source": "linkedin_jobs",
      "detected_at": "2026-04-20T10:30:00Z"
    }
  ],
  "pagination": {
    "cursor": null,
    "has_more": false,
    "count": 1
  }
}

​
Step 3 — List Your Signal Types

Signal types define what Puffle monitors. Fetch yours: 
curl -s \
  -H "Authorization: Bearer pk_live_YOUR_KEY" \
  "https://app.getlima.ai/api/v1/signals/types"

​
What’s Next?

Authentication

Understand API keys, scopes, and session auth.

Signal Feed

Paginate through signals and handle all event types.

Deep Research

Submit people and companies for AI research reports.

Webhooks

Receive signals in real time via webhook delivery.