Parse Resume

curl --request POST \
  --url https://api.hirebase.org/v2/resumes/{resume_id}/parse \
  --header 'x-api-key: <x-api-key>'

const options = {method: 'POST', headers: {'x-api-key': '<x-api-key>'}};

fetch('https://api.hirebase.org/v2/resumes/{resume_id}/parse', 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/{resume_id}/parse",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hirebase.org/v2/resumes/{resume_id}/parse"

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

	req.Header.Add("x-api-key", "<x-api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.hirebase.org/v2/resumes/{resume_id}/parse")

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>'

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

{resume_id}

parse

Parse Resume

curl --request POST \
  --url https://api.hirebase.org/v2/resumes/{resume_id}/parse \
  --header 'x-api-key: <x-api-key>'

const options = {method: 'POST', headers: {'x-api-key': '<x-api-key>'}};

fetch('https://api.hirebase.org/v2/resumes/{resume_id}/parse', 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/{resume_id}/parse",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hirebase.org/v2/resumes/{resume_id}/parse"

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

	req.Header.Add("x-api-key", "<x-api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.hirebase.org/v2/resumes/{resume_id}/parse")

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>'

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>"
}

Parse a resume you’ve already stored via Upload Resume. Parsing extracts structured fields (personal info, experience, skills, etc.) and writes them onto the resume record, flipping its status to "parsed". 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/{resume_id}/parse

Authentication

string

required

Your Hirebase API key. Required — this is an always-authenticated endpoint.

Path Parameters

string

required

The _id returned by Upload Resume.

Request

No request body is required.

Response

Returns the same resume record as Upload Resume, now with status: "parsed" and parsed_data populated. The parsed structure matches the resume object documented on the Embed Resume page.

string

Resume record id (use this value as the artifact_id downstream).

string

Owner of the record.

string

Stored file URL.

object

Structured resume fields. Same shape as the resume object on Embed Resume.

string

Now "parsed".

string

Creation timestamp (ISO 8601).

string

Last-updated timestamp (ISO 8601).

Example Request

curl -X POST "https://api.hirebase.org/v2/resumes/6a3c15d537f33c238c70a14e/parse" \
  -H "x-api-key: YOUR_API_KEY"

Example Response

{
  "_id": "6a3c15d537f33c238c70a14e",
  "user_id": "6678eefb1d5870366fade012",
  "resume_url": "https://.../resume.pdf",
  "parsed_data": {
    "personal_information": { "data": { "full_name": "Jane Doe", "email": "jane@example.com" } },
    "skills": [{ "category": "Programming", "skills": ["Python", "Go"] }]
  },
  "status": "parsed",
  "created_at": "2026-06-24T17:42:08.512Z",
  "updated_at": "2026-06-24T17:43:10.004Z"
}

Jobs API

Expired Jobs API

Hiring Manager API

Companies API

Insights API

Salary Benchmark API

Reference Data API

Resumes

Tasks API

Billing & Usage

Error Handling

Parse Resume

Endpoint

Authentication

Path Parameters

Request

Response

Example Request

Example Response

​Endpoint

​Authentication

​Path Parameters

​Request

​Response

​Example Request

​Example Response

Endpoint

Authentication

Path Parameters

Request

Response

Example Request

Example Response