API reference/Artifact creation/Artifacts

GETLive

List artifacts

Lists generated resumes, cover letters, bios, and recruiter briefs.

/v1/artifacts

Authorization

Credential

oauth_user

Required scopes

artifacts:read

Implementation note

Cursor-paginated: ?limit= (default 50, max 200), ?cursor= (opaque, from nextCursor), ?updatedAt.gt= (epoch ms or ISO) delta filter. ?kind=resume|cover-letter|bio|recruiter-brief and ?jobId= filter by artifact kind and linked job.

Error responses

400Invalid request

The request body was missing, malformed, or failed schema validation. Field-level problems are listed under `issues`.

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.