Vector Search Jobs

curl --request POST \
  --url https://api.hirebase.org/v2/jobs/vsearch \
  --header 'Content-Type: application/json' \
  --data '
{
  "search_type": "<string>",
  "query": "<string>",
  "job_id": "<string>",
  "artifact_id": "<string>",
  "industries": [
    "<string>"
  ],
  "subindustries": [
    "<string>"
  ],
  "job_title": "<string>",
  "job_types": [
    "<string>"
  ],
  "experience": [
    "<string>"
  ],
  "company_types": [
    "<string>"
  ],
  "job_categories": [
    "<string>"
  ],
  "job_slug": "<string>",
  "job_board": [
    "<string>"
  ],
  "company_name": "<string>",
  "company_slug": "<string>",
  "locations": {
    "city": "<string>",
    "region": "<string>",
    "country": "<string>"
  },
  "date_posted": "<string>",
  "visa_sponsored": "<string>",
  "top_k": 123,
  "score": 123,
  "salary_from": 123,
  "salary_to": 123,
  "years_from": 123,
  "years_to": 123,
  "page": 123,
  "limit": 123,
  "offset": 123,
  "accuracy": 123
}
'

import requests

url = "https://api.hirebase.org/v2/jobs/vsearch"

payload = {
    "search_type": "<string>",
    "query": "<string>",
    "job_id": "<string>",
    "artifact_id": "<string>",
    "industries": ["<string>"],
    "subindustries": ["<string>"],
    "job_title": "<string>",
    "job_types": ["<string>"],
    "experience": ["<string>"],
    "company_types": ["<string>"],
    "job_categories": ["<string>"],
    "job_slug": "<string>",
    "job_board": ["<string>"],
    "company_name": "<string>",
    "company_slug": "<string>",
    "locations": {
        "city": "<string>",
        "region": "<string>",
        "country": "<string>"
    },
    "date_posted": "<string>",
    "visa_sponsored": "<string>",
    "top_k": 123,
    "score": 123,
    "salary_from": 123,
    "salary_to": 123,
    "years_from": 123,
    "years_to": 123,
    "page": 123,
    "limit": 123,
    "offset": 123,
    "accuracy": 123
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    search_type: '<string>',
    query: '<string>',
    job_id: '<string>',
    artifact_id: '<string>',
    industries: ['<string>'],
    subindustries: ['<string>'],
    job_title: '<string>',
    job_types: ['<string>'],
    experience: ['<string>'],
    company_types: ['<string>'],
    job_categories: ['<string>'],
    job_slug: '<string>',
    job_board: ['<string>'],
    company_name: '<string>',
    company_slug: '<string>',
    locations: {city: '<string>', region: '<string>', country: '<string>'},
    date_posted: '<string>',
    visa_sponsored: '<string>',
    top_k: 123,
    score: 123,
    salary_from: 123,
    salary_to: 123,
    years_from: 123,
    years_to: 123,
    page: 123,
    limit: 123,
    offset: 123,
    accuracy: 123
  })
};

