Skip to main content
Prerequisites:
  • API key from your JobHive dashboard
  • Node.js version 18+ (for JavaScript/TypeScript)
  • Python 3.10+ (for Python integrations)
  • Docker and Docker Compose (for local development)
  • PostgreSQL 14+ (for database development)
Get up and running with JobHive’s AI-powered interview platform in minutes. This guide covers both platform integration and local development setup. JobHive Development Workflow - Diagram showing platform integration paths, local development setup, and API integration flow
1

Get Your API Key

  1. Log into your JobHive dashboard
  2. Navigate to SettingsAPI Keys
  3. Generate a new API key for your application
  4. Copy and securely store your API key
2

Choose Your Development Path

Use JobHive’s hosted API for production applications and integrations.
Direct API Integration:
3

Create Your First Interview

Local Development Environment

Backend Setup

1

Database Setup

2

Redis Setup

3

Environment Configuration

Create a .env.local file:
4

Start Development Server

Frontend Development

Frontend Interview Component - React component structure showing video feed, WebSocket connection, and real-time interview state management

Webhook Setup

Configure webhooks to receive real-time updates about interview events.

Environment Configuration

Testing Your Integration

Test Mode

Use our test mode to validate your integration without consuming credits or creating real interviews.

Mock Interview Results

Test interviews return mock results for development purposes:

Rate Limits & Quotas

JobHive enforces the following rate limits based on your subscription:

Rate Limit Headers

All API responses include rate limit information:

Handling Rate Limits

Troubleshooting

Common Causes:
  • Incorrect or missing API key in Authorization header
  • API key for wrong environment (dev vs prod)
  • Expired or revoked API key
Solutions:
Symptoms:
  • HTTP 429 responses from API
  • “Rate limit exceeded” error messages
  • Delayed interview creation
Solutions:
  • Implement exponential backoff with jitter
  • Monitor rate limit headers in responses
  • Consider upgrading your subscription plan
  • Cache API responses to reduce redundant calls
  • Use webhooks instead of polling for status updates
Troubleshooting Steps:
  1. Verify webhook URL is publicly accessible (use tools like ngrok for local testing)
  2. Check webhook secret is correctly configured
  3. Ensure endpoint returns HTTP 200 status
  4. Verify request signature validation
  5. Check firewall and security group settings
Test Webhook:
Common Problems:
  • Connection drops during interviews
  • Unable to establish WebSocket connection
  • Authentication failures on WebSocket
Solutions:
Validation Errors:
  • Missing required fields (job title, candidate email)
  • Invalid skill names or difficulty levels
  • Malformed email addresses
Example Valid Request:
Database Connection Problems:
Redis Connection Issues:
Django Migration Errors:

Support & Resources

Developer Support

Get technical help from our engineering team

API Status

Check real-time API status and incidents

Bug Reports

Report bugs and request features via email

Email Support

Contact our development team for technical support

Getting Help

When reaching out for support, please include:
  • API Version: Which API version you’re using
  • Request/Response: Full HTTP request and response (remove sensitive data)
  • Error Details: Complete error messages and stack traces
  • Environment: Development, staging, or production
  • Timestamp: When the issue occurred (with timezone)
Response Times:
  • Free Plan: 2-3 business days
  • Paid Plans: 24 hours for technical issues
  • Enterprise: Dedicated Slack channel with 4-hour response SLA