How it works

  YOUR PLATFORM                                        AIDE AI
  -------------                                        -------
  1  Upload the question paper and
     marking scheme                           ──▶   POST /v1/files
  2  Create a paper                           ──▶   POST /v1/papers               status: processing
                                              ◀──   webhook paper.awaiting_review questions, marks and
                                                                                  answer keys are read
  3  Check the paper and approve it           ──▶   review link, or
                                                    POST /v1/papers/{id}/approve
                                              ◀──   webhook paper.ready           status: ready
  4  Upload a student's answer script         ──▶   POST /v1/files
  5  Create a submission                      ──▶   POST /v1/submissions          status: queued
                                              ◀──   webhook submission.released   marks are final
  6  Fetch marks, feedback and the report     ──▶   GET  /v1/submissions/{id}/result
                                                    GET  /v1/submissions/{id}/report

Create a paper once per test and reuse it for every student who sits that test. Steps 4 to 6 repeat for each student.

Two checks by people are built in:

• Paper approval (always). No script is marked until the paper is approved. A reviewer on your side can check what we read, correct any question, mark or answer key in our editor through a review link, and approve it there. Your code can also approve it through the API.
• Results review (optional). By default a result is final as soon as the script is marked. If you create the paper with "results_release": "after_review", results wait until a reviewer checks them and releases them. See Releasing results.

Object	What it is	ID prefix
File	A document you upload: a question paper, a marking scheme or an answer script.	file_
Subject	A subject and exam board we mark, such as IGCSE Physics. Every paper has one.	subj_
Paper	A question paper and its marking scheme, read into questions with marks.	pap_
Submission	One student’s answer script for one paper, and its marking.	sub_
Result	The marks and feedback for a marked submission, question by question.	(part of a submission)
Report	A PDF report of the marked script, ready to give to the student.	(part of a submission)
Event	A record that something changed, delivered to your webhook.	evt_
Credit transaction	One movement of credits: a top-up, a charge or an adjustment.	ctx_