What do you want to do?
Pick a task to see the steps, the code and what it costs. New here? Start with the quickstart: a free sandbox key and your first request in five minutes.
Mark learners’ work
Proposed marks and feedback, and the learner’s file back with margin comments, ready for a marker to approve.
Upload the file
Reserve a file id, PUT the bytes, then complete the upload so it is checked and scanned.
POST /v1/filescurl -X POST 'https://api.edumark.ai/v1/files' \ -H "Authorization: Bearer $EDUMARK_API_KEY" \ -H "Idempotency-Key: $(uuidgen)"Ask for marking
Send the document with your marking guide and feedback style. You get a job straight away.
POST /v1/marking/jobscurl -X POST 'https://api.edumark.ai/v1/marking/jobs' \ -H "Authorization: Bearer $EDUMARK_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d '{ "document": { "file_id": "file_3f9a6c2e8b1d4f7a9c0e5b2d8a6f1c3e" }, "context_text": "Question 1 (6 marks): Explain how photosynthesis stores energy. Award 1 mark each for: chloroplasts, photolysis, oxygen, ATP, Calvin cycle, glucose.", "feedback": { "tone": "supportive_developmental", "length": "standard", "address": "direct" } }'Wait for the result
Poll the job (or listen for the job.completed webhook). The finished job carries the result and any files.
GET /v1/jobs/{job_id}curl 'https://api.edumark.ai/v1/jobs/job_01JB7Q8M4X2V9R' \ -H "Authorization: Bearer $EDUMARK_API_KEY"Download the marked file
marked.docx has the margin comments; feedback.pdf is a one-page summary. A person approves before anything reaches the learner.
GET /v1/jobs/{job_id}/files/{name}curl 'https://api.edumark.ai/v1/jobs/job_01JB7Q8M4X2V9R/files/report.pdf' \ -H "Authorization: Bearer $EDUMARK_API_KEY"
What would a month cost?
Topping up 3,000 credits at once saves £30.00. From 5,000 credits the price drops to 8p a credit. Prices exclude VAT. Sandbox keys are free, and failed jobs are never charged.
- 10pany amount
- 9p1,000+ credits
- 8p5,000+ credits
- 7p20,000+ credits
Guides and reference
- QuickstartMake your first request in five minutes with a free sandbox key.
- Keys and sandboxLive and sandbox keys, personal and organisation keys, scopes, expiry, IP allow-lists and keeping secrets safe.
- Jobs, polling, webhooks and streamingHow long work stays safe: 202 straight away, then poll, listen for a webhook or stream progress.
- WebhooksSigned notices when jobs finish and when things happen in your centre, with retries and replays.
- Files and uploadsUpload a document, recording or course file once, then refer to it by file_id.
- ErrorsOne error shape everywhere, stable codes and what to do about each status.
- Rate limitsRequest limits per key, per-product limits and how to stay inside them.
- Billing and creditsPrepaid API balance, paying with your paid credits, bulk bonus, limits and alerts.
- VersioningDated versions, what can change without notice and how to pin.
- LMS data API: auth and paginationRead and change learners, courses, enrolments and results inside your centre.
- EventsKnow when work arrives, marks are approved, results are released and learners enrol.
- Jobs and filesFollow background jobs, download their files and upload documents.
- MarkingProposed marks and feedback for answers, documents, recordings and workbooks.
- IntegrityOriginality and AI-writing checks with the evidence behind them.
- QuestionsOriginal questions with marking guidance, in the formats other systems import.
- ExtractionAssessment documents turned into structured questions and criteria.
- LearningFlashcards, quizzes, revision sheets, lessons and feedback for learners.
- MediaVideos, slides, interactive apps, games and transcripts.
- AuthoringCourse outlines, full courses, imports, lessons and assignments.
- ReportsFree exports of gradebooks, analytics and released results.
- LMS dataLearners, courses, runs, enrolments, submissions, results and events in your centre.