Parse a PDF into resume data
curl --request POST \
--url https://hiresweep.com/api/openapi/ai/parse-pdf \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"images": [
"<string>"
]
}
'import requests
url = "https://hiresweep.com/api/openapi/ai/parse-pdf"
payload = { "images": ["<string>"] }
headers = {
"x-api-key": "<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': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({images: ['<string>']})
};
fetch('https://hiresweep.com/api/openapi/ai/parse-pdf', 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://hiresweep.com/api/openapi/ai/parse-pdf",
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([
'images' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <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://hiresweep.com/api/openapi/ai/parse-pdf"
payload := strings.NewReader("{\n \"images\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<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://hiresweep.com/api/openapi/ai/parse-pdf")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"images\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://hiresweep.com/api/openapi/ai/parse-pdf")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"images\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body"<unknown>"{
"defined": true,
"code": "BAD_REQUEST",
"status": 400,
"message": "The AI returned an improperly formatted structure.",
"data": "<unknown>"
}{
"defined": true,
"code": "AI_LIMIT_REACHED",
"status": 402,
"message": "You have used the Hiresweep AI actions in your plan. Upgrade to keep going.",
"data": {
"resetsAt": 123
}
}{
"defined": true,
"code": "IMPORT_TOO_LARGE",
"status": 413,
"message": "The rendered pages exceed the maximum import size.",
"data": "<unknown>"
}{
"defined": true,
"code": "BAD_GATEWAY",
"status": 502,
"message": "The AI provider returned an error or is unreachable.",
"data": "<unknown>"
}AI
Parse a PDF into resume data
Extracts structured resume data from the rendered page images of a PDF. Pages are rendered to base64-encoded PNG images client-side and sent as an array. Runs on Hiresweep AI and uses one AI action. Returns a complete ResumeData object. Requires authentication.
POST
/
ai
/
parse-pdf
Parse a PDF into resume data
curl --request POST \
--url https://hiresweep.com/api/openapi/ai/parse-pdf \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"images": [
"<string>"
]
}
'import requests
url = "https://hiresweep.com/api/openapi/ai/parse-pdf"
payload = { "images": ["<string>"] }
headers = {
"x-api-key": "<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': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({images: ['<string>']})
};
fetch('https://hiresweep.com/api/openapi/ai/parse-pdf', 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://hiresweep.com/api/openapi/ai/parse-pdf",
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([
'images' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <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://hiresweep.com/api/openapi/ai/parse-pdf"
payload := strings.NewReader("{\n \"images\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<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://hiresweep.com/api/openapi/ai/parse-pdf")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"images\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://hiresweep.com/api/openapi/ai/parse-pdf")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"images\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body"<unknown>"{
"defined": true,
"code": "BAD_REQUEST",
"status": 400,
"message": "The AI returned an improperly formatted structure.",
"data": "<unknown>"
}{
"defined": true,
"code": "AI_LIMIT_REACHED",
"status": 402,
"message": "You have used the Hiresweep AI actions in your plan. Upgrade to keep going.",
"data": {
"resetsAt": 123
}
}{
"defined": true,
"code": "IMPORT_TOO_LARGE",
"status": 413,
"message": "The rendered pages exceed the maximum import size.",
"data": "<unknown>"
}{
"defined": true,
"code": "BAD_GATEWAY",
"status": 502,
"message": "The AI provider returned an error or is unreachable.",
"data": "<unknown>"
}Authorizations
An API key from Settings → Developers → API keys in Hiresweep.
Body
application/json
Required array length:
1 - 16 elementsRequired string length:
1 - 8388612Response
The PDF was successfully parsed into structured resume data.
The response is of type any.