Quick Links

Authentication Directory Run Assessment Reports Credits Subscription API Keys CI/CD Integration

API Documentation

LaunchLabs provides a RESTful API for running assessments, fetching reports, and managing your account. All endpoints return JSON.

🔑 Two Keys You Need

1. LaunchLabs API Key (ll_...)

Authorizes and bills your API calls. Get it from /account/api-keys

2. Target App Auth

Credentials or token to log into YOUR app so our advisors can test authenticated pages.

Authentication

Include your API key in the x-api-key header for all requests:

x-api-key: ll_your_api_key_here

Run Assessment

Run one or more advisors against a URL. Returns a report ID immediately, with results available via polling.

POST /api/scan

Run an assessment with specified advisors.

Request Body

Parameter	Type	Description
urlrequired	string	The URL to assess (must be accessible from our servers)
agentsrequired	array	List of advisor IDs to run (e.g., `["billing", "security"]`)
launchlabsApiKey	string	Override the API key from header (optional)
targetAuth	object	Credentials for testing authenticated pages (see below)

💡 Pro Tip

Run Auth + Billing + Journey together to validate "Can a real customer log in and pay?"

Example Request (Basic)

curl -X POST https://getlaunchlabs.com/api/scan \
  -H "Content-Type: application/json" \
  -H "x-api-key: ll_your_api_key" \
  -d '{
    "url": "https://your-app.com",
    "agents": ["performance", "seo", "security"]
  }'

Example Request (With Authentication)

curl -X POST https://getlaunchlabs.com/api/scan \
  -H "Content-Type: application/json" \
  -H "x-api-key: ll_your_api_key" \
  -d '{
    "url": "https://your-app.com",
    "agents": ["auth", "billing", "journey", "onboarding"],
    "targetAuth": {
      "credentials": {
        "email": "[email protected]",
        "password": "testpass123",
        "loginUrl": "/login"
      }
    }
  }'

Response

{
  "reportId": "rpt_abc123xyz",
  "status": "pending",
  "creditsUsed": 10,
  "estimatedTime": "2-3 minutes"
}

Reports

Fetch assessment results by report ID.

GET /api/reports/:id

Get the full assessment report.

Example Request

curl https://getlaunchlabs.com/api/reports/rpt_abc123xyz \
  -H "x-api-key: ll_your_api_key"

Response

{
  "reportId": "rpt_abc123xyz",
  "url": "https://your-app.com",
  "grade": "B+",
  "score": 87,
  "agents": ["billing", "security", "auth"],
  "issues": {
    "critical": 0,
    "high": 2,
    "medium": 5,
    "low": 8
  },
  "findings": [
    {
      "agent": "billing",
      "severity": "high",
      "title": "Stripe webhook not verified",
      "description": "Your Stripe webhook endpoint does not verify signatures...",
      "fix": "Use stripe.webhooks.constructEvent() to verify signatures"
    }
  ],
  "createdAt": "2026-02-12T18:00:00Z"
}

Credits

Check your current credit balance.

GET /api/credits

Get your current credit balance.

Example Request

curl https://getlaunchlabs.com/api/credits \
  -H "x-api-key: ll_your_api_key"

Response

{
  "credits": 47,
  "earned": 5,
  "purchased": 42
}

Subscription

Manage your subscription and billing history.

GET /api/subscription

Get your current subscription status and billing info.

Response

{
  "subscription": {
    "plan": "pro",
    "status": "active",
    "monthlyCredits": 62,
    "nextBillingDate": "2026-03-12"
  }
}

API Keys

Create, list, and revoke API keys for your account.

GET /api/keys

List all your API keys.

POST /api/keys

Create a new API key.

Request Body

Parameter	Type	Description
namerequired	string	A descriptive name for the key
tier	string	Key tier: `free`, `pro`, or `enterprise`

DELETE /api/keys/:prefix

Revoke an API key (prefix match).

CI/CD Integration

Add LaunchLabs to your deployment pipeline. Block on critical issues, store report links in build artifacts.

GitHub Actions Example

- name: LaunchLabs Pre-Flight Check
  run: |
    # Run fast agents on every deploy
    RESULT=$(curl -s -X POST https://getlaunchlabs.com/api/scan \
      -H "Content-Type: application/json" \
      -H "x-api-key: ${{ secrets.LAUNCHLABS_API_KEY }}" \
      -d '{"url":"${{ env.PREVIEW_URL }}","agents":["performance","seo","security"]}')
    
    GRADE=$(echo $RESULT | jq -r '.grade')
    REPORT_ID=$(echo $RESULT | jq -r '.reportId')
    
    echo "Grade: $GRADE"
    echo "Report: https://getlaunchlabs.com/report/$REPORT_ID"
    
    # Block on F grade
    if [[ "$GRADE" == "F" ]]; then
      echo "❌ LaunchLabs grade F - blocking deploy"
      exit 1
    fi
    
    echo "✅ LaunchLabs grade: $GRADE"

🎯 Recommended CI/CD Pattern

Run fast agents (performance, seo, security) on every PR/deploy
Run full assessment nightly or before major releases
Block deploys only on grade F or critical issues
Store reportId as a build artifact and link it in PR comments

Credit Costs

Agent	Credits	Use Case
Priya (Onboarding)	4	Signup, empty states, activation
Zoe (Journey)	4	User flows, funnel, CTAs
Omar (Account)	3	Settings, profile, preferences
Kara (Admin)	3	Admin panel, roles, permissions
Amy (Billing)	3	Pricing, checkout, subscriptions
Diego (Auth)	3	Login, signup, session security
Noah (Security)	3	OWASP, vulnerabilities, XSS, SQLi
Maya (Accessibility)	2	WCAG, aria labels, keyboard nav
Grace (Copy)	2	Messaging, headlines, CTAs
Arjun (API)	2	Endpoints, contracts, error handling
Ethan (Performance)	1	Core Web Vitals, load time
Lina (Mobile)	1	Responsive, touch targets
Sofia (SEO)	1	Meta tags, sitemap, indexing
Hana (Trust)	1	Testimonials, social proof
Marcus (Legal)	1	Privacy policy, terms, compliance