Upload Resume

curl --request POST \
  --url https://api.hirebase.org/v2/resumes/upload/ \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '{}'

import requests

url = "https://api.hirebase.org/v2/resumes/upload/"

payload = {}
headers = {
    "x-api-key": "<x-api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://api.hirebase.org/v2/resumes/upload/', 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/resumes/upload/",
  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([
    
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <x-api-key>"
  ],
]);

$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/resumes/upload/"

	payload := strings.NewReader("{}")

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

	req.Header.Add("x-api-key", "<x-api-key>")
	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/resumes/upload/")
  .header("x-api-key", "<x-api-key>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hirebase.org/v2/resumes/upload/")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{}"

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

{
  "_id": "<string>",
  "user_id": "<string>",
  "resume_url": "<string>",
  "parsed_data": {},
  "status": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>"
}

POST

resumes

upload

Upload Resume

curl --request POST \
  --url https://api.hirebase.org/v2/resumes/upload/ \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '{}'

import requests

url = "https://api.hirebase.org/v2/resumes/upload/"

payload = {}
headers = {
    "x-api-key": "<x-api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://api.hirebase.org/v2/resumes/upload/', 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/resumes/upload/",
  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([
    
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <x-api-key>"
  ],
]);

$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/resumes/upload/"

	payload := strings.NewReader("{}")

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

	req.Header.Add("x-api-key", "<x-api-key>")
	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/resumes/upload/")
  .header("x-api-key", "<x-api-key>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hirebase.org/v2/resumes/upload/")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{}"

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

{
  "_id": "<string>",
  "user_id": "<string>",
  "resume_url": "<string>",
  "parsed_data": {},
  "status": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>"
}

Upload Resume is the stored counterpart to Embed Resume. /embed is stateless and returns only a vector, whereas /upload persists the resume and returns an _id (a MongoDB ObjectId) that doubles as the artifact_id for Vector Search (search_type: "resume") and Neural Search (vector.artifact_id). The typical flow is upload → parse → use _id as artifact_id. (The Python SDK’s resumes.upload_and_parse performs the upload and parse in a single step.)

Endpoint

POST /v2/resumes/upload/

Note the trailing slash. POST /v2/resumes/upload (without it) may not route — always call POST /v2/resumes/upload/.

Authentication

x-api-key

string

required

Your Hirebase API key. Required — this is an always-authenticated endpoint, like the other resume endpoints.

Request

Content-Type: multipart/form-data

Note:

The request must include exactly one file.
Supported file types: PDF, DOC/DOCX, plain text, HTML.
Maximum file size: 5 MB.
The uploaded file part must carry a correct Content-Type (e.g., application/pdf, text/plain, text/html, or the DOCX MIME type). Multipart requests that omit it (some HTTP clients default to application/octet-stream) are rejected with 400 File must be PDF or Word document, even for otherwise-valid files. cURL sets this automatically from the file extension.

file

required

The resume file to upload.

Response

_id

string

Resume record id. Use this value as the artifact_id for downstream Vector Search and Neural Search.

user_id

string

Owner of the record (the account associated with your API key).

resume_url

string

Stored file URL for the uploaded resume.

parsed_data

object | null

Structured resume fields. Empty/null until you call Parse Resume; populated afterward.

status

string

Record status. "uploaded" immediately after upload, "parsed" after parsing.

created_at

string

Creation timestamp (ISO 8601).

updated_at

string

Last-updated timestamp (ISO 8601).

Example Request

curl -X POST "https://api.hirebase.org/v2/resumes/upload/" \
  -H "x-api-key: YOUR_API_KEY" \
  -F "file=@/path/to/resume.pdf"

Example Response

{
  "_id": "6a3c15d537f33c238c70a14e",
  "user_id": "6678eefb1d5870366fade012",
  "resume_url": "https://.../resume.pdf",
  "parsed_data": null,
  "status": "uploaded",
  "created_at": "2026-06-24T17:42:08.512Z",
  "updated_at": "2026-06-24T17:42:08.512Z"
}

See Resume-to-Jobs Matching for the end-to-end flow: upload → parse → match jobs with artifact_id.

List Subindustries

Parse Resume

Jobs API

Hiring Manager API

Companies API

Insights API

Reference Data API

Resumes

Tasks API

Error Handling

Upload Resume

Endpoint

Authentication

Request

Response

Example Request

Example Response

​Endpoint

​Authentication

​Request

​Response

​Example Request

​Example Response

Endpoint

Authentication

Request

Response

Example Request

Example Response