GuidesAPI EndpointsAPI Changelog
Live AI Demo
API Endpoints

🧠 Vectorize a Text

Generate HR-native, cross-lingual vectors for texts to power SoTA HR-grade ML.

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

Prerequisites

  1. ✨ Create a Workspace Set up your environment in the HrFlow.ai portal.
  2. 🔑 Get your API Key Retrieve your API_KEY from the settings.
  3. 🧠 Activate Text Embedding API Ensure the embedding service is enabled for your plan.

The Embedding API generates high-fidelity vectors for any HR-related text, such as job snippets, profile summaries, or search queries. Pretrained on 1.2B hiring decisions, these encoders allow for deterministic similarity scoring that remains stable across 43+ languages.

Results are deterministic: the same inputs will consistently return the same vectors.

1. Available Algorithms

Choose the right algorithm key based on your use case, data type, and precision needs.

Algorithm KeysUse CaseStatus
embedding-hyperion-4-cross-1024dOptimized for Profile ↔ Job fit scoring using pairwise representation.🟢 Live
embedding-hyperion-3-cross-1024dOptimized for Profile ↔ Job fit scoring using pairwise representation.🟢 Live
embedding-hyperion-2-dual-768dMatching and Retrieval. Represents profiles and jobs in a shared space.🟡 Legacy
embedding-hyperion-2-dual-128dHigh-speed version for large-scale Matching and Retrieval.🟡 Legacy

2. Request headers

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

List of texts to be vectorized. Maximum length is 64.

texts*
string
enum
required
Defaults to embedding-hyperion-2-dual-768d

The unique identifier of the HR-native encoder you wish to use.

Allowed:
Responses

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