Skip to content

API Reference

HireMinds exposes a REST API powered by FastAPI.

Base URL

/api/v1

Authentication

Requires a Supabase JWT sent in the Authorization: Bearer <token> header.

Core Endpoints

Auth

  • POST /auth/register - Create account.
  • POST /auth/login - Authenticate.
  • GET /auth/me - Get current user profile.
  • POST /auth/sync - Sync OAuth roles.

Jobs

  • GET /jobs - List jobs.
  • POST /jobs - Create job (Recruiter).
  • GET /jobs/{id} - Job details.
  • GET /jobs/public-by-id/{id} - Unauthenticated public view.

Applications

  • GET /applications/my - Candidate's own applications.
  • POST /public-applications - Unauthenticated job apply (resume upload).
  • PATCH /applications/{id}/status - Update pipeline state.

Interviews

  • GET /interviews/{id} - Retrieve session.
  • POST /interviews/{id}/start - Begin interview state.
  • POST /interviews/{id}/end - Manual termination.
  • POST /interviews/{id}/schedule - Schedule calendar slot.

WebSocket

  • WS /ws/{session_id} - Real-time signaling, transcript delivery, and connection management.