GuidesAPI EndpointsAPI Changelog
Live AI Demo
API Endpoints

💾 Index a Profile in a Source

This endpoint allows you to Index a Profile object.

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. 🔌 Create a Source
🚧

Profile Input

If your Profile is an unstructured document, make sure to parse it first before indexing it. See how in🧠 Parse a Resume in a Source.

Request headers

FieldValue
Content-Typeapplication/json
X-API-KEYYour API Key.
X-USER-EMAILYour HrFlow.ai account's email.
Body Params
string
required

Identification key of the Source attached to the Profile.

profile
object
required

JSON of the Profile object.

Responses

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