curl --request POST \
--url https://assess.praxicraft.com/api/v1/public/assessments/create/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"description": "<string>",
"time_limit_minutes": 123,
"passing_score": 123,
"team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pool_mode": true,
"assignment_size": 123,
"shuffle_strategy": "<string>",
"tag_quotas": {},
"pool_settings": {},
"enforce_fullscreen": true,
"copy_paste_disabled": true,
"session_recording_enabled": true,
"screen_recording_enabled": true,
"webcam_recording_enabled": true,
"notify_on_completion": true,
"violation_review_threshold": 123
}
'import requests
url = "https://assess.praxicraft.com/api/v1/public/assessments/create/"
payload = {
"title": "<string>",
"description": "<string>",
"time_limit_minutes": 123,
"passing_score": 123,
"team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pool_mode": True,
"assignment_size": 123,
"shuffle_strategy": "<string>",
"tag_quotas": {},
"pool_settings": {},
"enforce_fullscreen": True,
"copy_paste_disabled": True,
"session_recording_enabled": True,
"screen_recording_enabled": True,
"webcam_recording_enabled": True,
"notify_on_completion": True,
"violation_review_threshold": 123
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
description: '<string>',
time_limit_minutes: 123,
passing_score: 123,
team_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
pool_mode: true,
assignment_size: 123,
shuffle_strategy: '<string>',
tag_quotas: {},
pool_settings: {},
enforce_fullscreen: true,
copy_paste_disabled: true,
session_recording_enabled: true,
screen_recording_enabled: true,
webcam_recording_enabled: true,
notify_on_completion: true,
violation_review_threshold: 123
})
};
fetch('https://assess.praxicraft.com/api/v1/public/assessments/create/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://assess.praxicraft.com/api/v1/public/assessments/create/';
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
description: '<string>',
time_limit_minutes: 123,
passing_score: 123,
team_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
pool_mode: true,
assignment_size: 123,
shuffle_strategy: '<string>',
tag_quotas: {},
pool_settings: {},
enforce_fullscreen: true,
copy_paste_disabled: true,
session_recording_enabled: true,
screen_recording_enabled: true,
webcam_recording_enabled: true,
notify_on_completion: true,
violation_review_threshold: 123
})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://assess.praxicraft.com/api/v1/public/assessments/create/"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"time_limit_minutes\": 123,\n \"passing_score\": 123,\n \"team_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"pool_mode\": true,\n \"assignment_size\": 123,\n \"shuffle_strategy\": \"<string>\",\n \"tag_quotas\": {},\n \"pool_settings\": {},\n \"enforce_fullscreen\": true,\n \"copy_paste_disabled\": true,\n \"session_recording_enabled\": true,\n \"screen_recording_enabled\": true,\n \"webcam_recording_enabled\": true,\n \"notify_on_completion\": true,\n \"violation_review_threshold\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"title": "Senior Backend Engineer Screen",
"slug": "senior-backend-screen",
"description": "A 3-task technical screen.",
"status": "active",
"task_count": 3,
"time_limit_minutes": 90,
"passing_score": 70,
"invitation_count": 12,
"enforce_fullscreen": true,
"copy_paste_disabled": false,
"created_at": "2025-03-01T10:00:00Z",
"updated_at": "2025-03-20T14:30:00Z"
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"message": "Invalid or revoked API Key.",
"code": "INVALID_API_KEY"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}Create assessment
Required scope:
assessments:write
Creates a new assessment in draft status. Attach tasks with POST /assessments/{slug}/tasks/attach/, then set status: active via PATCH /assessments/{slug}/update/ before inviting candidates.
Responses
| Status | Code | When |
|---|---|---|
201 | — | Draft assessment created |
400 | VALIDATION_ERROR | Missing title or invalid fields |
403 | ASSESSMENT_LIMIT_REACHED | Plan assessment quota exhausted |
403 | PLAN_REQUIRED | Recording feature needs a higher plan |
Authentication & rate limits (all endpoints)
| Status | Code | When |
|---|---|---|
401 | INVALID_API_KEY | Missing or invalid bearer token |
401 | EXPIRED_API_KEY | API key past its optional expires_at |
403 | INSUFFICIENT_SCOPE | API key lacks the required scope for this operation |
403 | IP_NOT_ALLOWED | Client IP is outside this key’s CIDR allowlist |
429 | RATE_LIMITED | Rate limit exceeded — plan-tiered reads/writes per organisation per hour |
curl --request POST \
--url https://assess.praxicraft.com/api/v1/public/assessments/create/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"description": "<string>",
"time_limit_minutes": 123,
"passing_score": 123,
"team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pool_mode": true,
"assignment_size": 123,
"shuffle_strategy": "<string>",
"tag_quotas": {},
"pool_settings": {},
"enforce_fullscreen": true,
"copy_paste_disabled": true,
"session_recording_enabled": true,
"screen_recording_enabled": true,
"webcam_recording_enabled": true,
"notify_on_completion": true,
"violation_review_threshold": 123
}
'import requests
url = "https://assess.praxicraft.com/api/v1/public/assessments/create/"
payload = {
"title": "<string>",
"description": "<string>",
"time_limit_minutes": 123,
"passing_score": 123,
"team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pool_mode": True,
"assignment_size": 123,
"shuffle_strategy": "<string>",
"tag_quotas": {},
"pool_settings": {},
"enforce_fullscreen": True,
"copy_paste_disabled": True,
"session_recording_enabled": True,
"screen_recording_enabled": True,
"webcam_recording_enabled": True,
"notify_on_completion": True,
"violation_review_threshold": 123
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
description: '<string>',
time_limit_minutes: 123,
passing_score: 123,
team_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
pool_mode: true,
assignment_size: 123,
shuffle_strategy: '<string>',
tag_quotas: {},
pool_settings: {},
enforce_fullscreen: true,
copy_paste_disabled: true,
session_recording_enabled: true,
screen_recording_enabled: true,
webcam_recording_enabled: true,
notify_on_completion: true,
violation_review_threshold: 123
})
};
fetch('https://assess.praxicraft.com/api/v1/public/assessments/create/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://assess.praxicraft.com/api/v1/public/assessments/create/';
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
description: '<string>',
time_limit_minutes: 123,
passing_score: 123,
team_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
pool_mode: true,
assignment_size: 123,
shuffle_strategy: '<string>',
tag_quotas: {},
pool_settings: {},
enforce_fullscreen: true,
copy_paste_disabled: true,
session_recording_enabled: true,
screen_recording_enabled: true,
webcam_recording_enabled: true,
notify_on_completion: true,
violation_review_threshold: 123
})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://assess.praxicraft.com/api/v1/public/assessments/create/"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"time_limit_minutes\": 123,\n \"passing_score\": 123,\n \"team_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"pool_mode\": true,\n \"assignment_size\": 123,\n \"shuffle_strategy\": \"<string>\",\n \"tag_quotas\": {},\n \"pool_settings\": {},\n \"enforce_fullscreen\": true,\n \"copy_paste_disabled\": true,\n \"session_recording_enabled\": true,\n \"screen_recording_enabled\": true,\n \"webcam_recording_enabled\": true,\n \"notify_on_completion\": true,\n \"violation_review_threshold\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"title": "Senior Backend Engineer Screen",
"slug": "senior-backend-screen",
"description": "A 3-task technical screen.",
"status": "active",
"task_count": 3,
"time_limit_minutes": 90,
"passing_score": 70,
"invitation_count": 12,
"enforce_fullscreen": true,
"copy_paste_disabled": false,
"created_at": "2025-03-01T10:00:00Z",
"updated_at": "2025-03-20T14:30:00Z"
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"message": "Invalid or revoked API Key.",
"code": "INVALID_API_KEY"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}Authorizations
Organisation API key created in Assess → Developer → API Keys. Format: Bearer ct_live_<your-key> (live) or Bearer ct_test_<your-key> (test). Optional per-key CIDR allowlists return 403 IP_NOT_ALLOWED.
Body
11Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
200100^[-a-zA-Z0-9_]+$Show child attributes
Show child attributes
draft, active, archived 0 <= x <= 21474836470 <= x <= 2147483647Each candidate is assigned a random subset of cases from the pool
How many cases each candidate gets (must be <= total cases in assessment)
0 <= x <= 32767How cases are selected from the pool
random, balanced, tag_balanced, tag_difficulty_balanced, track_balanced Per-tag or tag:difficulty counts for tag-balanced strategies, e.g. {"python": 10, "sql": 10} or {"python:easy": 5, "sql:hard": 3}
Advanced pool options: tag_quota_mode, assignment_seed_mode, display_order_mode, mandatory_case_ids, shuffle_display_order
Total proctoring violations at or above this count require org integrity review.
0 <= x <= 32767True for live hiring. False for isolated test-mode assessments.