Start with one contract surface, then branch by job
This page groups the public API by builder intent so teams can move from auth and context into profile, planning, and operations without guessing where each endpoint belongs.
Recommended order: auth, context, then task-specific endpoints
Most integrations do not need every endpoint on day one. Validate the key, pull aggregated context, then move into planning, health, or webhook flows when the workflow proves it.
Start with stable integration primitives
These routes define identity, default reads, and failure posture.
Authentication
Headers, scopes, and onboarding posture.
Context API
Default aggregated entrypoint for most agents and apps.
Errors
Machine-readable error handling and recovery posture.
Structured profile surfaces
Use these routes when you need more than the default compact context envelope.
Profile API
Normalized profile and identity layer.
Career Graph API
Full structured graph for recommendations and explanation.
Assessments API
Assessment signals and latest results.
Career Context API
Compact dynamic context for query-specific reads.
Planning and recommendation endpoints
These routes support forward-looking reasoning and discovery use cases.
Career Prediction API
Forecast likely role transitions and path probabilities.
Career Reasoning API
Run deeper analysis over the user’s profile and memory.
Similar Paths API
Find anonymized career paths that look like the current user.
Career Match API
Inspect bucketed matches and explanation factors.
Eventing, health, and user controls
Use these routes when your integration needs updates, risk signals, or preference management.
Alerts API
List and act on career alerts.
Career Health API
Read health metrics, trends, and recommendations.
Data Sharing API
Read or update sharing preferences and user controls.
Webhooks API
Manage subscriptions for event-driven sync.