Public API v1 — Artifacts
Public API v1 — Artifacts

Build a rubric + screening link from a job description

Extracts a real competency rubric from the job description and mints a reusable candidate-screening link, exactly as the campaign console's scout does for a live req. Every artifact lands under BetterHire's house workspace (this is an outbound-campaign primitive, not a per-customer role), so an API key only needs write access — not an existing organization role or job board.

post/api/public/v1/artifacts

Request

  • Base URL: https://api.thebetterhire.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.thebetterhire.ai/api/public/v1/artifacts
  • Auth: HTTP bearer

Request body

company_namestring required

The hiring company's display name.

role_titlestring required

The role's title.

job_descriptionstring required

Full job description text. Needs enough real content for a competency rubric — a one-line summary will be rejected.

lane'agency' | 'company'

'agency' for a staffing/recruiting firm's own req, 'company' for a direct employer's req.

contact_namestring nullable

Recruiter/decision-maker name, if known.

contact_emailstring nullable

Recruiter/decision-maker email, if known.

countrystring nullable
req_urlstring nullable

Source posting URL — used for dedup, never displayed raw.

company_domainstring nullable

Response

Successful Response

job_role_idstring required
preview_urlstring required

The tracked /i/{token} founder-preview page — rubric plus the forwardable candidate link, this is what an outreach email should carry.

screening_linkstring required

The raw /screen/{token} candidate entry link — one link, one fresh AI interview per candidate who clicks it.

Changes

No recorded changes to this operation across all 1 revision of this API.