Rezzy API Docs
Cover letter

Get cover letter status

GET /cover-letter/{cover_letter_id} - status and PDF URL for a cover letter

Example

curl -X GET "https://api.rezzy.dev/v1/cover-letter/3de8fcc3-a913-413d-acdb-382701542cb9" \
  -H "Authorization: Bearer YOUR_API_KEY"

Sample response (while processing):

{
  "success": true,
  "message": "Cover letter status retrieved successfully",
  "data": {
    "id": "3de8fcc3-a913-413d-acdb-382701542cb9",
    "title": "Software Engineer at Acme Corp",
    "status": "IN_PROGRESS",
    "stage": "Drafting your cover letter...",
    "pdf_url": null,
    "dashboard_url": "https://rezzy.dev/dashboard/cover-letters"
  }
}

Sample response (completed):

{
  "success": true,
  "message": "Cover letter status retrieved successfully",
  "data": {
    "id": "3de8fcc3-a913-413d-acdb-382701542cb9",
    "title": "Software Engineer at Acme Corp",
    "status": "SUCCESS",
    "stage": "completed",
    "pdf_url": "https://storage.example.com/cover-letters/3de8fcc3.pdf",
    "dashboard_url": "https://rezzy.dev/dashboard/cover-letters"
  }
}

Path parameters

ParameterTypeRequiredDescriptionExample
cover_letter_idUUIDYesCover letter ID from create response660e8400-e29b-41d4-a716-446655440001

Success response (200 OK)

data:

FieldTypeDescription
idUUIDCover letter resource ID
titlestringCover letter title
statusstringQUEUED | IN_PROGRESS | SUCCESS | FAILED
stagestringOptional; processing stage
pdf_urlstringOptional; present when status is SUCCESS
dashboard_urlstringURL to view in the dashboard

Error responses

StatusCondition
404Cover letter not found
500Internal server error

On this page