POSTLive

Analyze profile gaps

Identifies missing evidence, skills, and signals for a target job. Requires a populated profile; check me.profileReadiness first.

/v1/jobs/{jobId}:gap-analysis

Authorization

Credential

oauth_user

Required scopes

profile:readjobs:analyze

Path parameters

jobId

string · required

Implementation note

Fails with `profile_incomplete` when the canonical profile is not ready (every skill would read as a gap) — onboard via `import-create` / `profile-update` first.

Error responses

401Authentication required

No valid credentials were supplied. Attach a Bearer access token and retry.

402Upgrade required

The authenticated user's plan does not include this capability. `feature` names the gated capability, `requiredPlan` the cheapest plan that unlocks it, `currentPlan` the user's plan today, and `upgradeUrl` links to checkout. This is a plan gate, not a transient error — retrying without upgrading fails again; surface `upgradeUrl` to the user instead. Dormant until a plan that grants the feature is active, so a route that documents it may not currently return it.

403Insufficient scope

The token is valid but lacks the OAuth scope (or token kind) this endpoint requires.

404Resource not found

The addressed resource does not exist, or is not visible to the caller.

409Profile incomplete

The canonical career profile is missing required fields for generation; `missingRequired` lists them and `remedy` says how to fix it. Onboard the user first: import an existing resume (import-create → import-apply) or fill the gaps via profile-update / experiences-create, then retry. Check `me.profileReadiness` to detect this before calling.