fetch('https://api.hirebase.org/v2/jobs/vsearch', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hirebase.org/v2/jobs/vsearch",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'search_type' => '<string>',
    'query' => '<string>',
    'job_id' => '<string>',
    'artifact_id' => '<string>',
    'industries' => [
        '<string>'
    ],
    'subindustries' => [
        '<string>'
    ],
    'job_title' => '<string>',
    'job_types' => [
        '<string>'
    ],
    'experience' => [
        '<string>'
    ],
    'company_types' => [
        '<string>'
    ],
    'job_categories' => [
        '<string>'
    ],
    'job_slug' => '<string>',
    'job_board' => [
        '<string>'
    ],
    'company_name' => '<string>',
    'company_slug' => '<string>',
    'locations' => [
        'city' => '<string>',
        'region' => '<string>',
        'country' => '<string>'
    ],
    'date_posted' => '<string>',
    'visa_sponsored' => '<string>',
    'top_k' => 123,
    'score' => 123,
    'salary_from' => 123,
    'salary_to' => 123,
    'years_from' => 123,
    'years_to' => 123,
    'page' => 123,
    'limit' => 123,
    'offset' => 123,
    'accuracy' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hirebase.org/v2/jobs/vsearch"

	payload := strings.NewReader("{\n  \"search_type\": \"<string>\",\n  \"query\": \"<string>\",\n  \"job_id\": \"<string>\",\n  \"artifact_id\": \"<string>\",\n  \"industries\": [\n    \"<string>\"\n  ],\n  \"subindustries\": [\n    \"<string>\"\n  ],\n  \"job_title\": \"<string>\",\n  \"job_types\": [\n    \"<string>\"\n  ],\n  \"experience\": [\n    \"<string>\"\n  ],\n  \"company_types\": [\n    \"<string>\"\n  ],\n  \"job_categories\": [\n    \"<string>\"\n  ],\n  \"job_slug\": \"<string>\",\n  \"job_board\": [\n    \"<string>\"\n  ],\n  \"company_name\": \"<string>\",\n  \"company_slug\": \"<string>\",\n  \"locations\": {\n    \"city\": \"<string>\",\n    \"region\": \"<string>\",\n    \"country\": \"<string>\"\n  },\n  \"date_posted\": \"<string>\",\n  \"visa_sponsored\": \"<string>\",\n  \"top_k\": 123,\n  \"score\": 123,\n  \"salary_from\": 123,\n  \"salary_to\": 123,\n  \"years_from\": 123,\n  \"years_to\": 123,\n  \"page\": 123,\n  \"limit\": 123,\n  \"offset\": 123,\n  \"accuracy\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.hirebase.org/v2/jobs/vsearch")
  .header("Content-Type", "application/json")
  .body("{\n  \"search_type\": \"<string>\",\n  \"query\": \"<string>\",\n  \"job_id\": \"<string>\",\n  \"artifact_id\": \"<string>\",\n  \"industries\": [\n    \"<string>\"\n  ],\n  \"subindustries\": [\n    \"<string>\"\n  ],\n  \"job_title\": \"<string>\",\n  \"job_types\": [\n    \"<string>\"\n  ],\n  \"experience\": [\n    \"<string>\"\n  ],\n  \"company_types\": [\n    \"<string>\"\n  ],\n  \"job_categories\": [\n    \"<string>\"\n  ],\n  \"job_slug\": \"<string>\",\n  \"job_board\": [\n    \"<string>\"\n  ],\n  \"company_name\": \"<string>\",\n  \"company_slug\": \"<string>\",\n  \"locations\": {\n    \"city\": \"<string>\",\n    \"region\": \"<string>\",\n    \"country\": \"<string>\"\n  },\n  \"date_posted\": \"<string>\",\n  \"visa_sponsored\": \"<string>\",\n  \"top_k\": 123,\n  \"score\": 123,\n  \"salary_from\": 123,\n  \"salary_to\": 123,\n  \"years_from\": 123,\n  \"years_to\": 123,\n  \"page\": 123,\n  \"limit\": 123,\n  \"offset\": 123,\n  \"accuracy\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hirebase.org/v2/jobs/vsearch")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"search_type\": \"<string>\",\n  \"query\": \"<string>\",\n  \"job_id\": \"<string>\",\n  \"artifact_id\": \"<string>\",\n  \"industries\": [\n    \"<string>\"\n  ],\n  \"subindustries\": [\n    \"<string>\"\n  ],\n  \"job_title\": \"<string>\",\n  \"job_types\": [\n    \"<string>\"\n  ],\n  \"experience\": [\n    \"<string>\"\n  ],\n  \"company_types\": [\n    \"<string>\"\n  ],\n  \"job_categories\": [\n    \"<string>\"\n  ],\n  \"job_slug\": \"<string>\",\n  \"job_board\": [\n    \"<string>\"\n  ],\n  \"company_name\": \"<string>\",\n  \"company_slug\": \"<string>\",\n  \"locations\": {\n    \"city\": \"<string>\",\n    \"region\": \"<string>\",\n    \"country\": \"<string>\"\n  },\n  \"date_posted\": \"<string>\",\n  \"visa_sponsored\": \"<string>\",\n  \"top_k\": 123,\n  \"score\": 123,\n  \"salary_from\": 123,\n  \"salary_to\": 123,\n  \"years_from\": 123,\n  \"years_to\": 123,\n  \"page\": 123,\n  \"limit\": 123,\n  \"offset\": 123,\n  \"accuracy\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "jobs": [
    {
      "_id": "<string>",
      "company_name": "<string>",
      "job_title": "<string>",
      "job_title_raw": "<string>",
      "description": "<string>",
      "application_link": "<string>",
      "job_categories": [
        "<string>"
      ],
      "job_type": "<string>",
      "location_type": "<string>",
      "location_raw": "<string>",
      "salary_range": {
        "min": 123,
        "max": 123,
        "currency": "<string>",
        "period": "<string>"
      },
      "yoe_range": {
        "min": 123,
        "max": 123
      },
      "date_posted": "<string>",
      "company_link": "<string>",
      "company_logo": "<string>",
      "job_board": "<string>",
      "job_board_link": "<string>",
      "experience_level": {},
      "education_level": "<string>",
      "skills": [
        "<string>"
      ],
      "technologies": [
        "<string>"
      ],
      "benefits": [
        "<string>"
      ],
      "requirements_summary": "<string>",
      "team": "<string>",
      "language": "<string>",
      "visa_sponsored": true,
      "recruiter_agency": true,
      "offers_equity": true,
      "company_slug": "<string>",
      "job_slug": "<string>",
      "locations": {
        "city": "<string>",
        "region": "<string>",
        "country": "<string>"
      },
      "expired": {},
      "md5_hash": "<string>",
      "platform_job_id": "<string>",
      "contact_email": {},
      "contact_phone": {},
      "coolness_score": 123,
      "flexibility_score": 123,
      "compensation_value_score": 123,
      "benefits_score": 123,
      "impact_autonomy_score": 123,
      "prestige_score": 123,
      "growth_score": 123,
      "meta_completeness": true,
      "meta_targetability": 123,
      "company_data": {
        "description_summary": "<string>",
        "linkedin_link": "<string>",
        "services": [
          "<string>"
        ],
        "size_range": {
          "min": 123,
          "max": 123
        },
        "industries": [
          "<string>"
        ],
        "subindustries": [
          "<string>"
        ],
        "type": {},
        "is_recruiting_agency": {},
        "is_3rd_party_agency": {}
      }
    }
  ],
  "total_count": 123,
  "company_count": 123,
  "page": 123,
  "limit": 123,
  "total_pages": 123
}

