GuidesAPI EndpointsAPI Changelog
Live AI Demo
API Endpoints

💾 Index a Job in a Board

This endpoint allows you to Index a Job 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 Board

Job Input

If your Job is an unstructured text, make sure to parse it first before indexing it. See how in🧠 Parse a raw Text.

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 Board attached to the Job.

job
object
required

JSON of the Job object.

Responses

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