Question Papers

List question papers

Metadata for your organisation's question papers, most recently updated first. The questions themselves are not included.

Courses and subjects are returned as ids — resolve their names once via GET /v1/courses and GET /v1/courses/{course_id}/subjects and keep the mapping.

Paginated by page number — request page=2, page=3 and so on until has_next_page is false. Optionally filter by course, subject or status.

get/v1/question-papers

Request

  • Base URL: https://api.acadine.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.acadine.ai/v1/question-papers
  • Auth: API key in header X-API-Key

Query parameters

course_idstring nullable

Restrict to one course.

subject_idstring nullable

Restrict to one subject.

status'DRAFT' | 'QUEUED' | 'PROCESSING' | 'GENERATED' | 'APPROVED' | 'FAILED'

Lifecycle of a question paper.

Mirrors the internal QuestionPaperStatus one-for-one — a paper being generated moves QUEUED -> PROCESSING -> GENERATED, and APPROVED once a teacher signs it off.

Restrict to one lifecycle status.

pageinteger
sizeinteger

Response

Successful Response

Example response

{
  "question_papers": [
    {
      "id": "QPR_2msnplIgOEXImjfvuihUqhIqNJO",
      "name": "Physics Term 1",
      "parent_ref": "QPR_2msnplIgOEXImjfvuihUqhIqNJO",
      "course_id": "ORG_CRS_2msnplIgOEXImjfvuihUqhIqNJO",
      "subject_id": "ORG_SUB_2msnplIgOEXImjfvuihUqhIqNJO",
      "total_marks": 100,
      "total_questions": 30,
      "created_by": {
        "id": "USR_2msnplIgOEXImjfvuihUqhIqNJO",
        "name": "Anita Sharma"
      },
      "approved_by": {
        "id": "USR_2msnplIgOEXImjfvuihUqhIqNJO",
        "name": "Anita Sharma"
      }
    }
  ],
  "pagination": {
    "page": 1,
    "size": 50,
    "total_count": 137,
    "total_pages": 3
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.