POST

jobs

vsearch

Vector Search Jobs

curl --request POST \
  --url https://api.hirebase.org/v2/jobs/vsearch \
  --header 'Content-Type: application/json' \
  --data '
{
  "search_type": "<string>",
  "query": "<string>",
  "job_id": "<string>",
  "artifact_id": "<string>",
  "industries": [
    "<string>"
  ],
  "subindustries": [
    "<string>"
  ],
  "job_title": "<string>",
  "job_types": [
    "<string>"
  ],
  "experience": [
    "<string>"
  ],
  "company_types": [
    "<string>"
  ],
  "job_categories": [
    "<string>"
  ],
  "job_slug": "<string>",
  "job_board": [
    "<string>"
  ],
  "company_name": "<string>",
  "company_slug": "<string>",
  "locations": {
    "city": "<string>",
    "region": "<string>",
    "country": "<string>"
  },
  "date_posted": "<string>",
  "visa_sponsored": "<string>",
  "top_k": 123,
  "score": 123,
  "salary_from": 123,
  "salary_to": 123,
  "years_from": 123,
  "years_to": 123,
  "page": 123,
  "limit": 123,
  "offset": 123,
  "accuracy": 123
}
'

import requests

url = "https://api.hirebase.org/v2/jobs/vsearch"

payload = {
    "search_type": "<string>",
    "query": "<string>",
    "job_id": "<string>",
    "artifact_id": "<string>",
    "industries": ["<string>"],
    "subindustries": ["<string>"],
    "job_title": "<string>",
    "job_types": ["<string>"],
    "experience": ["<string>"],
    "company_types": ["<string>"],
    "job_categories": ["<string>"],
    "job_slug": "<string>",
    "job_board": ["<string>"],
    "company_name": "<string>",
    "company_slug": "<string>",
    "locations": {
        "city": "<string>",
        "region": "<string>",
        "country": "<string>"
    },
    "date_posted": "<string>",
    "visa_sponsored": "<string>",
    "top_k": 123,
    "score": 123,
    "salary_from": 123,
    "salary_to": 123,
    "years_from": 123,
    "years_to": 123,
    "page": 123,
    "limit": 123,
    "offset": 123,
    "accuracy": 123
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    search_type: '<string>',
    query: '<string>',
    job_id: '<string>',
    artifact_id: '<string>',
    industries: ['<string>'],
    subindustries: ['<string>'],
    job_title: '<string>',
    job_types: ['<string>'],
    experience: ['<string>'],
    company_types: ['<string>'],
    job_categories: ['<string>'],
    job_slug: '<string>',
    job_board: ['<string>'],
    company_name: '<string>',
    company_slug: '<string>',
    locations: {city: '<string>', region: '<string>', country: '<string>'},
    date_posted: '<string>',
    visa_sponsored: '<string>',
    top_k: 123,
    score: 123,
    salary_from: 123,
    salary_to: 123,
    years_from: 123,
    years_to: 123,
    page: 123,
    limit: 123,
    offset: 123,
    accuracy: 123
  })
};

