Skip to main content
POST
This endpoint is AI-powered and rate limited to 5 requests/minute. It uses a large language model to generate tailored interview questions based on the job details, skills, and requirements provided.

Authorizations

string | header
required
API key of the form <token>, passed as the x-tidyhire-api-key header.

Body

string
required
Job title.Example: "Senior Software Engineer"
string
required
Company name.Example: "Acme Corp"
string
required
Detailed job description.Example: "We are looking for a Senior Software Engineer to join our team..."
number
required
Minimum years of experience required.Example: 3
number
required
Maximum years of experience required.Example: 5
string
required
One of: Entry, Mid, Senior, Lead, Principal, Staff.Example: "Senior"
string
required
One of: Remote, On Site, Hybrid.Example: "Remote"
string
required
One of: Full Time, Part Time, Contract, Freelance.Example: "Full Time"
string
Job location.Example: "New York, NY"
string[]
required
Required skills. Minimum 3.Example: ["JavaScript", "Node.js", "MongoDB"]
string[]
Preferred skills.Example: ["TypeScript", "Redis", "Docker"]
string
One of: 15 Minutes, 30 Minutes, 45 Minutes, 1 hour, 2 hours. Defaults to "30 Minutes".

Response

Interview questions generated successfully
boolean
Indicates if the request was successful. Example: true
object[]
Generated interview questions.

Common Errors

Reason: The request body is not valid JSON.