API Documentation

Integrate SERENE into your applications

Getting Started with the API

The SERENE API allows you to integrate our resume parsing and matching capabilities into your own applications. All API requests require authentication using an API key.

Authentication

Include your API key in the Authorization header of all requests:

Authorization: Bearer YOUR_API_KEY

Base URL

https://api.serene-ai.com/v1

Endpoints

POST /resumes/upload

Upload and parse a resume

curl -X POST https://api.serene-ai.com/v1/resumes/upload \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "file=@resume.pdf"

GET /resumes/{id}

Retrieve parsed resume data

curl -X GET https://api.serene-ai.com/v1/resumes/123 \
  -H "Authorization: Bearer YOUR_API_KEY"

POST /matching/run

Match resumes against a job description

curl -X POST https://api.serene-ai.com/v1/matching/run \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"job_id": 456, "resume_ids": [123, 124, 125]}'

Rate Limits

API rate limits depend on your subscription plan:

Basic: 100 requests/hour
Professional: 500 requests/hour
Enterprise: Custom limits

Need Help?

Contact our support team for API assistance

Contact Support