Core concepts
Candidates, challenges, sessions, evaluation sets, API keys, and webhooks
These building blocks appear in the dashboard. Challenges, candidates, sessions, and organizations map 1:1 to API resources. Evaluation sets are nested on session detail. Webhooks and Api keys are dashboard-only.
| Concept | Meaning |
|---|---|
| Challenge | A published assessment: compute tier, tools, duration, rubric, brief, desktop files, and truth pack. |
| Session | One candidate attempt at a challenge — status, recording, and scores. An optional expires_at closes the lobby link after that time; a session still PENDING then becomes EXPIRED. After the candidate clicks "I am ready", they have 30 minutes to start recording or the session becomes DROPPED_OUT. |
| Candidate | A person linked to your organization (email and optional name). |
| Organization | The account that owns candidates, challenges, sessions, and API keys. |
| Evaluation set | One scoring run of a session: several independent evaluations plus aggregated scores. |
| API key | An organization credential (sk_skillflare_...) sent as x-api-key. |
| Webhook | An HTTPS endpoint that receives POSTs when session or evaluation-set events occur. |
Typical flow
- Create a challenge from a job description.
- Create or link a candidate with an email address.
- Create a session against a READY challenge. Set
expires_atwhen the lobby link should stop working. - Candidate clicks "I am ready" via their invite link. Recording must start within 30 minutes, or the session becomes
DROPPED_OUTand is not evaluated. - Fetch the session until
session_statusisCOMPLETED,FAILED,DROPPED_OUT, orEXPIRED.