# Embedded Resume Builder

UseResume can provide the backend for a resume builder embedded in a job board, career portal, education platform, or recruitment product. The host application owns the user interface and user data; the UseResume API handles parsing, optional AI tailoring, template rendering, and PDF generation.

UseResume is a backend API and developer-tooling product, not a drop-in iframe or prebuilt frontend widget.

## Suggested architecture

```text
Candidate
   |
   v
Host application's resume form
   |
   +--> optional existing resume upload
   |         |
   |         v
   |    POST /api/v3/resume/parse
   |         |
   |         v
   |    Prefilled editable profile
   |
   v
Structured resume JSON
   |
   +--> POST /api/v3/resume/create
   |         or
   +--> POST /api/v3/resume/create-tailored
             |
             v
      Downloadable resume PDF
```

## Implementation steps

1. Create a server-side UseResume API key.
2. Build or reuse a resume form in the host application.
3. Optionally parse an uploaded resume to prefill the form.
4. Map form data to the UseResume resume content schema.
5. Let the user choose supported template and style options.
6. Send the request from the application server, never from public client-side code.
7. Download or proxy the returned PDF before its signed URL expires.
8. Store the `run_id` if the application may need to refresh the download URL.

## Relevant endpoints

| Product action                            | Endpoint                                    | Credits |
| ----------------------------------------- | ------------------------------------------- | ------: |
| Prefill a profile from an uploaded resume | `POST /api/v3/resume/parse`                 |       4 |
| Generate a resume PDF                     | `POST /api/v3/resume/create`                |       1 |
| Tailor and generate for a job description | `POST /api/v3/resume/create-tailored`       |       5 |
| Generate a matching cover letter          | `POST /api/v3/cover-letter/create`          |       1 |
| Tailor a matching cover letter            | `POST /api/v3/cover-letter/create-tailored` |       5 |

## Security guidance

- Keep the API key on the host application's server.
- Do not place the Bearer key in browser JavaScript, mobile bundles, or public repositories.
- Validate user uploads and input before forwarding them.
- Download generated documents promptly.
- Respect the API limit of 10 requests per second per account.

## Developer options

- Direct REST API
- TypeScript SDK: `@useresume/sdk`
- n8n community node: `@useresume/n8n-nodes-useresume`
- MCP server: `@useresume/mcp-server`
- CLI: `@useresume/cli`

## Related resources

- [Resume Generation API guide](https://useresume.ai/resume-generation-api/resume-generation-api.md)
- [Resume Parsing API guide](https://useresume.ai/resume-generation-api/resume-parsing-api.md)
- [API documentation](https://useresume.ai/resume-generation-api/docs)
- [API pricing](https://useresume.ai/resume-generation-api/pricing.md)