GuidesAPI EndpointsAPI Changelog
Live AI Demo
API Endpoints
Live AI Demo

🧠 Parse a Resume in a Source

post
https://api.hrflow.ai/v1/profile/parsing/file

This endpoint allows you to Parse a Resume and create a Profile from it.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

Prerequisites

  1. ✨ Create a Workspace
  2. 🔑 Get your API Key
  3. 🧠 Activate Profile Parsing API
  4. 🔌 Create a Source
  5. 🧠 Parse a Resume
📘

Real-time parsing

To use the real-time parsing feature, you must have HrFlow.ai team enable it for the corresponding source.
Reach out to us to activate real-time parsing

Request headers

❗️

Content-Type : multipart/form-data

The body used in this request must be multipart/form-data encoded.

In cURL, you specify each message part using the -F (or --form) option. To upload a file in a message part, prefix the file name with the @ symbol. For more information on cURL syntax, see the cURL documentation.

FieldValue
Content-Typemultipart/form-data
X-API-KEYYour API Key.
X-USER-EMAILYour HrFlow.ai account's email.
🚧

Document supported extensions

Supported extensions by the Profile Parsing API are .pdf, .png, .jpg, .jpeg, .bmp, .doc, .docx, .odt, .rtf, .odp, ppt, and .pptx .

Body Params
string
required

The key (identifier) of the Source to which the Profile will be added.

file
required

Profile's file resume in binary format

string

Profile's unique identifier, it is used when you want to override an existing Parsing object.

string

Reference to assign as a profile identifier. You can only have a unique Reference value per Source.

string

The file content type (for example: application/pdf)

tags
array of objects

Attach a list of searchable tags to the Profile.

tags
metadatas
array of objects

Attach a list of metadatas to the Profile.

metadatas
labels
array of objects

Attach a list of searchable labels to the Profile.

labels
date

ISO Date Time Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX — for example, "2000-10-31T01:30:00.000-05:00". It associates a creation date to the profile (ie: this can be for example the original date of the application of the profile). If not provided the creation date will be now by default.

boolean
Defaults to false

Turn to 1 to get the raw parsing object.

Responses

Updated 4 months ago

What’s Next

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

What’s Next

Did this page help you?