Create Job

Add a job posting by uploading a file or providing a prompt

POST /addJobByFile

Create Job

cURL

curl --request POST \
  --url https://api.example.com/addJobByFile \
  --header 'Content-Type: application/json' \
  --data '
{
  "recruiterId": "<string>",
  "organizationId": "<string>",
  "prompt": "<string>"
}
'

201 Created

{
  "status": 1,
  "message": "Job(s) created successfully",
  "jobs": [
    {
      "job_unique_id": "68c42431b9f38f8c24fbc91f",
      "job_title": "Full Stack Developer",
      "job_code": "FSD-2025-001",
      "department": "Engineering",
      "location": "San Francisco, CA",
      "employment_type": "Full-time",
      "created_at": "2025-10-23T10:30:00.000Z"
    }
  ]
}

Overview

Create new job postings by uploading job definition files in CSV, XLSX, or JSON format. Optionally provide a prompt for additional parsing instructions.

Endpoint

POST /addJobByFile
Content-Type: multipart/form-data

Request Parameters

recfiles · file · required

Job definition file in CSV, XLSX, or JSON format

recruiterId · string · required

Recruiter’s unique identifier

organizationId · string · required

Organization identifier

prompt · string

Additional parsing instructions for the AI to interpret the job file

Request Example

cURL

curl -X POST https://api.exterview.ai/ats/jobs/upload \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -F "recfiles=@job_posting.csv" \
  -F "recruiterId=68a5b11168f3d6ccd1a" \
  -F "organizationId=68a595060754e2425" \
  -F "prompt=Parse as software engineering roles"

Response

status · integer

Status code: 1 for success, 0 for failure

message · string

Response message describing the result

jobs · array

Array of created job objects

Show Job Object Properties

job_unique_id · string

Unique identifier for the job

job_title · string

Title of the job position

job_code · string

Internal job reference code

department · string

Department or team for the position

location · string

Job location

employment_type · string

Type of employment (Full-time, Part-time, Contract, etc.)

created_at · string

ISO 8601 timestamp of job creation

Response Example

201 Created

{
  "status": 1,
  "message": "Job(s) created successfully",
  "jobs": [
    {
      "job_unique_id": "68c42431b9f38f8c24fbc91f",
      "job_title": "Full Stack Developer",
      "job_code": "FSD-2025-001",
      "department": "Engineering",
      "location": "San Francisco, CA",
      "employment_type": "Full-time",
      "created_at": "2025-10-23T10:30:00.000Z"
    }
  ]
}

Error Responses

Status Code	Description
400	Invalid file or missing required fields
401	Unauthorized - Invalid credentials
409	Duplicate job detected
422	Validation error in file data