Skip to content
UltimateTeam.ai Docs

Start a new hiring process

POST
/api/v1/hiring/start
curl --request POST \
  --url https://api.ultimateteam.ai/api/v1/hiring/start \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "business_profile": {}, "location": "United States", "role_description": "example" }'

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

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
StartHiringRequest

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
Location

Geographic location for market research

string
default: United States
role_description
required
Role Description

Free-text description of the role needed

string
>= 10 characters <= 5000 characters

Responses

Section titled “ Responses ”

200

Section titled “200”

Successful Response

Media typeapplication/json
StartHiringEnvelope

Typed envelope for POST /start.

object
data
required
StartHiringResponse

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
Job Design

Structured job design output

object
key
additional properties
any
market_data
required
Market Data

Market research results for the role

object
key
additional properties
any
posting_text
required
Posting Text

Ready-to-publish job posting text

string
status
Status

Current status of the hiring process

string
default: active
meta
required
ResponseMeta

Standard metadata attached to every API response.

object
request_id
required
Request Id

Unique request identifier

string
timestamp
required
Timestamp

Server timestamp of the response

string format: date-time
Example
{
  "data": {
    "status": "active"
  }
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}