Skip to main content
POST
/
ai
/
tailor-resume
Auto-tailor resume for a job posting
curl --request POST \
  --url http://localhost:3000/api/openapi/ai/tailor-resume \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "provider": "ollama",
  "model": "<string>",
  "apiKey": "<string>",
  "baseURL": "<string>",
  "resumeData": {
    "picture": {
      "hidden": true,
      "url": "<string>",
      "size": 272,
      "rotation": 180,
      "aspectRatio": 1.5,
      "borderRadius": 50,
      "borderColor": "<string>",
      "borderWidth": 1,
      "shadowColor": "<string>",
      "shadowWidth": 1
    },
    "basics": {
      "name": "<string>",
      "headline": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "location": "<string>",
      "website": {
        "url": "<string>",
        "label": "<string>"
      },
      "customFields": [
        {
          "id": "<string>",
          "icon": "<string>",
          "text": "<string>",
          "link": "<string>"
        }
      ]
    },
    "summary": {
      "title": "<string>",
      "columns": 123,
      "hidden": true,
      "content": "<string>"
    },
    "sections": {
      "profiles": {
        "title": "<string>",
        "columns": 123,
        "hidden": true,
        "items": [
          {
            "id": "<string>",
            "hidden": true,
            "icon": "<string>",
            "network": "<string>",
            "username": "<string>",
            "website": {
              "url": "<string>",
              "label": "<string>"
            },
            "options": {
              "showLinkInTitle": true
            }
          }
        ]
      },
      "experience": {
        "title": "<string>",
        "columns": 123,
        "hidden": true,
        "items": [
          {
            "id": "<string>",
            "hidden": true,
            "company": "<string>",
            "position": "<string>",
            "location": "<string>",
            "period": "<string>",
            "website": {
              "url": "<string>",
              "label": "<string>"
            },
            "description": "<string>",
            "roles": [
              {
                "id": "<string>",
                "position": "<string>",
                "period": "<string>",
                "description": "<string>"
              }
            ],
            "options": {
              "showLinkInTitle": true
            }
          }
        ]
      },
      "education": {
        "title": "<string>",
        "columns": 123,
        "hidden": true,
        "items": [
          {
            "id": "<string>",
            "hidden": true,
            "school": "<string>",
            "degree": "<string>",
            "area": "<string>",
            "grade": "<string>",
            "location": "<string>",
            "period": "<string>",
            "website": {
              "url": "<string>",
              "label": "<string>"
            },
            "description": "<string>",
            "options": {
              "showLinkInTitle": true
            }
          }
        ]
      },
      "projects": {
        "title": "<string>",
        "columns": 123,
        "hidden": true,
        "items": [
          {
            "id": "<string>",
            "hidden": true,
            "name": "<string>",
            "period": "<string>",
            "website": {
              "url": "<string>",
              "label": "<string>"
            },
            "description": "<string>",
            "options": {
              "showLinkInTitle": true
            }
          }
        ]
      },
      "skills": {
        "title": "<string>",
        "columns": 123,
        "hidden": true,
        "items": [
          {
            "id": "<string>",
            "hidden": true,
            "icon": "<string>",
            "name": "<string>",
            "proficiency": "<string>",
            "level": 2.5,
            "keywords": [
              "<string>"
            ],
            "options": {
              "showLinkInTitle": true
            }
          }
        ]
      },
      "languages": {
        "title": "<string>",
        "columns": 123,
        "hidden": true,
        "items": [
          {
            "id": "<string>",
            "hidden": true,
            "language": "<string>",
            "fluency": "<string>",
            "level": 2.5,
            "options": {
              "showLinkInTitle": true
            }
          }
        ]
      },
      "interests": {
        "title": "<string>",
        "columns": 123,
        "hidden": true,
        "items": [
          {
            "id": "<string>",
            "hidden": true,
            "icon": "<string>",
            "name": "<string>",
            "keywords": [
              "<string>"
            ],
            "options": {
              "showLinkInTitle": true
            }
          }
        ]
      },
      "awards": {
        "title": "<string>",
        "columns": 123,
        "hidden": true,
        "items": [
          {
            "id": "<string>",
            "hidden": true,
            "title": "<string>",
            "awarder": "<string>",
            "date": "<string>",
            "website": {
              "url": "<string>",
              "label": "<string>"
            },
            "description": "<string>",
            "options": {
              "showLinkInTitle": true
            }
          }
        ]
      },
      "certifications": {
        "title": "<string>",
        "columns": 123,
        "hidden": true,
        "items": [
          {
            "id": "<string>",
            "hidden": true,
            "title": "<string>",
            "issuer": "<string>",
            "date": "<string>",
            "website": {
              "url": "<string>",
              "label": "<string>"
            },
            "description": "<string>",
            "options": {
              "showLinkInTitle": true
            }
          }
        ]
      },
      "publications": {
        "title": "<string>",
        "columns": 123,
        "hidden": true,
        "items": [
          {
            "id": "<string>",
            "hidden": true,
            "title": "<string>",
            "publisher": "<string>",
            "date": "<string>",
            "website": {
              "url": "<string>",
              "label": "<string>"
            },
            "description": "<string>",
            "options": {
              "showLinkInTitle": true
            }
          }
        ]
      },
      "volunteer": {
        "title": "<string>",
        "columns": 123,
        "hidden": true,
        "items": [
          {
            "id": "<string>",
            "hidden": true,
            "organization": "<string>",
            "location": "<string>",
            "period": "<string>",
            "website": {
              "url": "<string>",
              "label": "<string>"
            },
            "description": "<string>",
            "options": {
              "showLinkInTitle": true
            }
          }
        ]
      },
      "references": {
        "title": "<string>",
        "columns": 123,
        "hidden": true,
        "items": [
          {
            "id": "<string>",
            "hidden": true,
            "name": "<string>",
            "position": "<string>",
            "website": {
              "url": "<string>",
              "label": "<string>"
            },
            "phone": "<string>",
            "description": "<string>",
            "options": {
              "showLinkInTitle": true
            }
          }
        ]
      }
    },
    "customSections": [
      {
        "title": "<string>",
        "columns": 123,
        "hidden": true,
        "id": "<string>",
        "type": "summary",
        "items": [
          {
            "id": "<string>",
            "hidden": true,
            "recipient": "<string>",
            "content": "<string>",
            "options": {
              "showLinkInTitle": true
            }
          }
        ]
      }
    ],
    "metadata": {
      "template": "azurill",
      "layout": {
        "sidebarWidth": 30,
        "pages": [
          {
            "fullWidth": true,
            "main": [
              "<string>"
            ],
            "sidebar": [
              "<string>"
            ]
          }
        ]
      },
      "css": {
        "enabled": true,
        "value": "<string>"
      },
      "page": {
        "gapX": 1,
        "gapY": 1,
        "marginX": 1,
        "marginY": 1,
        "format": "a4",
        "locale": "<string>",
        "hideIcons": true
      },
      "design": {
        "level": {
          "icon": "<string>",
          "type": "hidden"
        },
        "colors": {
          "primary": "<string>",
          "text": "<string>",
          "background": "<string>"
        }
      },
      "typography": {
        "body": {
          "fontFamily": "<string>",
          "fontWeights": [
            "100"
          ],
          "fontSize": 15,
          "lineHeight": 2.25
        },
        "heading": {
          "fontFamily": "<string>",
          "fontWeights": [
            "100"
          ],
          "fontSize": 15,
          "lineHeight": 2.25
        }
      },
      "notes": "<string>"
    }
  },
  "job": {
    "job_id": "<string>",
    "job_title": "<string>",
    "employer_name": "<string>",
    "employer_logo": "<string>",
    "employer_website": "<string>",
    "employer_company_type": "<string>",
    "employer_linkedin": "<string>",
    "job_publisher": "<string>",
    "job_employment_type": "<string>",
    "job_apply_link": "<string>",
    "job_apply_is_direct": true,
    "job_apply_quality_score": 123,
    "job_description": "<string>",
    "job_is_remote": true,
    "job_city": "<string>",
    "job_state": "<string>",
    "job_country": "<string>",
    "job_latitude": 123,
    "job_longitude": 123,
    "job_posted_at_timestamp": 123,
    "job_posted_at_datetime_utc": "<string>",
    "job_offer_expiration_datetime_utc": "<string>",
    "job_offer_expiration_timestamp": 123,
    "job_min_salary": 123,
    "job_max_salary": 123,
    "job_salary_currency": "<string>",
    "job_salary_period": "<string>",
    "job_benefits": [
      "<string>"
    ],
    "job_google_link": "<string>",
    "job_required_experience": {
      "no_experience_required": true,
      "required_experience_in_months": 123,
      "experience_mentioned": true,
      "experience_preferred": true
    },
    "job_required_skills": [
      "<string>"
    ],
    "job_required_education": {
      "postgraduate_degree": true,
      "professional_certification": true,
      "high_school": true,
      "associates_degree": true,
      "bachelors_degree": true,
      "degree_mentioned": true,
      "degree_preferred": true,
      "professional_certification_mentioned": true
    },
    "job_experience_in_place_of_education": true,
    "job_highlights": {},
    "job_posting_language": "<string>",
    "job_onet_soc": "<string>",
    "job_onet_job_zone": "<string>",
    "job_occupational_categories": [
      "<string>"
    ],
    "job_naics_code": "<string>",
    "job_naics_name": "<string>",
    "apply_options": [
      {
        "publisher": "<string>",
        "apply_link": "<string>",
        "is_direct": true
      }
    ]
  }
}
'
{
  "summary": {
    "content": "<string>"
  },
  "experiences": [
    {
      "index": 123,
      "description": "<string>",
      "roles": [
        {
          "index": 123,
          "description": "<string>"
        }
      ]
    }
  ],
  "references": [
    {
      "index": 123,
      "description": "<string>"
    }
  ],
  "skills": [
    {
      "name": "<string>",
      "keywords": [
        "<string>"
      ],
      "proficiency": "<string>",
      "icon": "<string>",
      "isNew": true
    }
  ]
}

Authorizations

x-api-key
string
header
required

The API key to authenticate requests.

Body

application/json
provider
enum<string>
required
Available options:
ollama,
openai,
gemini,
anthropic,
vercel-ai-gateway
model
string
required
apiKey
string
required
baseURL
string
required
resumeData
object
required
job
object
required

Response

Structured tailoring output returned successfully.

summary
object
required
experiences
object[]
required

You MUST include ALL experience items that have any relevance to the target job. Rewrite their descriptions to emphasize relevant achievements. Only omit experiences completely unrelated to the job.

references
object[]
required

Rewrite ALL reference descriptions to be professional and relevant to the target job. Each description should explain how this reference relates to the candidate's qualifications for the position.

skills
object[]
required

The complete curated skills list for the tailored resume. Include relevant existing skills (rewritten for consistency) and new inferred skills. Aim for 6-10 skills total to avoid overflowing the page. Each skill must have consistent icon, proficiency label, and keywords style.