apyhub
HR · SMART GENERATION

Job Description Generator API

What it does

Job Description Generator turns a role title and optional requirements into hiring copy you can use across your recruiting workflow. Send a body object with title and requirements, and get back generated job content tailored to that role.

Use it when you need a first draft for a new opening, a standardized version for ATS systems, or a shorter version for external channels. The response includes fullJD, atsVersion, linkedInPost, and an interviewScorecard, so you can publish, screen, and interview from the same request.

Job Description Generator is useful when hiring teams need to move quickly without starting from a blank page. Provide the role and the must-have experience, then adapt the returned content to match your company tone, seniority level, and interview process.

This is a good fit for product, engineering, and leadership hiring where you want consistent structure and role-specific language without manually rewriting each posting.

POST
Generate a complete job description
http://localhost:8080/namastesumalya/generate-job-description
QUICKSTARTGUIDE

Quickstart

Generate a job description from a role title and requirements.

curl -X POST "http://localhost:8080/namastesumalya/generate-job-description" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"title":"CTO","requirements":"15+ years experience, scaling to 1M users, AI/ML background."}'

What you'll get back

Returns a JSON object with these top-level fields:

  • fullJD (string): the full job description.
  • atsVersion (string): an ATS-friendly version of the job description.
  • linkedInPost (string): a LinkedIn-ready post.
  • interviewScorecard (array[string]): a list of interview scorecard criteria.
{
  "fullJD": "...",
  "atsVersion": "...",
  "linkedInPost": "We're looking for a visionary builder...",
  "interviewScorecard": [
    "Scaling Experience",
    "Strategic Vision",
    "Technical Mentorship"
  ]
}
TRY ITLIVE · 300 ATOMS
Loading your default key…
The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.
body*

About this endpoint

What it does

Generates a complete job-description package from the supplied role details. The request body includes the job title and optional requirements, and the response returns generated text variants plus an interview scorecard.

Request Body

ParameterTypeMandatoryDescription
titleStringNoJob title.
requirementsStringNoAdditional role requirements or context.

Response

Returns a JSON object with four top-level fields: fullJD and atsVersion as strings, linkedInPost as a string, and interviewScorecard as an array of strings.

ParameterTypeMandatoryDescription
fullJDStringNoThe generated full job description.
atsVersionStringNoThe ATS-friendly version of the job description.
linkedInPostStringNoA LinkedIn-ready post version of the job description.
interviewScorecardString ArrayNoA list of interview scorecard criteria.

Body

Name
Type
Description
bodyREQUIRED
object
▣ 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.