Skip to main content

​
Welcome to the Exterview API

The Exterview API empowers developers and partner platforms to seamlessly integrate advanced hiring, assessment, and AI interview capabilities into their own systems. Built for scalability and automation, the API provides secure access to Exterview’s intelligent recruitment ecosystem from job creation and candidate management to AI-driven interviews and analytics.

​
What You Can Build

Job Management

Create and manage job postings with automated parsing from PDF,DOCX,TXT files

Candidate Operations

Bulk upload resumes with AI-powered parsing, scoring, and skills extraction

Interview Scheduling

Schedule and manage interviews with automated assignment and notifications

Analytics & Reports

Access leaderboards, interview reports, and detailed candidate assessments

​
Key Features

Automatically extract candidate information, skills, experience, and education from resumes in multiple formats (PDF, DOC, DOCX). Our AI engine scores candidates against job requirements and provides detailed skill matching.
Leverage both AI-generated and manual scoring systems to rank candidates. Customize scoring criteria based on experience, skills, education, and more to find the perfect fit for each role.
Use our flexible GraphQL endpoint for complex queries and mutations, or REST endpoints for file uploads. Get exactly the data you need with efficient, well-documented APIs.
Access comprehensive interview reports including AI feedback, question-answer transcripts, video playback links, and detailed performance analytics.
Built to handle high-volume recruitment operations with rate limiting, pagination, and bulk operations support. Production and sandbox environments available.

​
Quick Start

Get started with the Exterview API in minutes:
1

Get Your Credentials

Obtain your API key and Bearer token from the Exterview dashboard. See Authentication for details.
2

Make Your First Request

Test your authentication with a simple GraphQL query:
curl -X POST https://api.exterview.ai/graphql \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"query": "query { __typename }"}'
3

Create Your First Job

Upload a job posting and start receiving candidates. Check out Create Job.
4

Upload Candidates

Bulk upload candidate resumes for automated processing. See Bulk Upload.

​
API Architecture

The Exterview API is built on a modern, scalable architecture:

​
Base URLs

https://api.exterview.ai/graphql

​
Core Capabilities

​
1. Job Management

Create and manage job postings with ease:
  • Upload job definitions from PDF,DOCX or TXT files
  • AI-powered parsing with custom prompts
  • Draft and published job states
  • Search and filter capabilities
Explore Job APIs →

​
2. Candidate Management

Streamline your candidate pipeline:
  • Bulk resume uploads (PDF, DOC, DOCX)
  • Automated information extraction
  • Customizable scoring criteria
  • Duplicate detection
  • Skills matching against job requirements
Explore Candidate APIs →

​
3. Interview Scheduling

Manage interviews efficiently:
  • Assign interviewers to candidates
  • Schedule with conflict detection
  • Automated reminders
  • Status tracking
Explore Interview APIs →

​
4. Reports & Analytics

Make data-driven hiring decisions:
  • AI and manual candidate leaderboards
  • Detailed interview reports with AI feedback
  • Video playback access
  • Question-answer transcripts
  • Performance metrics
Explore Report APIs →

​
Rate Limits

To ensure fair usage and system stability:
  • Default Limit: 600 requests per minute per organization
  • Pagination: Use pageNum and perPage for large datasets
  • Bulk Operations: Recommended for high-volume operations
Rate limit headers are included in every response to help you track your usage.

​
SDK & Libraries

While we don’t provide official SDKs yet, our API is compatible with standard HTTP clients: 
// Using fetch API
const response = await fetch('https://api.exterview.ai/graphql', {
  method: 'POST',
  headers: {
    'x-api-key': process.env.EXTERVIEW_API_KEY,
    'Authorization': `Bearer ${process.env.EXTERVIEW_TOKEN}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({ query: '...' })
});

​
Best Practices

Use Environment Variables

Never hardcode credentials. Use environment variables for API keys and tokens.

Implement Error Handling

Always handle errors gracefully with proper retry logic and exponential backoff.

Paginate Large Results

Use pagination for queries that return many results to optimize performance.

Monitor Rate Limits

Check rate limit headers and implement appropriate throttling in your application.

​
Use Cases

​
Applicant Tracking Systems (ATS)

Integrate Exterview’s AI capabilities into your existing ATS to enhance candidate screening and evaluation.

​
Recruitment Platforms

Build comprehensive recruitment solutions with automated interview scheduling and AI-driven assessments.

​
HR Management Systems

Add intelligent hiring workflows to your HRMS with seamless candidate management and analytics.

​
Job Boards

Enhance job board functionality with AI-powered candidate matching and automated screening.

​
Support & Resources

API Reference

Detailed documentation for all API endpoints

Authentication Guide

Learn how to authenticate your API requests

Contact Support

Email us at support@exterview.ai

System Status

Check status.exterview.ai for uptime

​
What’s Next?

Ready to start building? Here are your next steps:
  1. Set up Authentication - Get your API credentials
  2. Create Your First Job - Start posting positions
  3. Upload Candidates - Begin candidate processing
  4. Explore Reports - Access analytics and insights
Ready to transform your recruitment process? Let’s get started with the Exterview API!