Endpoint
Request parameters
The type of letter to generate. Choose from 25+ available letter types.Available types:
cover_letter- Professional cover letter for job applicationsrecommendation_letter- Letter of recommendationresignation_letter- Formal resignation letterthank_you_letter- Thank you or appreciation letterapology_letter- Formal or personal apologycomplaint_letter- Complaint or grievance letterlove_letter- Romantic or affectionate letterinvitation_letter- Event or occasion invitationbusiness_letter- General business correspondenceformal_letter- Formal correspondence- And 15+ more types
The tone or style of the letter. Choose from 17 available tones.Available tones:
professional- Business-appropriate and formalfriendly- Warm and approachablepersuasive- Convincing and compellingromantic- Affectionate and heartfeltformal- Very formal and traditionalcasual- Relaxed and informalapologetic- Sincere and remorsefulenthusiastic- Energetic and positiveempathetic- Understanding and compassionate- And 8+ more tones
The name of the person or organization receiving the letter.Example:
"Sarah Johnson", "TechCorp Hiring Team"A brief description of the letter’s main purpose or objective.Example:
"Applying for Senior Software Engineer position", "Requesting refund for defective product"Additional context, background information, or specific points to include in the letter. This helps the AI generate more personalized and relevant content.Example:
"I have 5 years of experience in full-stack development with React and Node.js. Led a team of 3 developers on the XYZ project."The language code for the generated letter. Supports multiple languages for global communication.Supported languages:
en- English (default)es- Spanishfr- Frenchde- Germanit- Italianpt- Portuguesezh- Chineseja- Japanese- And more
The name of the person sending the letter. If provided, it will be used in the letter signature.Example:
"John Smith"The desired length of the generated letter.Options:
short- Brief and concise (100-200 words)medium- Standard length (200-400 words)long- Detailed and comprehensive (400-600 words)
Request example
Response
A successful request returns a JSON object with the generated letter content.Unique identifier for the generated letter.
The complete generated letter content in plain text format.
The number of words in the generated letter.
The letter type that was requested.
The tone that was applied to the letter.
The language code of the generated letter.
ISO 8601 timestamp of when the letter was generated.
Number of API credits consumed by this request.
Response example
Error responses
The API returns standard HTTP status codes to indicate success or failure.400 Bad Request
Returned when the request is malformed or missing required parameters.401 Unauthorized
Returned when the API key is missing or invalid.429 Too Many Requests
Returned when you exceed your rate limit.500 Internal Server Error
Returned when an unexpected error occurs on the server.503 Service Unavailable
Returned when the service is temporarily unavailable due to maintenance or high load.Error codes
The request is malformed, missing required parameters, or contains invalid values.
The API key is missing, invalid, expired, or has been revoked.
Your account has run out of API credits. Upgrade your plan or wait for the next billing cycle.
You have exceeded your plan’s rate limit. Wait for the limit to reset or upgrade your plan.
The specified letter type is not supported. Check the available types in the parameters section.
The specified tone is not supported. Check the available tones in the parameters section.
The specified language code is not supported.
The request was rejected because it violates our content policy. Ensure your inputs are appropriate and professional.
An unexpected error occurred on the server. Please try again later.
The service is temporarily unavailable. Check our status page for updates.