Upload an exam question paper

PATCH

evaluation-platform

exam

{id}

cURL

# 1. Upload the question paper (one PDF, or one or more images)
curl -X PATCH \
  https://api.crazygoldfish.com/evaluation-platform/v1/exam/d19e6868-98dd-4274-a2a5-4a616dd93ea7/ \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -F documents=@question-paper.pdf

# 2. Submit it for extraction
curl -X PATCH \
  https://api.crazygoldfish.com/evaluation-platform/v1/exam/d19e6868-98dd-4274-a2a5-4a616dd93ea7/ \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"isFinal": true}'

import requests

BASE_URL = "https://api.crazygoldfish.com"
HEADERS = {"Authorization": "Bearer YOUR_ACCESS_TOKEN"}
exam_url = f"{BASE_URL}/evaluation-platform/v1/exam/d19e6868-98dd-4274-a2a5-4a616dd93ea7/"

# 1. Upload the question paper
with open("question-paper.pdf", "rb") as paper:
    requests.patch(
        exam_url,
        headers=HEADERS,
        files=[
            ("documents", ("paper.pdf", paper, "application/pdf"))
        ],
    ).raise_for_status()

# 2. Submit it for extraction
requests.patch(
    exam_url, headers=HEADERS, json={"isFinal": True}
).raise_for_status()

import { openAsBlob } from "node:fs"; // Node 20 or later

const BASE_URL = "https://api.crazygoldfish.com";
const HEADERS = { Authorization: "Bearer YOUR_ACCESS_TOKEN" };
const examUrl =
  `${BASE_URL}/evaluation-platform/v1/exam/d19e6868-98dd-4274-a2a5-4a616dd93ea7/`;

// 1. Upload the question paper
const form = new FormData();
const paperBlob = await openAsBlob("question-paper.pdf", {
  type: "application/pdf",
});
form.append("documents", paperBlob, "question-paper.pdf");
let response = await fetch(examUrl, {
  method: "PATCH",
  headers: HEADERS,
  body: form,
});
if (!response.ok) throw new Error(await response.text());

// 2. Submit it for extraction
response = await fetch(examUrl, {
  method: "PATCH",
  headers: { ...HEADERS, "Content-Type": "application/json" },
  body: JSON.stringify({ isFinal: true }),
});
if (!response.ok) throw new Error(await response.text());

{
  "id": "d19e6868-98dd-4274-a2a5-4a616dd93ea7",
  "documents": [
    {
      "id": "0f2a7c61-9b48-4d3e-8a15-6c7d8e9f0a1b",
      "status": 0,
      "pageNo": null,
      "uploadTime": "2026-03-18T09:14:02.481293Z",
      "url": "https://<storage-host>/media/evaluation/paper.pdf",
      "fileType": 1
    }
  ]
}

Step 1 of 8 in Evaluate an exam. Call it twice: once to upload, once with isFinal to submit.

Rules

Send exactly one of documents, fileUrl, or isFinal per request.
Files must be .pdf, .jpg, .jpeg, or .png, and at most 20 MB each.
Declare each file’s type in its multipart part: application/pdf, image/jpeg, or image/png. The API reads the part’s Content-Type, not the file name. Most other values are rejected with 400 Invalid file type, but the Word .docx type is not, so do not send one by accident.
A PDF can have at most 50 pages, and an exam takes one PDF. You cannot mix a PDF with images.
Images can arrive across several calls. Each call adds to what is already there.
fileUrl replaces an upload: a public HTTPS link that the API fetches itself. It rejects the link unless the file starts with %PDF, and allows one fileUrl per exam. A link that is not a usable URL returns Invalid URL, a localhost or private network address returns Private or local URLs are not allowed, a link that answers with anything other than 200 or 206 returns URL returned status <n>, and a link that cannot be reached at all returns URL is not reachable.
Send {"isFinal": true} only after every file is uploaded. That starts question extraction and moves the exam to status 1 In Progress.

In a multipart request, any value of isFinal counts as sending it, including isFinal=false. Sending it alongside documents returns 400 Only one of documents, fileUrl, or isFinal can be processed at a time. Leave the field out until you mean it.

Files are only accepted while the exam’s status is 0 Open. If extraction is already running or has failed, the call still returns 200 and quietly ignores the files. Check documents in the response to confirm what was stored.

Reading the response

Response	Meaning	What to do
`200`	Files stored, or extraction started	Check `documents`, then submit or wait
`400` `Exam is already extracted`	The questions are ready	Call Get extracted exam questions
`400` `No documents found for this exam`	You submitted with nothing uploaded	Upload first, then submit
`400` `Rate limit exceeded...`	The daily extraction limit for your API user is reached	Try again after 00:01 server time
`404` `Exam not found`	Unknown or malformed exam ID	Check the `id`

Extraction failed? Send {"isFinal": true} again. Files that failed are sent again, and files that already succeeded are skipped.

