Resume
Create resume
POST /resume/create - queue a resume generation job
Example
curl -X POST https://api.rezzy.dev/v1/resume/create \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"title": "Senior Software Engineer",
"job_description": "We are looking for a senior engineer with 5+ years of experience in Python and distributed systems.",
"company_url": "https://acme.com"
}'Sample response (202 Accepted):
{
"success": true,
"message": "Resume creation job has been successfully registered.",
"data": {
"id": "4c20b695-c3ed-4dc4-bcf3-f6f7aa00068b",
"resume_title": "Senior Software Engineer",
"status": "QUEUED",
"dashboard_url": "https://rezzy.dev/dashboard/resumes"
}
}Processing is asynchronous. Use the returned id with Get resume status to poll for completion.
Request body
| Field | Type | Required | Constraints | Example |
|---|---|---|---|---|
title | string | Yes | 1–255 characters | "Senior Software Engineer" |
job_description | string | Yes | Min length 1 | "We are looking for a senior engineer with 5+ years..." |
company_url | string | No | Valid https URL | "https://acme.com" |
Passing company_url significantly improves resume quality. When provided, Rezzy scrapes the company's website and runs deep research to build a holistic picture of the company, covering:
- Hiring patterns and role expectations
- Culture and values
- Tech stack
- Company size and growth stage
- And more
This context lets Rezzy tailor your resume to what the company actually looks for, increasing your chances of standing out.
Success response (202 Accepted)
data:
| Field | Type | Description |
|---|---|---|
id | UUID | Resume resource ID |
resume_title | string | Same as request title |
status | string | One of: QUEUED, IN_PROGRESS, SUCCESS, FAILED |
dashboard_url | string | URL to view the resume in the dashboard |
Error responses
| Status | Condition |
|---|---|
| 400 | Business error (e.g. "Profile not found") |
| 422 | Request body failed validation |
| 403 | Insufficient credits |
| 409 | A resume with this title already exists |
| 500 | Internal server error |
To check when the job is done and get the PDF URL, use Get resume status.