tags).", "example": "
Dear John Smith,
I am writing to express my interest in the Senior Frontend Engineer position at Acme Corp...
Sincerely,
Jane Doe
" } } } } } }, "responses": { "201": { "description": "Cover letter created", "content": { "application/json": { "example": { "coverLetterId": "abc-123", "title": "Cover letter for Acme Corp", "status": "created" } } } }, "400": { "description": "Missing fields", "content": { "application/json": { "examples": { "missing_content": { "value": { "error": "letterContent is required", "code": "bad_request" } }, "missing_name": { "value": { "error": "fullName is required", "code": "bad_request" } } } } } }, "401": { "description": "Invalid API key", "content": { "application/json": { "example": { "error": "Missing x-api-key header", "code": "unauthorized" } } } } } } }, "/v1/cover-letters/{coverLetterId}": { "get": { "tags": ["Cover Letters"], "summary": "Get cover letter", "description": "Returns cover letter metadata and the saved letter content for the owner. Use the render endpoint to get a PDF.", "parameters": [ { "name": "coverLetterId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Cover letter metadata", "content": { "application/json": { "example": { "id": "abc-123", "coverLetterId": "def-456", "title": "Cover letter for Senior Frontend Engineer", "letterContent": "Dear hiring team...", "data": { "letterContent": "Dear hiring team..." }, "createdAt": "2026-05-08T01:00:00Z", "updatedAt": "2026-05-08T01:00:00Z" } } } }, "401": { "description": "Invalid API key", "content": { "application/json": { "example": { "error": "Missing x-api-key header", "code": "unauthorized" } } } }, "404": { "description": "Cover letter not found", "content": { "application/json": { "example": { "error": "Cover letter not found", "code": "not_found" } } } } } } }, "/v1/cover-letters/{coverLetterId}/render": { "put": { "tags": ["Cover Letters"], "summary": "Render cover letter with template settings", "description": "Apply template settings to a saved cover letter and get a PDF back. Settings are saved for future renders.\n\nCosts 3 credits.", "parameters": [ { "name": "coverLetterId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": ["templateId"], "properties": { "templateId": { "type": "string", "example": "GRAPHITE" }, "locale": { "type": "string", "example": "en" }, "colorId": { "type": "string", "example": "graphite-blue" }, "font": { "type": "string", "example": "Inter" }, "spacing": { "type": "number", "example": 8 }, "margin": { "type": "number", "example": 8 }, "fontSize": { "type": "number", "example": 8 }, "pageNumbering": { "type": "string", "enum": ["none", "simple", "fraction", "page"], "example": "none" } } } } } }, "responses": { "200": { "description": "Rendered PDF", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Missing fields", "content": { "application/json": { "example": { "error": "templateId is required", "code": "bad_request" } } } }, "401": { "description": "Invalid API key", "content": { "application/json": { "example": { "error": "Invalid API key", "code": "invalid_key" } } } }, "404": { "description": "Cover letter not found", "content": { "application/json": { "example": { "error": "Cover letter not found", "code": "not_found" } } } }, "502": { "description": "Renderer failed", "content": { "application/json": { "example": { "error": "PDF renderer unavailable after 3 retries", "code": "renderer_error" } } } } } } }, "/v1/cover-letters/generate": { "post": { "tags": ["Cover Letters"], "summary": "Generate cover letter", "description": "Generates a professional cover letter based on your resume and a job description.\n\nCosts 1 credit.\n\n**Resume source:** same as /v1/tailor (resumeId, file upload, or default).", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoverLetterRequest" } }, "multipart/form-data": { "schema": { "type": "object", "required": ["positionName"], "properties": { "file": { "type": "string", "format": "binary", "description": "PDF or DOCX resume (max 10MB)" }, "resumeId": { "type": "string" }, "positionName": { "type": "string" }, "jobDescription": { "type": "string" }, "jobUrl": { "type": "string" }, "language": { "type": "string" } } } } } }, "responses": { "200": { "description": "Generated cover letter as PDF", "headers": { "X-Cover-Letter-Id": { "description": "ID of the saved generated cover letter.", "schema": { "type": "string" } }, "Content-Disposition": { "description": "Download filename for the generated artifact.", "schema": { "type": "string" } } }, "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Missing or invalid fields", "content": { "application/json": { "examples": { "missing_position": { "value": { "error": "positionName is required" } }, "missing_job": { "value": { "error": "Either jobDescription or jobUrl is required" } } } } } }, "401": { "description": "Invalid API key", "content": { "application/json": { "example": { "error": "Missing x-api-key header" } } } }, "402": { "description": "Usage limit exceeded", "content": { "application/json": { "example": { "error": "Monthly API limit reached. Purchase credits or upgrade your plan at console.laddro.com" } } } }, "404": { "description": "Resume not found", "content": { "application/json": { "example": { "error": "Resume not found" } } } }, "502": { "description": "AI service failed", "content": { "application/json": { "example": { "error": "AI service rate limit exceeded — try again in a moment" } } } } } } }, "/v1/export": { "post": { "tags": ["Export"], "summary": "Export resume as PDF", "description": "Generates a PDF from a resume using the specified template, colors, and font settings.\n\n**Response modes:**\n- Default: returns PDF binary (Content-Type: application/pdf)\n- SSE: returns progress events then metadata\n\nAll settings are optional. If omitted, the resume's saved template settings are used. Each export costs 3 credits.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportRequest" } } } }, "responses": { "200": { "description": "PDF binary or SSE stream", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Missing or invalid fields", "content": { "application/json": { "example": { "error": "resumeId is required" } } } }, "401": { "description": "Invalid API key", "content": { "application/json": { "example": { "error": "Invalid API key" } } } }, "402": { "description": "Usage limit exceeded", "content": { "application/json": { "example": { "error": "Monthly API limit reached. Purchase credits or upgrade your plan at console.laddro.com" } } } }, "404": { "description": "Resume not found", "content": { "application/json": { "example": { "error": "Resume not found" } } } }, "502": { "description": "PDF renderer unreachable", "content": { "application/json": { "example": { "error": "PDF renderer unreachable" } } } } } } } }, "tags": [ { "name": "Resumes", "description": "List, get, create from PDF, and render resumes with different template settings." }, { "name": "Tailor", "description": "Tailor a resume for a specific job posting. Rewrites content to match the job description." }, { "name": "Cover Letters", "description": "Generate a cover letter from your resume and a job description." }, { "name": "Export", "description": "Export a resume as PDF." }, { "name": "Templates", "description": "Browse resume templates, color schemes, and fonts. No authentication required." } ] }