Skip to main content
Promptster uses two authentication methods depending on the actor making the request.

Reviewer authentication

Used for all hiring team and reviewer operations — managing assessments, listing sessions, and reviewing candidates. Obtain your API token from the Promptster dashboard under Settings → API Keys. Pass it as a Bearer token in the Authorization header:
Reviewer tokens are scoped to your organization. You can only access assessments, sessions, and candidates that belong to your org.
For programmatic integrations (scripts, CI), use a dedicated API key rather than a personal session token.

Candidate authentication (API Key)

Candidates authenticate via their candidate key (PST-XXXX-XXXX), which the Promptster CLI uses automatically. If you are building custom integrations that send events on behalf of candidates, pass the key in the X-API-Key header:
A candidate key must be active and not expired to be accepted. Keys are validated on every request.

Base URL

Error responses