Skip to content
UltimateTeam.ai Docs

Start a new hiring process

POST
/api/v1/hiring/start

Design a job, research the market, and generate a posting.

Authorizations

Request Body required

Request body for starting a new hiring process.

Attributes: role_description: Free-text description of the role the business needs to fill. business_profile: Optional context about the business (industry, size, culture, etc.) to improve job design quality. location: Geographic location for market research. Defaults to "United States".

object
business_profile
Any of:
object
key
additional properties
any
location

Geographic location for market research

string
default: United States
role_description
required

Free-text description of the role needed

string
>= 10 characters <= 5000 characters

Responses

200

Successful Response

Typed envelope for POST /start.

object
data
required

Response body after successfully starting a hiring process.

Attributes: job_design: LLM-generated job design with title, responsibilities, requirements, and salary range. market_data: Market research results including salary benchmarks and hiring conditions. posting_text: Ready-to-publish job posting text. status: Current status of the hiring process.

object
job_design
required

Structured job design output

object
key
additional properties
any
market_data
required

Market research results for the role

object
key
additional properties
any
posting_text
required

Ready-to-publish job posting text

string
status

Current status of the hiring process

string
default: active
meta
required

Standard metadata attached to every API response.

object
request_id
required

Unique request identifier

string
timestamp
required

Server timestamp of the response

string format: date-time

422

Validation Error

object
detail
Array<object>
object
ctx
object
input
loc
required
Array
msg
required
string
type
required
string