Creating Assessments
Via the dashboard
- Go to Assessments → New Assessment
- Enter a title, optional description, and optional time limit
- Click Create — the assessment starts in DRAFT status
- Add stages using + Add Stage
- Configure each stage (questions, prompts, AI settings)
- Click Publish to make it live
- Share the assessment link or invite candidates by email
Via the API
POST /v1/assessments
Authorization: Bearer <token>
Content-Type: application/json
{
"title": "Senior Frontend Engineer",
"description": "A 3-stage technical assessment",
"timeLimitMinutes": 90,
"passingScore": 70
}
// Add a stage
POST /v1/assessments/:id/stages
{
"type": "MCQ",
"title": "JavaScript Fundamentals",
"order": 1,
"config": {
"questions": [
{
"text": "What does 'use strict' do?",
"options": ["Enables strict mode", "Imports a module", "Declares a variable", "Throws an error"],
"correctIndex": 0,
"points": 1
}
]
}
}
// Publish
POST /v1/assessments/:id/publishSharing an assessment
Once published, the assessment is accessible at:
https://assessment.yourdomain.com/a/{assessmentSlug}You can also invite specific candidates by email:
POST /v1/candidates/:assessmentId/invite
{
"name": "Jane Smith",
"email": "jane@example.com"
}
// Candidate receives an email with a unique, one-time access linkDuplicating an assessment
Clone an existing assessment with all its stages:
POST /v1/assessments/:id/duplicateOr use Duplicate from the assessment's action menu in the dashboard.
Reordering stages
POST /v1/assessments/:id/reorder-stages
{
"stageIds": ["stage_c", "stage_a", "stage_b"]
}
// Stages will be shown in the given orderAssessment limits
- FREE plan — maximum 3 published assessments at a time. Archived assessments do not count toward the limit.
- PRO plan — no limit.