API reference
REST endpoints,
webhooks, and events.
Every action in InferOwl is reachable via the same API the web app uses. JWT-authenticated, tenant-scoped, idempotent where it matters.
The API runs at https://api.inferowl.com/v1 and authenticates via Authorization: Bearer <jwt>. All responses are JSON; all dates are ISO-8601 UTC.
Endpoint overview
| Method | Path | Summary |
|---|---|---|
| GET | /api/v1/candidates | List candidates · paginated · filterable |
| POST | /api/v1/candidates | Create / upsert a candidate |
| GET | /api/v1/candidates/:id/match | Match candidate against open jobs |
| POST | /api/v1/jobs | Create a job posting · triggers embeddings |
| GET | /api/v1/jobs/:id/shortlist | Top-N matched candidates for a job |
| POST | /api/v1/calls/:id/transcribe | Trigger transcription for a Plivo recording |
| GET | /api/v1/pipeline/stages | List stages for a pipeline |
| POST | /api/v1/wallet/topup | Top up the tenant wallet via Razorpay |
| POST | /api/v1/webhooks/:event | Inbound webhook receiver (Plivo / Razorpay) |
Full request/response schemas land in the deep-dive docs as the API stabilises in private pilot. Email dev@inferowl.com for an early-access key.