API Documentation

Integrate ResumeGyani's powerful AI recruitment tools into your existing systems with our comprehensive REST API.

Quick Start

Get started with the ResumeGyani API in minutes

Base URL

https://api.resumegyani.com/v1

Authentication

All API requests require authentication using Bearer tokens:

Authorization: Bearer YOUR_API_TOKEN

Example Request

curl -X GET "https://api.resumegyani.com/v1/profiles" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

Profile Management

Search, retrieve, and manage candidate profiles

GET /profiles
Search profiles
GET /profiles/{id}
Get profile details
POST /profiles
Create profile
PUT /profiles/{id}
Update profile

AI Analysis

AI-powered resume analysis and matching

POST /analyze/resume
Analyze resume
POST /match/job
Job matching
POST /analyze/skills
Skill gap analysis
POST /predict/success
Success prediction

Client Management

Manage clients and job requirements

GET /clients
List clients
POST /clients
Create client
GET /clients/{id}/jobs
Client jobs
POST /jobs
Create job

Analytics

Access analytics and reporting data

GET /analytics/overview
Dashboard stats
GET /analytics/matching
Match analytics
GET /analytics/clients
Client metrics
GET /reports/export
Export data

Authentication

Secure API access with Bearer tokens

Getting Your API Token

API tokens can be generated from your dashboard under Settings → API Access.

Token Scopes

read:profiles
Read profile data
write:profiles
Create/update profiles
analyze:ai
Use AI analysis features

Rate Limits & Security

API usage limits and security guidelines

Rate Limits

• Standard Plan: 1,000 requests/hour

• Professional Plan: 5,000 requests/hour

• Enterprise Plan: 10,000 requests/hour

Security Best Practices

• Use HTTPS for all requests

• Keep API tokens secure

• Rotate tokens regularly

• Monitor API usage

Support & Resources

Get help with API integration and troubleshooting

Code Examples

Find implementation examples in multiple programming languages.

API Status

Check real-time API status and service availability.

Developer Support

Get technical support from our developer team.

Need help with integration? Our developer support team is here to assist you.