fetch('https://api.hirebase.org/v2/jobs/vsearch', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hirebase.org/v2/jobs/vsearch",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'search_type' => '<string>',
    'query' => '<string>',
    'job_id' => '<string>',
    'artifact_id' => '<string>',
    'industries' => [
        '<string>'
    ],
    'subindustries' => [
        '<string>'
    ],
    'job_title' => '<string>',
    'job_types' => [
        '<string>'
    ],
    'experience' => [
        '<string>'
    ],
    'company_types' => [
        '<string>'
    ],
    'job_categories' => [
        '<string>'
    ],
    'job_slug' => '<string>',
    'job_board' => [
        '<string>'
    ],
    'company_name' => '<string>',
    'company_slug' => '<string>',
    'locations' => [
        'city' => '<string>',
        'region' => '<string>',
        'country' => '<string>'
    ],
    'date_posted' => '<string>',
    'visa_sponsored' => '<string>',
    'top_k' => 123,
    'score' => 123,
    'salary_from' => 123,
    'salary_to' => 123,
    'years_from' => 123,
    'years_to' => 123,
    'page' => 123,
    'limit' => 123,
    'offset' => 123,
    'accuracy' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hirebase.org/v2/jobs/vsearch"

	payload := strings.NewReader("{\n  \"search_type\": \"<string>\",\n  \"query\": \"<string>\",\n  \"job_id\": \"<string>\",\n  \"artifact_id\": \"<string>\",\n  \"industries\": [\n    \"<string>\"\n  ],\n  \"subindustries\": [\n    \"<string>\"\n  ],\n  \"job_title\": \"<string>\",\n  \"job_types\": [\n    \"<string>\"\n  ],\n  \"experience\": [\n    \"<string>\"\n  ],\n  \"company_types\": [\n    \"<string>\"\n  ],\n  \"job_categories\": [\n    \"<string>\"\n  ],\n  \"job_slug\": \"<string>\",\n  \"job_board\": [\n    \"<string>\"\n  ],\n  \"company_name\": \"<string>\",\n  \"company_slug\": \"<string>\",\n  \"locations\": {\n    \"city\": \"<string>\",\n    \"region\": \"<string>\",\n    \"country\": \"<string>\"\n  },\n  \"date_posted\": \"<string>\",\n  \"visa_sponsored\": \"<string>\",\n  \"top_k\": 123,\n  \"score\": 123,\n  \"salary_from\": 123,\n  \"salary_to\": 123,\n  \"years_from\": 123,\n  \"years_to\": 123,\n  \"page\": 123,\n  \"limit\": 123,\n  \"offset\": 123,\n  \"accuracy\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.hirebase.org/v2/jobs/vsearch")
  .header("Content-Type", "application/json")
  .body("{\n  \"search_type\": \"<string>\",\n  \"query\": \"<string>\",\n  \"job_id\": \"<string>\",\n  \"artifact_id\": \"<string>\",\n  \"industries\": [\n    \"<string>\"\n  ],\n  \"subindustries\": [\n    \"<string>\"\n  ],\n  \"job_title\": \"<string>\",\n  \"job_types\": [\n    \"<string>\"\n  ],\n  \"experience\": [\n    \"<string>\"\n  ],\n  \"company_types\": [\n    \"<string>\"\n  ],\n  \"job_categories\": [\n    \"<string>\"\n  ],\n  \"job_slug\": \"<string>\",\n  \"job_board\": [\n    \"<string>\"\n  ],\n  \"company_name\": \"<string>\",\n  \"company_slug\": \"<string>\",\n  \"locations\": {\n    \"city\": \"<string>\",\n    \"region\": \"<string>\",\n    \"country\": \"<string>\"\n  },\n  \"date_posted\": \"<string>\",\n  \"visa_sponsored\": \"<string>\",\n  \"top_k\": 123,\n  \"score\": 123,\n  \"salary_from\": 123,\n  \"salary_to\": 123,\n  \"years_from\": 123,\n  \"years_to\": 123,\n  \"page\": 123,\n  \"limit\": 123,\n  \"offset\": 123,\n  \"accuracy\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hirebase.org/v2/jobs/vsearch")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"search_type\": \"<string>\",\n  \"query\": \"<string>\",\n  \"job_id\": \"<string>\",\n  \"artifact_id\": \"<string>\",\n  \"industries\": [\n    \"<string>\"\n  ],\n  \"subindustries\": [\n    \"<string>\"\n  ],\n  \"job_title\": \"<string>\",\n  \"job_types\": [\n    \"<string>\"\n  ],\n  \"experience\": [\n    \"<string>\"\n  ],\n  \"company_types\": [\n    \"<string>\"\n  ],\n  \"job_categories\": [\n    \"<string>\"\n  ],\n  \"job_slug\": \"<string>\",\n  \"job_board\": [\n    \"<string>\"\n  ],\n  \"company_name\": \"<string>\",\n  \"company_slug\": \"<string>\",\n  \"locations\": {\n    \"city\": \"<string>\",\n    \"region\": \"<string>\",\n    \"country\": \"<string>\"\n  },\n  \"date_posted\": \"<string>\",\n  \"visa_sponsored\": \"<string>\",\n  \"top_k\": 123,\n  \"score\": 123,\n  \"salary_from\": 123,\n  \"salary_to\": 123,\n  \"years_from\": 123,\n  \"years_to\": 123,\n  \"page\": 123,\n  \"limit\": 123,\n  \"offset\": 123,\n  \"accuracy\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "jobs": [
    {
      "_id": "<string>",
      "company_name": "<string>",
      "job_title": "<string>",
      "job_title_raw": "<string>",
      "description": "<string>",
      "application_link": "<string>",
      "job_categories": [
        "<string>"
      ],
      "job_type": "<string>",
      "location_type": "<string>",
      "location_raw": "<string>",
      "salary_range": {
        "min": 123,
        "max": 123,
        "currency": "<string>",
        "period": "<string>"
      },
      "yoe_range": {
        "min": 123,
        "max": 123
      },
      "date_posted": "<string>",
      "company_link": "<string>",
      "company_logo": "<string>",
      "job_board": "<string>",
      "job_board_link": "<string>",
      "experience_level": {},
      "education_level": "<string>",
      "skills": [
        "<string>"
      ],
      "technologies": [
        "<string>"
      ],
      "benefits": [
        "<string>"
      ],
      "requirements_summary": "<string>",
      "team": "<string>",
      "language": "<string>",
      "visa_sponsored": true,
      "recruiter_agency": true,
      "offers_equity": true,
      "company_slug": "<string>",
      "job_slug": "<string>",
      "locations": {
        "city": "<string>",
        "region": "<string>",
        "country": "<string>"
      },
      "expired": {},
      "md5_hash": "<string>",
      "platform_job_id": "<string>",
      "contact_email": {},
      "contact_phone": {},
      "coolness_score": 123,
      "flexibility_score": 123,
      "compensation_value_score": 123,
      "benefits_score": 123,
      "impact_autonomy_score": 123,
      "prestige_score": 123,
      "growth_score": 123,
      "meta_completeness": true,
      "meta_targetability": 123,
      "company_data": {
        "description_summary": "<string>",
        "linkedin_link": "<string>",
        "services": [
          "<string>"
        ],
        "size_range": {
          "min": 123,
          "max": 123
        },
        "industries": [
          "<string>"
        ],
        "subindustries": [
          "<string>"
        ],
        "type": {},
        "is_recruiting_agency": {},
        "is_3rd_party_agency": {}
      }
    }
  ],
  "total_count": 123,
  "company_count": 123,
  "page": 123,
  "limit": 123,
  "total_pages": 123
}