Next step

Get extracted exam questions

Wait until the questions are ready, then review them.

Authorizations

Authorization

string

header

required

Access token from Get an access token. A missing, invalid, or expired token returns 403.

Path Parameters

string<uuid>

required

The exam id returned by Create an exam.

Example:

"d19e6868-98dd-4274-a2a5-4a616dd93ea7"

Body

documents

file[]

Question paper files. One .pdf of up to 50 pages, or any number of .jpg and .png images. Up to 20 MB per file. Each part's Content-Type decides the file type, so declare application/pdf, image/jpeg, or image/png. You cannot mix a PDF with images, and only one PDF is allowed per exam.

fileUrl

string<uri>

Public HTTPS link to a PDF, instead of uploading one. The API fetches the link and rejects it unless the body starts with %PDF. One fileUrl per exam, and never alongside uploaded files.

Example:

"https://example.com/papers/science-set-a.pdf"

isFinal

boolean

Send true to submit the uploaded files for question extraction. Send it on its own.

grade

integer

Correct the grade code.

subject

string

Correct the subject. A name, with the same rules as in Create an exam.

examType

string

Correct the kind of exam. A name, with the same rules as in Create an exam.

examSet

string

Correct the paper set label.

examDate

string<date>

Correct the exam date.

classSection

string

Correct the class section. Accepted, but this endpoint does not save it.

Response

The exam was updated. With isFinal=true, extraction has started and the exam's status is now 1 In Progress.

A new exam. documents is empty until you upload the question paper.

string<uuid>

The exam ID. Every later call in the flow needs it.

documents

object[]

Files attached to the exam, oldest first.

Show child attributes

cURL

# 1. Upload the question paper (one PDF, or one or more images)
curl -X PATCH \
  https://api.crazygoldfish.com/evaluation-platform/v1/exam/d19e6868-98dd-4274-a2a5-4a616dd93ea7/ \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -F documents=@question-paper.pdf

# 2. Submit it for extraction
curl -X PATCH \
  https://api.crazygoldfish.com/evaluation-platform/v1/exam/d19e6868-98dd-4274-a2a5-4a616dd93ea7/ \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"isFinal": true}'

import requests

BASE_URL = "https://api.crazygoldfish.com"
HEADERS = {"Authorization": "Bearer YOUR_ACCESS_TOKEN"}
exam_url = f"{BASE_URL}/evaluation-platform/v1/exam/d19e6868-98dd-4274-a2a5-4a616dd93ea7/"

# 1. Upload the question paper
with open("question-paper.pdf", "rb") as paper:
    requests.patch(
        exam_url,
        headers=HEADERS,
        files=[
            ("documents", ("paper.pdf", paper, "application/pdf"))
        ],
    ).raise_for_status()

# 2. Submit it for extraction
requests.patch(
    exam_url, headers=HEADERS, json={"isFinal": True}
).raise_for_status()

import { openAsBlob } from "node:fs"; // Node 20 or later

const BASE_URL = "https://api.crazygoldfish.com";
const HEADERS = { Authorization: "Bearer YOUR_ACCESS_TOKEN" };
const examUrl =
  `${BASE_URL}/evaluation-platform/v1/exam/d19e6868-98dd-4274-a2a5-4a616dd93ea7/`;

// 1. Upload the question paper
const form = new FormData();
const paperBlob = await openAsBlob("question-paper.pdf", {
  type: "application/pdf",
});
form.append("documents", paperBlob, "question-paper.pdf");
let response = await fetch(examUrl, {
  method: "PATCH",
  headers: HEADERS,
  body: form,
});
if (!response.ok) throw new Error(await response.text());

// 2. Submit it for extraction
response = await fetch(examUrl, {
  method: "PATCH",
  headers: { ...HEADERS, "Content-Type": "application/json" },
  body: JSON.stringify({ isFinal: true }),
});
if (!response.ok) throw new Error(await response.text());

{
  "id": "d19e6868-98dd-4274-a2a5-4a616dd93ea7",
  "documents": [
    {
      "id": "0f2a7c61-9b48-4d3e-8a15-6c7d8e9f0a1b",
      "status": 0,
      "pageNo": null,
      "uploadTime": "2026-03-18T09:14:02.481293Z",
      "url": "https://<storage-host>/media/evaluation/paper.pdf",
      "fileType": 1
    }
  ]
}

Get started

Guides

Exam Evaluation

Assignment Evaluation

Rubrics

Action Plans

Lesson Plan Builder

Worksheet Builder

ClassTrack

Metadata

Webhooks

Upload an exam question paper

Rules

Reading the response

Next step

Get extracted exam questions

Authorizations

Path Parameters

Body

Response

​Rules

​Reading the response

​Next step

Get extracted exam questions

Authorizations

Path Parameters

Body

Response

Rules

Reading the response

Next step