Skip to main content
POST
Parse Resume
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

Authentication

x-api-key
string
required
Your Hirebase API key. Required — this is an always-authenticated endpoint.

Path Parameters

resume_id
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.
_id
string
Resume record id (use this value as the artifact_id downstream).
user_id
string
Owner of the record.
resume_url
string
Stored file URL.
parsed_data
object
Structured resume fields. Same shape as the resume object on Embed Resume.
status
string
Now "parsed".
created_at
string
Creation timestamp (ISO 8601).
updated_at
string
Last-updated timestamp (ISO 8601).

Example Request

Example Response