API Documentation

Integrate HireCharacter's powerful matching and assessment capabilities into your applications.

Getting Started

The HireCharacter API allows developers to access our platform's core features programmatically. To get started, you'll need an API key which can be obtained from your developer dashboard.

Base URL: https://api.hirecharacter.ai/v1

Authentication

All API requests require authentication using an API key. Include your API key in the request header:

Authorization: Bearer YOUR_API_KEY

Rate Limits

API requests are limited to prevent abuse:

  • Free Tier: 100 requests per hour
  • Pro Tier: 1,000 requests per hour
  • Enterprise: Custom limits available

Endpoints

User Management
GET /users

Retrieve a list of users

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.hirecharacter.ai/v1/users
GET /users/{id}

Retrieve a specific user by ID

POST /users

Create a new user

Character Assessments
POST /assessments

Create a new character assessment

{
  "user_id": "12345",
  "assessment_type": "personality",
  "questions": [...],
  "metadata": {...}
}
GET /assessments/{id}

Retrieve assessment results

GET /assessments/{id}/report

Generate a detailed assessment report

Job Matching
POST /matches

Find candidate matches for a job posting

{
  "job_requirements": {...},
  "candidate_pool": [...],
  "matching_criteria": {...}
}
GET /matches/{id}

Retrieve match results and compatibility scores

Webhooks

Configure webhooks to receive real-time notifications about:

  • Assessment completions
  • New matches found
  • Application status changes
  • Profile updates

Webhook endpoints must respond with a 200 status code within 10 seconds.

Response Format

All API responses are returned in JSON format:

{
  "success": true,
  "data": {...},
  "message": "Request completed successfully",
  "meta": {
    "page": 1,
    "per_page": 20,
    "total": 150
  }
}

Error Handling

Errors are returned with appropriate HTTP status codes:

  • 400: Bad Request - Invalid parameters
  • 401: Unauthorized - Invalid API key
  • 403: Forbidden - Insufficient permissions
  • 404: Not Found - Resource doesn't exist
  • 429: Too Many Requests - Rate limit exceeded
  • 500: Internal Server Error

SDKs and Libraries

Official SDKs are available for popular programming languages:

API Resources
Developer Support

Need help with the API?

Contact Support Join Discord Stack Overflow
API Status
99.9% Uptime (30 days)
45ms Avg Response Time
All systems operational