Run semantic job searches using vector embeddings. Instead of relying on keyword matching, this API understands the meaning behind your query to return more relevant job results. You can use the Vector Search Jobs API to search by natural language, match jobs similar to a specific listing, or find jobs that align with a candidate’s resume.

Endpoint

POST /v2/jobs/vsearch

Search Types

Natural Language Query

Use the query parameter to search with a natural language description of the specific job.

Similar Job Search

Use the job_id parameter with search_type=job to find jobs similar to a specific job.

Resume Matching

Use the artifact_id parameter with search_type=resume to find jobs that match a resume. The artifact_id is the _id returned by Upload Resume.

Request Body

Note:

All request body fields are optional unless stated otherwise.
Begin with minimal filters to avoid excluding relevant results too early.
Filter combinations can be mixed and matched.
Use specific filters to narrow down search results and get relevant matches.

The core vector search parameters (search_type, query, top_k, accuracy, limit, page) work as documented. Lexical filter parameters (salary_from, years_from, industries, locations, etc.) are accepted but may not narrow results in all cases. For reliable filtered search, use Neural Search, which combines vector matching with lexical filtering.

search_type

string

default:"summary"

required

Type of search to perform (“summary”, “job”, or “resume”)

query

string

required

Natural language description of the job you’re looking for

