Cover letter
Create cover letter
POST /cover-letter/create - queue a cover letter generation job
Example
curl -X POST https://api.rezzy.dev/v1/cover-letter/create \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"title": "Software Engineer at Acme Corp",
"job_description": "Full-time role. Requirements: 3+ years Python, REST APIs.",
"company_url": "https://acme.com",
"hiring_manager_name": "Jane Smith",
"company_street_address": "123 Main St",
"company_city": "San Francisco",
"company_state": "CA",
"company_zip": "94105",
"hiring_manager_email": "jane@acme.com",
"date": "2026-04-09",
"additional_context": "Referred by John Doe"
}'Sample response (202 Accepted):
{
"success": true,
"message": "Cover letter creation job has been successfully registered.",
"data": {
"id": "3de8fcc3-a913-413d-acdb-382701542cb9",
"title": "Software Engineer at Acme Corp",
"status": "QUEUED",
"dashboard_url": "https://rezzy.dev/dashboard/cover-letters"
}
}Processing is asynchronous. Use the returned id with Get cover letter
status to poll for completion.
Request body
| Field | Type | Required | Constraints | Example |
|---|---|---|---|---|
title | string | Yes | 1–255 characters | "Software Engineer – Acme Corp" |
job_description | string | Yes | Min length 1 | "Full-time role in San Francisco. Requirements: 3+ years Python..." |
company_url | string | No | Max length 500 | "https://acme.com" |
hiring_manager_name | string | No | - | "Jane Smith" |
company_street_address | string | No | - | "123 Main St" |
company_city | string | No | - | "San Francisco" |
company_state | string | No | - | "CA" |
company_zip | string | No | - | "94105" |
hiring_manager_email | string | No | - | "jane@acme.com" |
date | string | No | - | "2026-04-09" |
additional_context | string | No | - | "Referred by John Doe" |
Including company_url helps tailor the letter to the employer. When
provided, Rezzy can research the company and role context similarly to the
dashboard flow.
Success response (202 Accepted)
data:
| Field | Type | Description |
|---|---|---|
id | UUID | Cover letter resource ID |
title | string | Same as request title |
status | string | One of: QUEUED, IN_PROGRESS, SUCCESS, FAILED |
dashboard_url | string | URL to view 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 cover letter with this title already exists |
| 500 | Internal server error |
To check when the job is done and get the PDF URL, use Get cover letter status.