# Letraz Internal Docs

## Docs

- [Create a new certification](https://outline.letraz.app/api-reference/certification-object/create-a-new-certification.md): Adds a new certification to the user's resume as specified in the resume id. If a `base` is provided as resume id, the certification is added to the base resume.
- [Delete a certification](https://outline.letraz.app/api-reference/certification-object/delete-a-certification.md): Delete an existing certification of the user's resume as specified in the resume id. If a `base` is provided as resume id, the certification will be  deleted from to the base resume.
- [Get all certifications](https://outline.letraz.app/api-reference/certification-object/get-all-certifications.md): Gives all certifications for the Resume id or base if `base` is provided as resume id
- [Get certification by id](https://outline.letraz.app/api-reference/certification-object/get-certification-by-id.md): Gives the certification of the resume for the user by produced id or gives base resume certification of the user if id is provided as `base`.
- [Update a certification](https://outline.letraz.app/api-reference/certification-object/update-a-certification.md): Updates an existing certification of the user's resume as specified in the resume id. If a `base` is provided as resume id, the certification is added to the base resume.
- [Get sample error](https://outline.letraz.app/api-reference/core-apis/get-sample-error.md): Returns a sample error response that might occur if an operation fails. Note that the HTTP status would raise an error and that's a normal behavior.
- [Get sample error (bulk operations)](https://outline.letraz.app/api-reference/core-apis/get-sample-error-bulk-operations.md): Returns a sample error response that might occur if one or more operations fails from a bulk operation request. Note that the HTTP status would raise an error and that's a normal behavior.
- [Get server health status](https://outline.letraz.app/api-reference/core-apis/get-server-health-status.md): Returns the server health status. The sentry status is also included in the response
- [Add a new education](https://outline.letraz.app/api-reference/education-object/add-a-new-education.md): Adds a new education to the user's resume as specified in the resume id. If a base is provided as the resume_id, the education is added to the base resume.
- [Delete an education](https://outline.letraz.app/api-reference/education-object/delete-an-education.md): Deletes an education from the user's resume as specified in the resume id.
- [Get all educations](https://outline.letraz.app/api-reference/education-object/get-all-educations.md): Returns all education for the resume id of the user
- [Get education by id](https://outline.letraz.app/api-reference/education-object/get-education-by-id.md): Returns a user's education by the education's id.
- [Update an education](https://outline.letraz.app/api-reference/education-object/update-an-education.md): Updates an existing education entry from the user's resume as specified in the resume id. If a base is provided as the resume_id, the education is updated in the base resume.
- [Create a new experience](https://outline.letraz.app/api-reference/experience-object/create-a-new-experience.md): Adds a new experience to the user's resume as specified in the resume id. If a base resume id is provided, the experience is added to the base resume.
- [Delete an experience](https://outline.letraz.app/api-reference/experience-object/delete-an-experience.md): Deletes an experience from the user's resume as specified in the resume id.
- [Get all experiences](https://outline.letraz.app/api-reference/experience-object/get-all-experiences.md): Gives all experiences for the Resume id
- [Get experience by id](https://outline.letraz.app/api-reference/experience-object/get-experience-by-id.md): Gives experience by id and resume id
- [Update an experience](https://outline.letraz.app/api-reference/experience-object/update-an-experience.md): Updates an existing experience in the user's resume as specified in the resume id. If a base is provided as the resume_id, the experience is updated in the base resume.
- [Get job by job ID](https://outline.letraz.app/api-reference/job-object/get-job-by-job-id.md): Returns the full job object as saved in the database by the job ID. If the job is not found, an error response is returned.
- [Create a new project](https://outline.letraz.app/api-reference/project-object/create-a-new-project.md): Adds a new project to the user's resume as specified in the resume id. If a `base` is provided as resume id, the Project is added to the base resume.
- [Delete a project](https://outline.letraz.app/api-reference/project-object/delete-a-project.md): Delete an existing project of the user's resume as specified in the resume id. If a `base` is provided as resume id, the Project is added to the base resume.
- [Get all projects](https://outline.letraz.app/api-reference/project-object/get-all-projects.md): Gives all projects for the Resume id or base if `base`  is provided as resume id
- [Update a project](https://outline.letraz.app/api-reference/project-object/update-a-project.md): Updates an existing project of the user's resume as specified in the resume id. If a `base` is provided as resume id, the Project is added to the base resume.
- [Delete a resume](https://outline.letraz.app/api-reference/resume-object/delete-a-resume.md): Delete a resume by its ID. Base resume cannot be deleted.
- [Export a resume](https://outline.letraz.app/api-reference/resume-object/export-a-resume.md): Exports a resume by its ID and returns the exported resume's PDF and TEX URL from DigitalOcean CDN
- [Get all resume](https://outline.letraz.app/api-reference/resume-object/get-all-resume.md): Gives a list of all resumes for the user. If no resumes are found, an empty list is returned.
- [Get resume by id](https://outline.letraz.app/api-reference/resume-object/get-resume-by-id.md): Gives a resume for the user by produced id or gives base resume of the user if id is provided as `base`.
- [Rearrange resume sections](https://outline.letraz.app/api-reference/resume-object/rearrange-resume-sections.md): Rearrange the order of sections in a resume by providing an array of section IDs in the desired order.
- [Replace resume sections](https://outline.letraz.app/api-reference/resume-object/replace-resume-sections.md): Replace all sections of a resume with the provided ordered list of sections.
- [Start resume tailoring process](https://outline.letraz.app/api-reference/resume-object/start-resume-tailoring-process.md): Start resume tailoring process
- [Add a new skill](https://outline.letraz.app/api-reference/skill-object/add-a-new-skill.md): Adds a new Skill to the user's resume as specified in the resume id. If a `base` is provided as resume id, the Skill is added to the base resume.
- [Get all global skill categories](https://outline.letraz.app/api-reference/skill-object/get-all-global-skill-categories.md): Get all skills available in the database across users and resumes
- [Get all global skills](https://outline.letraz.app/api-reference/skill-object/get-all-global-skills.md): Get all skills available in the database across users and resumes
- [Get all skill category for the resume](https://outline.letraz.app/api-reference/skill-object/get-all-skill-category-for-the-resume.md): Get all skill category for the resume
- [Get all skills of resume](https://outline.letraz.app/api-reference/skill-object/get-all-skills-of-resume.md): Gives all skill for the Resume id or base if `base`  is provided as resume id
- [Remove skill from resume](https://outline.letraz.app/api-reference/skill-object/remove-skill-from-resume.md): Deletes a skill-proficiency from the user's resume as specified in the resume id or base resume if `base ids provided as resume id`.
- [Update an existing skill](https://outline.letraz.app/api-reference/skill-object/update-an-existing-skill.md): Update an existing Skill-proficiency to the user's resume as specified in the resume id. If a base resume id is provided, the Skill is updated for the base resume.
- [Update current user info](https://outline.letraz.app/api-reference/user/add-a-new-user-info.md): Send a PATCH request with the user's data to add or upsert a user info entry. If the user info already exists, it will be updated. If the user info does not exist, it will be created.
- [Get current user info](https://outline.letraz.app/api-reference/user/get-user-info.md): Returns a user's user info by the user's id. If the user info is not found, a 404 error is returned.
- [Add a new waitlist](https://outline.letraz.app/api-reference/waitlist/add-a-new-waitlist.md): Send a POST request with the email of the user and optionally a ref string to add a new waitlist entry. Returns the newly created waitlist entry with the waiting number and created_at timestamp. A corresponding Knock user will also be created with the same ID and email.
- [Get all waitlists](https://outline.letraz.app/api-reference/waitlist/get-all-waitlists.md): Returns all waitlist entries ordered by waiting number. The waiting number is the order in which the user joined the waitlist.
- [Data Fetching](https://outline.letraz.app/architecture/data-fetching.md): Data Fetching Architecture with TanStack Query and Server Actions in Letraz's client side repository. This architecture provides a robust solution for data fetching in Next.js applications featuring seamless server-side and client-side data fetching, efficient caching and revalidation, type-safe API…
- [Database Schema](https://outline.letraz.app/architecture/database-schema.md): A comprehensive overview of the database schema of Letraz's systems. Letraz's database is designed to efficiently manage resume generation by storing user data, resume configurations, and job-related information. While this documentation is primarily for internal use, it is also publicly accessible…
- [PRD (Requirements) - Alpha](https://outline.letraz.app/documents/prd-alpha.md): Data Fetching Architecture with TanStack Query and Server Actions in Letraz's client side repository. This architecture provides a robust solution for data fetching in Next.js applications featuring seamless server-side and client-side data fetching, efficient caching and revalidation, type-safe API…
- [Guidelines](https://outline.letraz.app/guidelines.md): Guidelines for contributing to Letraz repositories. This document outlines the best practices and guidelines to be followed while contributing to the Letraz repositories. These guidelines are aimed primarily at the core team of Letraz as they have the required access in the Letraz's ecosystem to fol…
- [Introduction](https://outline.letraz.app/introduction.md): Welcome to the internal documentation of Letraz. Albeit it's called internal, it's open to the public to go in alignment with our motto of transparency. This documentation is a work in progress and will be updated regularly as we develop new processes, APIs and workflows.
- [Local Dev Setup](https://outline.letraz.app/local-dev-setup.md): Learn how to locally setup Letraz repositories for development purposes. This guide will help you set up the frontend, backend and utility repositories. And also as an added bonus the documentation repository and the admin panel.

## OpenAPI Specs

- [openapi](https://outline.letraz.app/openapi.yml)

## Optional

- [Admin Panel](https://admin.letraz.app)
- [Live Frontend](https://letraz.app)
- [Live Backend](https://api.letraz.app)