Note:Required only when the search type is Natural Language Query. Omit for Similar Job Search and Resume Matching search types.

job_id

string

required

The ID of the job to use as a reference for retrieving similar job listings (obtain job IDs from Search Jobs).

Note:Required only when the search type is Similar Job Search. Omit for Natural Language Query and Resume Matching search types.

artifact_id

string

required

Find jobs matching a resume by its stored id. This is the _id returned by Upload Resume.

The artifact_id must be a valid MongoDB ObjectId. A malformed (non-ObjectId) value currently returns 500 rather than 400/404.

Note:Required only when the search type is Resume Matching. Omit for Natural Language Query and Similar Job Search search types.

industries

string[]

Filter by one or more company industries (e.g., "Tech, Software & IT Services", "Healthcare"). See List Industries.

subindustries

string[]

Filter by one or more specific subindustries. See List Subindustries.

job_title

string

Filter jobs by exact job title (e.g., “Software Engineer”, “Marketing Manager”).

job_types

string[]

Array of employment types. Accepted values: "Full Time", "Part Time", "Contract", "Internship".

The "Contract" value matches roles whose returned job_type is "Contract / Temporary" — request token and response label differ.

The correct field name is job_types (plural). Using job_type (singular) is silently ignored — the request succeeds but the filter is not applied.

experience

string[]

Filter by experience level. Accepted values: "Entry", "Junior", "Mid", "Senior", "Executive".

company_types

string[]

Filter jobs by the hiring company’s headcount bucket. Accepted values: "1-10", "11-50", "51-200", "201-500", "501-1000", "1001-5000", "5001-10000", "10000+". Pass multiple values to combine ranges (e.g., ["11-50", "51-200"]).

This parameter is named company_types for historical reasons but currently filters by company size. A separate classification filter (Public Company / Non-Profit / etc.) will be added in a future API update.

job_categories

string[]

Filter by one or more job category tags (e.g., "Engineering Jobs", "Marketing Jobs").

job_slug

string

Filter by the unique slug of a job (used to fetch or highlight a specific job).

job_board

string[]

Filter by the job board source (e.g., “Workable”, “Greenhouse”).

company_name

string

Filter by the name of the company offering the job.

company_slug

string

Filter jobs by the unique company slug identifier.

locations

object

Filter jobs by one or more locations. Each location object can include city, region, or country.

Show child attributes

city

string

City name to filter jobs by (e.g., “New York”, “Berlin”).

region

string

State, province, or region name (e.g., “California”, “Bavaria”).

country

string

Country name or code (e.g., “United States”, “DE”).

date_posted

string

Filter jobs posted on or after a specific date (format: YYYY-MM-DD).

visa_sponsored

string

Filter to include only jobs that offer visa sponsorship.

top_k

number

default:"10"

Number of results to return

score

number

Minimum similarity score to include in results

Note:Higher similarity scores indicate stronger semantic matches.

salary_from

number

Minimum salary filter

salary_to

number

Maximum salary filter

years_from

number

Minimum years of experience filter

years_to

number

Maximum years of experience filter

page

number

default:"1"

Page number for pagination

limit

number

default:"10"

Number of results per page

offset

number

Offset for results (alternative to page)

Note:The page, limit, and offset fields all control how results are paginated i.e., how many results you get and which ones are returned. You can use either page and limit together or use offset withlimit.

If you’re using page, you’re asking for a specific page of results (like page 2 or page 3), and limit defines how many results appear on each page.
If you’re using offset, you’re skipping a certain number of results before starting to return data. For example, offset= 20 with limit= 10 means “skip the first 20 results, then return the next 10.”

accuracy

number

default:"0.0"

Search accuracy vs. speed, as a float from 0.0 (fastest) to 1.0 (most accurate). Higher values take more time.

Response

jobs

array

Array of job objects, each representing a single job listing along with company and scoring metadata.

Show child attributes

_id

string

Unique identifier for the job posting

company_name

string

Name of the company offering the job

job_title

string

Title of the job role

job_title_raw

string

Unparsed job title as scraped from the source.

description

string

Full HTML-formatted description of the job posting

application_link

string

Direct URL to apply for the job

job_categories

string[]

List of job category tags used for classification (e.g., “Engineering Jobs”)

job_type

string

Employment type. One of: "Full Time", "Part Time", "Contract / Temporary", "Internship".

location_type

string

Work arrangement, such as “Remote”, “Hybrid”, or “In-Person”

location_raw

string

Raw location string from the source job board (before normalization into locations).

salary_range

object | null

Estimated or provided salary range. May be null if unspecified

Show child attributes

min

number

