📘
Prerequisites

✨ Create a Workspace Set up your environment in the HrFlow.ai portal.

🔑 Get your API Key Retrieve your API_KEY from the settings.

🧠 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 Keys	Use Case	Status
`embedding-hyperion-1-jobs-1024d`	Best for Job ↔ Job similarity and clustering based on role context.	🟢 Live
`embedding-hyperion-1-jobs-128d`	High-speed version for large-scale clustering and deduplication.	🟢 Live
`embedding-hyperion-1-profiles-1024d`	Best for Profile ↔ Profile similarity. Captures end-to-end work experience.	🟢 Live
`embedding-hyperion-1-profiles-128d`	High-speed version for large-scale clustering and deduplication.	🟢 Live
`embedding-hyperion-1-dual-1024d`	Matching and Retrieval. Represents jobs and profiles in a shared space.	🟢 Live
`embedding-hyperion-1-cross-1024d`	Optimized for Profile ↔ Job fit scoring using pairwise representation.	⚪ Coming Soon

2. Request headers

Field	Value
`Content-Type`	`application/json`
`X-API-KEY`	Your API Key.
`X-USER-EMAIL`	Your HrFlow.ai account's email.

200200

400400