API Documentation

ResumeAI API

Integrate ResumeAI's powerful features into your own applications.

Quick Links

Getting Started

The ResumeAI API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes.

Base URL

https://api.resumeai.com/v1

All API requests must be made over HTTPS. Calls made over plain HTTP will fail.

Authentication

The ResumeAI API uses API keys to authenticate requests. You can view and manage your API keys in the Dashboard.

Example Request

curl https://api.resumeai.com/v1/jobs \
  -H "Authorization: Bearer YOUR_API_KEY"

Important: Keep your API keys secure. Do not share them in publicly accessible areas.

Jobs

Create and manage job postings.

GET /jobs

Returns a list of your jobs.

{
  "data": [
    {
      "id": "job_abc123",
      "title": "Senior Developer",
      "status": "active",
      "created_at": "2024-12-15T10:00:00Z"
    }
  ],
  "has_more": false
}
POST /jobs

Creates a new job posting.

GET /jobs/:id

Retrieves a specific job by ID.

Candidates

Manage candidates and their applications.

GET /candidates List all candidates
POST /candidates Create a candidate
GET /candidates/:id Get a candidate
PATCH /candidates/:id Update a candidate

Resumes

Upload and parse resume files.

POST /resumes/parse

Uploads and parses a resume file. Supports PDF, DOCX, DOC, and TXT formats.

curl -X POST https://api.resumeai.com/v1/resumes/parse \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "file=@resume.pdf" \
  -F "candidate_id=cand_abc123"

Matching

Match candidates to jobs and get match scores.

POST /matching/score

Calculate match score between a candidate and a job.

{
  "candidate_id": "cand_abc123",
  "job_id": "job_xyz789"
}

Analytics

Access hiring metrics and analytics data.

GET /analytics/overview Dashboard overview
GET /analytics/funnel Hiring funnel data
GET /analytics/skills Skill trends

Webhooks

Receive real-time notifications about events in your account.

Available Events

candidate.created

A new candidate was created

resume.parsed

A resume was successfully parsed

match.completed

Match scoring completed

application.status_changed

Application status was updated

Rate Limits

The API is rate limited to ensure fair usage and stability.

Plan Rate Limit
Starter 100 requests/minute
Professional 500 requests/minute
Enterprise Custom

Need Help?

Our developer support team is here to help you integrate ResumeAI.

Contact Developer Support