Minimum salary (if available)

max

number

Maximum salary (if available)

currency

string

Currency code (e.g., USD, CAD)

period

string

Pay period for the salary range. Observed values: "yearly", "monthly", "daily", "hourly".

This field is not fully normalized today — you may also see "year" (≡ "yearly") and "hour" (≡ "hourly"). Treat those as equivalent until normalized.

yoe_range

object

Range of required years of experience.

Show child attributes

min

number

Minimum years of experience

max

number

Maximum years of experience

date_posted

string

Date the job was posted, in YYYY-MM-DD format

company_link

string

Link to the official website of the company

company_logo

string

URL of the company’s logo image

job_board

string

Name of the job board where the job was sourced (e.g., “Workable”, “Greenhouse”)

job_board_link

string

Link to the job board’s listing page for this company

experience_level

string | null

Parsed experience tier for the role (e.g., "Senior"). May be null when not inferred.

education_level

string

Required education level. One of: "No Education Required", "High school degree", "Associate degree", "Bachelor's degree", "Master's degree", "Doctoral degree".

skills

string[]

List of skills mentioned in the job description

technologies

string[]

List of technologies mentioned in the job description

benefits

string[]

List of benefits mentioned in the job description

requirements_summary

string

Brief summary of key job requirements, such as qualifications and skills

team

string

Team at the company hiring for the position

language

string

Language the job posting is in

visa_sponsored

boolean

Indicates whether the company offers visa sponsorship for this role

recruiter_agency

boolean

Indicates whether the listing was posted by a recruiting agency

offers_equity

boolean

Whether the listing mentions equity compensation.

company_slug

string

Unique slug used to identify the company programmatically

job_slug

string

Unique slug used to identify the job posting programmatically

locations

object

List of job location objects

Show child attributes

city

string

City where the job is based

region

string

Region or state of the job location

country

string

Country of the job location

expired

boolean (optional)

Indicates whether the job listing is expired. May be missing if not applicable

md5_hash

string

Content hash of the listing.

platform_job_id

string

The source ATS’s own job identifier.

contact_email

string | null

Contact email for the listing, when available. Paid users only.

contact_phone

string | null

Contact phone number for the listing, when available. Paid users only.

Dimension scores — coolness_score, flexibility_score, compensation_value_score, benefits_score, impact_autonomy_score, prestige_score, and growth_score each use a 0–10 scale (higher is better).

coolness_score

number

Company/role “coolness” rating (0–10).

flexibility_score

number

Work-flexibility rating (0–10).

compensation_value_score

number

Compensation competitiveness rating (0–10).

benefits_score

number

Benefits package rating (0–10).

impact_autonomy_score

number

Role-level impact and autonomy rating (0–10).

prestige_score

number

Company/role prestige rating (0–10).

growth_score

number

Career growth / learning opportunity rating (0–10).

meta_completeness

boolean

Whether the parsed listing metadata is considered complete.

meta_targetability

number

Internal signal (0–1) reflecting how targetable/complete the listing is for matching.

company_data

object

Enriched company information related to the job

Show child attributes

description_summary

string

Short summary of the company’s mission or business focus

linkedin_link

string

Link to the company’s LinkedIn profile.

services

string[]

List of services that the company provides

size_range

object

Employee size range at the company

Show child attributes

min

number

Minimum number of employees.

max

number

Maximum number of employees.

industries

string[]

Primary industries the company operates in (e.g., “Tech, Software & IT Services”)

subindustries

string[]

More specific subindustry classifications under the primary industries

type

string | null

Categorical company type (e.g., "Startup", "Enterprise").

is_recruiting_agency

boolean | null

Whether the company is a recruiting/talent agency.

is_3rd_party_agency

boolean | null

Whether the company is a third-party agency.

total_count

number

Total number of matching job listings across all pages.

company_count

number

Reserved for unique-company counts. Currently always returns 0 for this endpoint — use total_count for result sizing.

page

number

Current page number of the response.

limit

number

Maximum number of jobs returned per page.

total_pages

number

Total number of pages available for the current query.

Rate limit: 4 requests/second on search endpoints. See Error Handling.Note: Per-job similarity score is not currently returned in vsearch responses (verified for summary and job search modes).

Example Request

curl -X POST "https://api.hirebase.org/v2/jobs/vsearch" \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{
    "search_type": "summary",
    "query": "senior full-stack engineer with React, TypeScript, and AWS experience",
    "top_k": 10,
    "accuracy": 0.3,
    "limit": 10
  }'

