Skip to main content
POST
/
v1
/
installs
/
{installSid}
/
courses
/
{courseSid}
/
exams
Create Exam
curl --request POST \
  --url http://api.dev.smarterproctoring.com/v1/installs/{installSid}/courses/{courseSid}/exams \
  --header 'Content-Type: application/json' \
  --header 'token: <api-key>' \
  --data '
{
  "title": "Midterm Exam 1",
  "type": "Online",
  "useProctorManager": true,
  "requireApproval": false,
  "url": "<string>",
  "enableAppointmentSuggestions": true,
  "examDeliverySystemModule": "canvas",
  "configuration": {
    "instructorAsProctor": [
      {
        "location": "<string>",
        "timeType": "between",
        "startTime": "1970-01-01T00:00:00.000Z",
        "endTime": "<string>",
        "capacity": 123
      }
    ],
    "examOpenDate": "1970-01-01T00:00:00.000Z",
    "examCloseDate": "1970-01-01T00:00:00.000Z",
    "password": "<string>",
    "duration": 123,
    "attempts": 123,
    "requiredSoftware": "<string>",
    "studentNotes": "<string>",
    "permittedBathroomBreak": true,
    "permittedBathroomBreakInformation": "<string>",
    "permittedBlankPaper": true,
    "permittedBlankPaperInformation": "<string>",
    "permittedCalculator": true,
    "permittedCalculatorInformation": "<string>",
    "permittedDictionary": true,
    "permittedDictionaryInformation": "<string>",
    "permittedEarplugs": true,
    "permittedEarplugsInformation": "<string>",
    "permittedFormulaSheet": true,
    "permittedFormulaSheetInformation": "<string>",
    "permittedNotes": true,
    "permittedNotesInformation": "<string>",
    "permittedOtherItems": "<string>",
    "permittedTextbook": true,
    "permittedTextbookInformation": "<string>",
    "permittedWebsites": true,
    "permittedWebsitesInformation": "<string>",
    "proctorNotes": "<string>",
    "proctorTypes": [
      "<string>"
    ],
    "scheduleOpenDate": "1970-01-01T00:00:00.000Z",
    "scheduleCloseDate": "1970-01-01T00:00:00.000Z",
    "apiExamId": "<string>",
    "modalityOptions": {},
    "virtualCalculatorType": "scientific-calc"
  },
  "description": "Covers chapters 1-5",
  "contactUserSid": "US1234567890abcdef1234567890abcdef",
  "isLimitedScope": false,
  "status": "active"
}
'
{
  "sessionStatus": "<string>",
  "sid": "<string>",
  "courseSid": "<string>",
  "applicationInstallSid": "<string>",
  "title": "<string>",
  "bVirtualTitle": "<string>",
  "type": "<string>",
  "description": "<string>",
  "useProctorManager": true,
  "requireApproval": true,
  "enableAppointmentSuggestions": true,
  "url": "<string>",
  "status": "<string>",
  "createdDate": "<string>",
  "editDate": "<string>",
  "contactUserSid": "<string>",
  "examDeliverySystemModule": "<string>",
  "summary": "<string>",
  "pendingApprovals": 123,
  "openSessionEvents": 123,
  "course": "<string>",
  "configuration": "<string>",
  "examSession": "<string>",
  "instructorName": "<string>",
  "courseName": "<string>",
  "totalSessions": 123,
  "needsProctorSessions": 123,
  "scriptName": "<string>",
  "systemName": "<string>",
  "isLimitedScope": true,
  "platformVersion": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://developers.smarterservices.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

token
string
header
required

Path Parameters

installSid
string
required

Unique SID of the application install. Pattern: AI + 32 hex chars.

Pattern: ^AI[a-f0-9]{32}$
Example:

"AI1234567890abcdef1234567890abcdef"

courseSid
string
required

Unique SID of the course. Pattern: CU + 32 hex chars.

Pattern: ^CU[a-f0-9]{32}$
Example:

"CU1234567890abcdef1234567890abcdef"

Body

application/json

Payload for creating a new exam with full configuration.

title
string
required

Display title for the exam.

Example:

"Midterm Exam 1"

type
enum<string>
required

Exam type. Online for web-based exams (requires URL and password), Written for paper-based exams.

Available options:
Online,
Written
Example:

"Online"

useProctorManager
boolean
required

Whether to use the proctor manager for automated proctor assignment.

Example:

true

requireApproval
boolean
required

Whether exam sessions require manual approval before the student can begin.

Example:

false

url
string
required

Exam URL

enableAppointmentSuggestions
boolean
required

Whether to show suggested appointment time slots to students during scheduling.

Example:

true

examDeliverySystemModule
string
required

Exam Delivery System Module

Example:

"canvas"

configuration
object
required
description
string | null

Optional description providing additional details about the exam.

Example:

"Covers chapters 1-5"

contactUserSid
string

SID of the user to contact for exam-related issues. Pattern: US + 32 hex chars.

Pattern: ^US[a-f0-9]{32}$
Example:

"US1234567890abcdef1234567890abcdef"

isLimitedScope
boolean
default:false

When true, the exam is assigned to specific students only. When false, all enrolled students can take the exam.

Example:

false

status
enum<string>
default:active

Status of the exam. active exams are visible to students, draft are in preparation, deleted are soft-deleted.

Available options:
active,
draft,
deleted
Example:

"active"

Response

200 - application/json

Successful

sessionStatus
string | null

Session status

sid
string | null

Exam SID

courseSid
string | null

Course SID

applicationInstallSid
string | null

Application install SID

title
string | null

Exam title

bVirtualTitle
string | null

Virtual title

type
string | null

Exam type

description
string | null

Description

useProctorManager
boolean | null

Use proctor manager

requireApproval
boolean | null

Require approval

enableAppointmentSuggestions
boolean | null

Enable appointment suggestions

url
string | null

Exam URL

status
string | null

Exam status

createdDate
string | null

Created date

editDate
string | null

Last modified date

contactUserSid
string | null

Contact user SID

examDeliverySystemModule
string | null

Exam delivery system module

summary
string | null

Exam summary

pendingApprovals
number | null

Pending approvals count

openSessionEvents
number | null

Open session events count

course
string | null

Course details

configuration
string | null

Exam configuration

examSession
string | null

Exam session

instructorName
string | null

Instructor name

courseName
string | null

Course name

totalSessions
number | null

Total sessions

needsProctorSessions
number | null

Sessions needing proctor

scriptName
string | null

Script name

systemName
string | null

System name

isLimitedScope
boolean | null

Is limited scope

platformVersion
string | null

Platform version