Workforce Intelligence API

Avelin’s API is the developer destination for workforce decision support. Use it after the conceptual model on the Workforce Decision Layer.

The current API contract is documented for Runtime and platform endpoints, and outputs are decision-support oriented: explanation, confidence, uncertainty, review guidance, and provenance-aware traceability.

Use the API when you need machine-readable capability outputs for hiring intake, workforce planning, role calibration, and governed review pipelines.

Link to implementation flow

If you are first deciding where this fits in Avelin, start with the Decision Layer page.
If you are implementing authentication, quotas, and runtime key flows, start at Getting Started.
For applied decision patterns, read Evidence-Based Workforce Decisions.

Overview

The public endpoint base for Runtime requests is:

https://api.avelinlabs.com

Avelin follows a single-source API model: shared workforce intelligence, optional customer context via Customer Grounding, and structured decision outputs.

Identity and onboarding

POST /api/v1/platform/register
GET /api/v1/platform/verify-email?token=...
POST /api/v1/platform/login
POST /api/v1/platform/api-keys/create

Platform management uses a separate bearer token from Runtime API Keys used on product endpoints.

Endpoint groups (current verified surface)

Job Intelligence

POST /api/v1/job/analyze
- Ranked occupation candidates,
- skill evidence,
- ambiguity and weak-signal fields,
- confidence and uncertainty signals,
- explanations and review guidance.
- Read job analysis reference
POST /api/v1/job/classify
- Top occupation alignment for job text,
- structured decision-support fields.
- Read job classification reference

Occupation Intelligence

POST /api/v1/occupation/candidates
GET /api/v1/occupation/{onet_code}
GET /api/v1/occupation/profile/{onet_code}

Returns the deterministic O*NET 30.3 hybrid candidate shortlist, its exact lexical fallback when governed semantic resources are unavailable, detailed occupation metadata, and related structured intelligence. Candidate search always keeps mapping_selected=false; rank 1 is not a classification or official mapping. See Occupation API.

Market Intelligence

GET /api/v1/market/top
GET /api/v1/market/overview

Labor-market context used for role and skill interpretation. See Market API.

Customer Grounding

Customer Grounding lets you add tenant-scoped sources and request grounded role analysis where your contract includes it.

GET /api/v1/grounding/capabilities
POST /api/v1/grounding/sources
POST /api/v1/grounding/sources/{source_id}/ingest-text
POST /api/v1/grounding/sources/{source_id}/ingest-file
POST /api/v1/grounding/role-intelligence/reports
GET /api/v1/grounding/traces/{trace_id}

See Customer Grounding.

Operational integration

MCP

Avelin supports customer-operated MCP adapter usage over authenticated Runtime API flows. MCP does not replace the product semantics.

Examples and interpretation

Public executable examples remain in the AvelinLabs API examples repository.

Use API examples and output interpretation guidance to integrate outputs safely.

Readiness and errors

GET /health/ready remains unauthenticated for public readiness checks.

Standard response errors remain public and include a detail field and request metadata.

See health and response fields for field-level usage and metrics guidance.

Practical limits and scope

O*NET is the current occupational foundation.
The current phase supports free-tier self-service beta with documented contracts, quotas, and customer-grounding limits.
Avelin does not claim placement automation, hiring decisions, or ATS-like execution.