RizqAPI
RizqAPI is a single, unified AI API that solves multiple business problems: detect job scams, roast and improve resumes, analyze salary fairness, extract data from invoices/receipts/ID cards, summarize contracts and flag risks, generate SEO‑optimized product descriptions, and auto‑document code. All endpoints return structured JSON. Powered by DeepSeek V4 Flash.
RizqAPI endpoints
| Method | Endpoint | Description |
|---|---|---|
| GET |
getHealth /v1/health |
Returns service liveness and configuration status. No authentication required. |
| POST |
detectContractRisk /v1/contracts/risk |
Returns a numeric risk score, the top risky clauses with severity ratings, and a recommended course of action. |
| POST |
summarizeContract /v1/contracts/summarize |
Returns plain-English summary paragraphs and a list of key clauses. |
| POST |
parseInvoice /v1/documents/invoice |
Parses an invoice image or PDF and returns structured fields. Supply exactly one of `fileUrl` or `base64Image`. |
| POST |
createAdminApiKey /v1/admin/keys |
Manually provisions a new API key for a customer. Requires the admin password via `x-admin-password` header or `adminPassword` body field. |
| GET |
getAdminUsage /v1/admin/usage |
Returns monthly usage for one customer when `customerId` is provided, or a per-customer summary for the selected month. |
| POST |
parseIdCard /v1/documents/id-card |
Parses a national ID, passport, or driver's licence and returns structured identity fields. |
| POST |
parseReceipt /v1/documents/receipt |
Parses a receipt image and returns structured line items and totals. |
| POST |
generateProductDescription /v1/products/description |
Generates an SEO-optimized product title, full description, meta description, and selling-point bullets. |
| POST |
roastResume /v1/jobs/resume-roast |
Scores a resume, identifies strengths and weaknesses, rewrites weak bullets, and lists priority fixes. |
| POST |
analyzeSalaryFairness /v1/jobs/salary-fairness |
Compares an offered salary against estimated market ranges and returns a fairness verdict, leverage points, negotiation script, and risks. |
| POST |
analyzeJobScam /v1/jobs/scam |
Evaluates a job posting and returns a scam risk verdict, score, red flags, and recommended actions. |
| POST |
commentCode /v1/code-docs/comment |
Annotates the provided source code with clear inline comments explaining each section. |
| POST |
generateReadme /v1/code-docs/readme |
Generates a complete README.md in Markdown for the provided project. |