API guide
Career Match API
Career Match API returns bucketed recommendations with structured explanations.
Path: /api/v1/career-match
Format: AI-first docs
Info
Contract-backed page
This page is generated from the current OpenAPI contract summary so docs stay aligned with the formal API surface.
GET /api/v1/career-match
Get career matches
Experimental endpoint. Returns bucketed career matches, constraints, and explanation keys with optional localized text.
Required scopes
read:career_match
Request
- query (query):
- location (query):
Responses
- 200: OK
- 401:
- 403:
- 404:
- 429:
- 500:
Errors
none documented
Examples
Code sample (curl)
1
curl "https://api.profileclaw.com/api/v1/career-match?query=data%20scientist&location=China" -H "Authorization: Bearer $PROFILECLAW_API_KEY"Related surfaces
Use these surfaces when you need deeper inspection or automation.
