▣ HR · SMART GENERATION

Resume Optimize Document API

What it does

Resume Optimizer helps you refine a resume for a target role by sending resume text or uploading a PDF or DOCX file. It takes the content you provide, along with optional target skills, and returns an optimized result in its response.

Use the text endpoint when you already have a plain-text resume. Send resume_text and, if you want, an array of target_skills to steer the optimization toward specific requirements. Use the upload endpoint when the resume lives in a file: upload file and pass target_skills as a comma-separated string such as kubernetes,data engineering,fastapi.

This fits common hiring workflows where you want to tailor one resume for a specific job description or skill set before applying. The API returns a structured optimization result containing analysis results, AI-generated recommendations, enhanced content, metadata, and attribution.

▣ ENDPOINT 01 / 02

POST

Optimize resume

https://api.eu.apyhub.com/dosvak/optimize-resume

QUICKSTART

GUIDE

Quickstart

Send your resume text to optimize it for the target role.

curl -X POST "https://api.eu.apyhub.com/dosvak/optimize-resume" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "resume_text": "Experienced software engineer with 5+ years building scalable web applications, leading cross-functional projects, and improving system performance.",
    "target_skills": ["Python", "AWS", "Docker"]
  }'

What you'll get back

{
  "present_target_skills": [],
  "missing_target_skills": [
    "python"
  ],
  "suggestions": [
    "Add measurable bullets demonstrating these missing target skills."
  ],
  "llm_optimized_summary": "Skilled software engineer with 5+ years in scalable web development.",
  "llm_bullet_rewrite_suggestions": [
    "Replace 'leading cross-functional projects' with 'managing cross-functional teams'"
  ]
}

TRY ITLIVE · 100 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Optimizes resume text for a target role and returns a structured JSON object containing analysis results, AI-generated recommendations, enhanced content, metadata, and attribution.

Request Body

Parameter	Type	Mandatory	Description
resume_text	String	Yes	The resume text to optimize. Must be at least 20 characters long.
target_skills	String Array	No	Optional list of target skills to tailor the resume toward.

Response

Returns a structured JSON object containing analysis results, AI-generated recommendations, metadata, and attribution.

Body

Name

Type

Description

bodyREQUIRED

object

—

▣ ENDPOINT 02 / 02

POST

Optimize resume upload

https://api.eu.apyhub.com/dosvak/optimize-resume/upload

QUICKSTART

GUIDE

Quickstart

Upload a resume file to start an optimization request.

curl -X POST "https://api.eu.apyhub.com/dosvak/optimize-resume/upload" \
  -H "apy-token: $APY_TOKEN" \
  -F "file=@/path/to/resume.pdf"

What you'll get back

Returns a structured JSON object containing analysis results, AI-generated recommendations, request metadata, and attribution.

{
  "present_target_skills": [
    "sql"
  ],
  "missing_target_skills": [],
  "suggestions": [],
  "llm_optimized_summary": "Jane Doe has 8 years of experience as a Senior Data Engineer with expertise in Python, SQL, FastAPI, Docker, and Kubernetes.",
  "llm_bullet_rewrite_suggestions": [
    "Developed ETL workflows and API endpoints using Python and FastAPI."
  ],
  "input_mode": "file",
  "file_name": "Jane_Doe_Resume.docx"
}

TRY ITLIVE · 100 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

Max 100MB total per request (all files combined). Larger? Use this API's URL-based endpoint instead, if it has one.

About this endpoint

What it does

Uploads a supported resume file and returns a structured JSON object containing optimization results, analysis, AI-generated recommendations, request metadata, and attribution.

Request Body

Parameter	Type	Mandatory	Description
file	String	Yes	Resume file upload in `.pdf` or `.docx` format.
target_skills	String	No	Comma-separated skills, for example `kubernetes,data engineering,fastapi`.

Body

Name

Type

Description

bodyREQUIRED

object

—

Max 100MB total per request (all files combined). Larger? Use this API's URL-based endpoint instead, if it has one.

▣ COMMON ERRORS

Errors any endpoint can return

400bad_request

Required parameter missing or malformed body.

401unauthorized

API key missing, revoked, or not authorized for this service.

429rate_limited

Your plan's per-second rate exceeded. Retry with exponential backoff.

503upstream_busy

Backend temporarily unavailable. Try again in a few seconds.