SUMMARY.md

Table of contents

• What is HrFlow.ai?
• Why use HrFlow.ai?
• Deploy HrFlow.ai in 8 min
• HrFlow.ai Certification

Getting Started

• API Authentication
• API Calls
  • Postman Collection
  • Javascript SDK
  • Python SDK
  • PHP SDK
• Tutorial Parsing API
• Tutorial Embedding API
  • Build Personalized AI HR models
• Tutorial Revealing API
• Tutorial Searching API
• Tutorial Scoring API
• Tutorial Reasoning API
• Tutorial Workflows
• F.A.Q
  • How to attach a job application to a profile ?
  • Profile unicity ?
  • What are profile tags, and how should I use them ?

API Reference

• Status Codes
• HR Json
  • Profile Objects
    • Profile JSON
    • Parsing JSON
    • Education JSON
    • Experience JSON
    • Attachment JSON
    • Info JSON
  • Job Objects
    • Job JSON
    • Section JSON
    • Range Date JSON
    • Range Float JSON
  • Trait Objects
    • Date JSON
    • Person JSON
    • Location JSON
    • Certification JSON
    • Course JSON
    • Task JSON
    • Skill JSON
    • Language JSON
    • Interest JSON
    • Label JSON
    • Tag JSON
    • Metadata JSON
• Source Endpoints
  • GET: /sources
  • GET: /source
• Board Endpoints
  • GET: /boards
  • GET: /board
• Profile Endpoints
  • POST: /profile/parsing/file
  • GET: /profile/parsing
  • POST: /profile/indexing
  • PUT: /profile/indexing
  • GET: /profile/indexing
  • GET: /profile/indexing/attachment
  • GET: /profile/embedding
  • GET: /profile/revealing
  • GET: /profiles/scoring
  • GET: /profiles/searching
  • GET: /profile/reasoning
• Job Endpoints
  • POST: /job/indexing
  • PUT: /job/indexing
  • GET: /job/indexing
  • GET: /job/parsing
  • GET: /job/revealing
  • GET: /job/embedding
  • GET: /jobs/searching
  • GET: /jobs/scoring
  • GET: /jobs/reasoning
• Document Endpoints
  • POST : /document/parsing
  • POST: /document/revealing
  • POST: /document/embedding
  • POST : /document/linking
• Webhooks
  • Webhook Authentication
  • Webhook Configuration
  • Webhook Events
    • profile.parsing
    • job.parsing

---

• Security
• GDPR & Privacy
• Help Center
• Service Status
• Public Roadmap