Rezzy API Docs
Resume

Get resume status

GET /resume/{resume_id} - status and PDF URL for a resume

Example

curl -X GET "https://api.rezzy.dev/v1/resume/4c20b695-c3ed-4dc4-bcf3-f6f7aa00068b" \
  -H "Authorization: Bearer YOUR_API_KEY"

Sample response (while processing):

{
  "success": true,
  "message": "Resume status retrieved successfully",
  "data": {
    "id": "4c20b695-c3ed-4dc4-bcf3-f6f7aa00068b",
    "resume_title": "Senior Software Engineer",
    "status": "IN_PROGRESS",
    "stage": "Analyzing resume and job description...",
    "pdf_url": null,
    "dashboard_url": "https://rezzy.dev/dashboard/resumes"
  }
}

Sample response (completed):

{
  "success": true,
  "message": "Resume status retrieved successfully",
  "data": {
    "id": "4c20b695-c3ed-4dc4-bcf3-f6f7aa00068b",
    "resume_title": "Senior Software Engineer",
    "status": "SUCCESS",
    "stage": null,
    "pdf_url": "https://storage.example.com/resumes/4c20b695.pdf",
    "dashboard_url": "https://rezzy.dev/dashboard/resumes"
  }
}

Path parameters

ParameterTypeRequiredDescriptionExample
resume_idUUIDYesResume ID from create response550e8400-e29b-41d4-a716-446655440000

Success response (200 OK)

data:

FieldTypeDescription
idUUIDResume resource ID
resume_titlestringResume title
statusstringQUEUED | IN_PROGRESS | SUCCESS | FAILED
stagestring | nullProcessing stage while queued or in progress; otherwise null
pdf_urlstring | nullSigned PDF URL when successful and available; otherwise null
dashboard_urlstringURL to view in the dashboard

Poll no faster than every five seconds and back off. Stop polling on SUCCESS or FAILED. Both stage and pdf_url are always included and may be null.

PDF URLs expire after one hour. Read status again to get a fresh URL. Status reads do not consume generation credits. You can only retrieve documents belonging to the account that owns your API key.

Error responses

StatusCondition
400Malformed document UUID
401Missing or invalid API key
404Document not found or belongs to another account
429Request limit exceeded
500Internal server error

On this page