Higher Platform API Reference

Higher is an AI-powered job search assistant that helps users track opportunities, analyze job descriptions, generate tailored application materials, and manage their job search pipeline effectively.

This API allows external bots and agents to interact with the Higher platform to programmatically add job opportunities, check status, and retrieve dashboard statistics.

Authentication

All API requests must include the API Key header to authenticate.

• Header: x-bot-api-key
• Value: Your secret key (configured in App Secrets as BOT_API_KEY)

---

Endpoints

1. Create Opportunity

Add a new job opportunity to the pipeline.

POST /functions/botCreateOpportunity

Payload:

{
  "user_email": "user@example.com",     // Required: The user to assign the job to
  "company": "Acme Corp",               // Required
  "position": "Software Engineer",      // Required
  "job_url": "https://...",             // Optional but recommended
  "location": "Remote",                 // Optional
  "salary_range": "$120k - $150k",      // Optional
  "description": "Job description..."   // Optional
}

Response:

{
  "success": true,
  "message": "Opportunity created successfully",
  "data": { "id": "123", ... }
}

---

2. Get Job Status

Check the status of a specific job by ID or URL.

POST /functions/botGetJob

Payload (provide either id or job_url):

{
  "user_email": "user@example.com",     // Required
  "id": "123",                          // Optional: Base44 Opportunity ID
  "job_url": "https://..."              // Optional: Original Job URL
}

Response:

{
  "found": true,
  "id": "123",
  "company": "Acme Corp",
  "status": "interviewing",
  "fit_score": 85,
  "priority": 4
}

---

3. Get Dashboard Stats

Retrieve aggregate statistics for a user's pipeline.

POST /functions/botGetStats

Payload:

{
  "user_email": "user@example.com"      // Required
}

Response:

{
  "success": true,
  "stats": {
    "total_opportunities": 15,
    "new": 5,
    "applied": 3,
    "interviewing": 2,
    "offers": 1,
    "high_priority": 4
  }
}