Skip to main content
POST
/
assessments
Create an assessment
curl --request POST \
  --url https://app.edpire.com/api/v1/assessments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "description": "<string>",
  "type": "quiz",
  "settings": {
    "time_limit_minutes": 2,
    "passing_score_percent": 50,
    "allowed_attempts": 1,
    "shuffle_exercises": true,
    "show_solutions": "never"
  },
  "exercises": [
    {
      "questions": [
        {
          "content_ast": {},
          "answer_keys": [
            {}
          ],
          "points": 1
        }
      ],
      "shared_context": {}
    }
  ]
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "draft"
  },
  "error": {
    "message": "<string>"
  },
  "meta": {}
}

Authorizations

Authorization
string
header
required

API key starting with edp_live_. Pass via Authorization: Bearer edp_live_xxx.

Scopes: read:assessments, write:assessments, read:results, write:submissions.

Body

application/json
title
string
required
Required string length: 1 - 200
description
string
Maximum string length: 2000
type
enum<string>
default:quiz
Available options:
quiz,
exam,
practice
settings
object
exercises
object[]
Minimum array length: 1

Response

Assessment created

data
object
error
object
meta
object