curl -X POST "https://api.hirebase.org/v2/jobs/vsearch" \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{
    "job_id": "6a2f14a48bea0df96e26ac7b",
    "search_type": "job",
    "top_k": 10
  }'

# artifact_id is the `_id` returned by Upload Resume (a 24-character hex ObjectId).
curl -X POST "https://api.hirebase.org/v2/jobs/vsearch" \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{
    "artifact_id": "6a2f14a48bea0df96e26ac7b",
    "search_type": "resume",
    "limit": 20
  }'

Example Response

{
    "jobs": [
        {
            "_id": "6a2f14a48bea0df96e26ac7b",
            "company_name": "CompanyXYZ",
            "job_title": "Senior Python Engineer",
            "job_title_raw": "Senior Python Engineer - Remote",
            "description": "<p>… cleaned/summarized description …</p>",
            "application_link": "https://jobs.workable.com/view/nqSdYtJwQ/...",
            "job_categories": ["Software Engineer Jobs", "Engineering Jobs", "Information Technology Jobs"],
            "job_type": "Full Time",
            "location_type": "Remote",
            "location_raw": "TELECOMMUTE; British Columbia, Canada",
            "locations": [
                {
                    "city": null,
                    "region": null,
                    "country": "Canada",
                    "coordinates": {"type": "Point", "coordinates": [-123.12, 49.28]},
                    "bbox": [-123.2, 49.0, -122.9, 49.3],
                    "address": "British Columbia, Canada"
                }
            ],
            "salary_range": {"min": 150000, "max": 210000, "currency": "USD", "period": "yearly"},
            "yoe_range": {"min": 2, "max": 5},
            "experience_level": "Senior",
            "education_level": "Bachelor's degree",
            "skills": ["Python", "FastAPI", "Distributed systems"],
            "technologies": ["Python", "PostgreSQL", "AWS"],
            "benefits": ["401k matching", "Remote-first", "Equity"],
            "requirements_summary": "5+ years Python; distributed systems experience",
            "team": "Platform Engineering",
            "language": "en",
            "visa_sponsored": false,
            "recruiter_agency": false,
            "offers_equity": false,
            "date_posted": "2026-06-07",
            "job_board": "workable",
            "job_board_link": "https://jobs.workable.com/company/...",
            "job_slug": "senior-python-engineer-17",
            "company_slug": "companyxyz",
            "company_link": "companyxyz.com",
            "company_logo": "https://logos.hirebase.org/.../companyxyz-320x320-q95.jpg",
            "md5_hash": "d6b5d4e7b99d23b082b46e49c22c168f",
            "platform_job_id": "ad88b6ba-a905-4850-ad79-73beb0e97766",
            "coolness_score": 6.4,
            "flexibility_score": 6.1,
            "compensation_value_score": 6.0,
            "benefits_score": 5.0,
            "impact_autonomy_score": 7.1,
            "prestige_score": 5.2,
            "growth_score": 6.2,
            "meta_completeness": false,
            "meta_targetability": 0.8,
            "company_data": {
                "description_summary": "CompanyXYZ builds …",
                "linkedin_link": "https://www.linkedin.com/company/companyxyz",
                "size_range": {"min": 51, "max": 200},
                "industries": ["Tech, Software & IT Services"],
                "subindustries": ["AI & ML"],
                "services": ["Platform", "APIs"],
                "type": "Startup",
                "is_recruiting_agency": false,
                "is_3rd_party_agency": false
            }
        }
    ],
    "total_count": 100,
    "company_count": 0,
    "page": 1,
    "limit": 10,
    "total_pages": 10
}

Error Responses

400 Bad Request

Returns when the request is missing required data or includes invalid parameters.

For example, this error occurs if an artifact_id is provided but not found in the system.

401 Unauthorized

Returns when the API key is missing, invalid, or incorrect.

403 Forbidden

Returns when your account does not have permission to access the requested feature.

This usually means the feature is restricted to certain subscription tiers.

Best Practices

Use detailed natural language queries: The API performs best when queries are specific and clearly describe experience, goals, or desired roles.
Prefer prompts over structured parameters: The most accurate matches come from descriptive prompts rather than strict filters.

Neural Search Jobs

Export Jobs

Jobs API

Hiring Manager API

Companies API

Insights API

Reference Data API

Resumes

Tasks API

Error Handling

Vector Search Jobs

Endpoint

Search Types

Request Body

Response

Example Request

Example Response

Error Responses

​Endpoint

​Search Types

​Request Body

​Response

​Example Request

​Example Response

​Error Responses

Endpoint

Search Types

Request Body

Response

Example Request

Example Response

Error Responses