Course imports

A web page or a course file (Moodle, Common Cartridge, Blackboard, SCORM, PDF, Word, GIFT and more) organised into a course you can review.

Price20 credits (£2.00) per import (web page, PDF, Word, SCORM or zip)
Typical time20 s to 10 min
Scopeauthoring:write
Runs asA background job

Try it

Run course imports in the sandbox

No key and nothing to pay. The sandbox returns a realistic example in a couple of seconds; no AI runs and no data is kept.

Queued202 and a job id, straight away
ProcessingPoll, stream or wait for a webhook
SucceededResult and files on the job

Every AI request runs as a background job, so nothing times out.

Import from a public web page (url) or from a course file you uploaded with POST /v1/files (file).

Web pages. EduMark fetches the page safely, follows related lesson pages on the same site, removes menus, adverts and anything unsafe, and organises the teaching content into modules and lessons. The source wording is kept: nothing is invented.

Course files. EduMark reads Moodle backups (.mbz), IMS Common Cartridge and Canvas exports, Blackboard exports, SCORM 1.2 and 2004 packages, IMS content packages, xAPI and cmi5 packages, H5P activities, PDF and Word documents, and GIFT, Aiken, QTI or Moodle XML question files, with the same importers as the EduMark course library. Lessons, quizzes with their questions and answers, and assignments come across as they are, with no AI. The receipt says what was kept, changed or left out. Upload the file first: POST /v1/files, PUT the bytes, then POST /v1/files/{id}/complete and wait for ready. Course files can be up to 2 GiB.

The result is portable JSON. Set save_to_lms to also create an unpublished draft course in EduMark (the key needs courses:write); a saved course keeps its pictures, files and playable SCORM, xAPI and H5P packages.

Requires authoring:write. Costs 20 credits per import (web page, PDF, Word, SCORM or zip). Send a unique Idempotency-Key; reuse it with the identical body when retrying. Returns 202 with a job: poll GET /jobs/{job_id}, stream GET /jobs/{job_id}/events, or use a signed webhook.

Course imports

POST/v1/authoring/course-imports

Scope authoring:write

Headers

Course imports: headers
Field	Details
`Idempotency-Key`	stringRequiredA unique key per new operation; reuse it with the identical body when retrying.
`EduMark-Version`	enumAPI version. Defaults to the latest.One of `2026-10-21`

Request body

Course imports: request body
Field	Details
`url`	string, optionalA public HTTPS page to import, for example a lesson or a course contents page. Related lesson pages on the same site are followed (up to 20 pages). Send `url` or `file`, not both.Up to 2,048 charactersPattern `^https://`
`file`	FileReference, optionalA course file uploaded with `POST /v1/files` (status `ready`): a Moodle backup (.mbz), IMS Common Cartridge or Canvas export (.imscc or .zip), Blackboard export, SCORM 1.2 or 2004, IMS content package, xAPI or cmi5, or H5P zip; a PDF or Word document; or a GIFT, Aiken, QTI or Moodle XML question file. Course files can be up to 2 GiB. Send `url` or `file`, not both.
`file_id`file.file_id	stringRequiredThe id returned by POST /v1/files, after POST /v1/files/{id}/complete reported ready.Pattern `^file_[a-f0-9]{32}$`
`course_focus`	string, optionalWhat the course should concentrate on (web pages only).Up to 500 characters
`intended_audience`	string, optionalWho the course is for (web pages only).Up to 500 characters
`desired_outcomes`	string, optionalWhat learners should be able to do afterwards (web pages only).Up to 500 characters
`title`	string, optionalThe course title. Taken from the page or file when left out.Up to 200 characters
`save_to_lms`	booleanAlso create an unpublished draft course in EduMark (needs the courses:write permission) and return its id.Default `false`

Responses

Status	Meaning
202	Successful Response
400	Request rejected. Inspect error.code and request_id; failed work is not billed.
401	Request rejected. Inspect error.code and request_id; failed work is not billed.
402	Request rejected. Inspect error.code and request_id; failed work is not billed.
403	Request rejected. Inspect error.code and request_id; failed work is not billed.
404	Request rejected. Inspect error.code and request_id; failed work is not billed.
409	Request rejected. Inspect error.code and request_id; failed work is not billed.
410	Request rejected. Inspect error.code and request_id; failed work is not billed.
413	Request rejected. Inspect error.code and request_id; failed work is not billed.
415	Request rejected. Inspect error.code and request_id; failed work is not billed.
422	Validation Error
429	Request rejected. Inspect error.code and request_id; failed work is not billed.
503	Request rejected. Inspect error.code and request_id; failed work is not billed.

Request

curl -X POST 'https://api.edumark.ai/v1/authoring/course-imports' \
  -H "Authorization: Bearer $EDUMARK_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://example.org/biology/photosynthesis",
  "intended_audience": "GCSE Biology students"
}'

# Then poll until the job finishes (wait poll_after_seconds between calls)
curl 'https://api.edumark.ai/v1/jobs/job_01JB7Q8M4X2V9R' \
  -H "Authorization: Bearer $EDUMARK_API_KEY"

Request: Import a course file (upload it with POST /v1/files first)

curl -X POST 'https://api.edumark.ai/v1/authoring/course-imports' \
  -H "Authorization: Bearer $EDUMARK_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "file": {
    "file_id": "file_3f2a9c0b5d7e4a1b8c6d2e0f9a8b7c6d"
  },
  "title": "Photosynthesis",
  "save_to_lms": true
}'

# Then poll until the job finishes (wait poll_after_seconds between calls)
curl 'https://api.edumark.ai/v1/jobs/job_01JB7Q8M4X2V9R' \
  -H "Authorization: Bearer $EDUMARK_API_KEY"

Queued202 and a job id, straight away
ProcessingPoll, stream or wait for a webhook
SucceededResult and files on the job

Every AI request runs as a background job, so nothing times out.

Response 202JSON

{
  "id": "job_0123456789abcdef0123456789abcdef01234567",
  "product": "course_imports",
  "status": "queued",
  "poll_after_seconds": 2,
  "credits": 20,
  "result_available": false
}

Finished job: resultJSON

{
  "status": "needs_review",
  "requires_review": true,
  "course": {
    "title": "Photosynthesis",
    "description": "How plants make their own food from light, water and carbon dioxide, and what limits the rate.",
    "outcomes": [
      "Describe what photosynthesis makes and needs",
      "Explain the role of chlorophyll",
      "Name the factors that limit the rate of photosynthesis"
    ],
    "content": [],
    "modules": [
      {
        "title": "What photosynthesis is",
        "description": "The reaction and where it happens.",
        "content": [],
        "lessons": [
          {
            "title": "The word equation",
            "description": "Reactants and products.",
            "content": [
              {
                "type": "page",
                "title": "The word equation",
                "payload": {
                  "body": "Plants use light energy to turn carbon dioxide and water into glucose and oxygen.\n\n**carbon dioxide + water → glucose + oxygen**"
                }
              }
            ]
          },
          {
            "title": "Inside the chloroplast",
            "description": "Chlorophyll absorbs light.",
            "content": [
              {
                "type": "page",
                "title": "Inside the chloroplast",
                "payload": {
                  "body": "Photosynthesis happens in chloroplasts. Chlorophyll, the green pigment, absorbs mostly red and blue light."
                }
              }
            ]
          }
        ]
      },
      {
        "title": "Limiting factors",
        "description": "What speeds photosynthesis up or slows it down.",
        "content": [],
        "lessons": [
          {
            "title": "Light, carbon dioxide and temperature",
            "description": "Three limiting factors.",
            "content": [
              {
                "type": "page",
                "title": "Three limiting factors",
                "payload": {
                  "body": "The rate is limited by whichever factor is in shortest supply: light intensity, carbon dioxide concentration or temperature."
                }
              }
            ]
          }
        ]
      }
    ],
    "lesson_count": 3,
    "subject": "Biology",
    "level": "GCSE"
  },
  "source": {
    "type": "url",
    "url": "https://example.org/biology/photosynthesis",
    "final_url": "https://example.org/biology/photosynthesis",
    "title": "Photosynthesis",
    "content_sha256": "0000000000000000000000000000000000000000000000000000000000000000",
    "fetched_at": "2026-10-21T09:00:00+00:00",
    "pages": [
      "https://example.org/biology/photosynthesis"
    ]
  },
  "quality": {
    "passed": true,
    "score": 0.92,
    "status": "good",
    "issues": []
  },
  "content_summary": {
    "pages_processed": 1,
    "blocks_included": 14,
    "blocks_excluded": 9
  },
  "lms_draft": null,
  "warnings": [],
  "notice": "This is an AI draft for a person to review. Nothing was published and learners cannot see it.",
  "provenance": {
    "engine": "edumark_course_import",
    "method": "ai",
    "sandbox": true
  }
}

Files and errors

Product errors

COURSE_IMPORT_SOURCE_REQUIREDHTTP 422. Send either a url or a file to import, not both.
COURSE_IMPORT_FILE_UNSUPPORTEDHTTP 422. Course imports take Moodle backups (.mbz), Common Cartridge (.imscc), Blackboard, SCORM, IMS content package, xAPI/cmi5 and H5P zips, PDF and Word documents, and GIFT, Aiken, QTI or Moodle XML question files.
API_FILE_NOT_READYHTTP 409. The file is still being checked. Retry when its status is ready.
PACKAGE_UNRECOGNISEDOn the finished job. We couldn't recognise this file as a course package.
PACKAGE_EMPTYOn the finished job. We read the package but found nothing we could turn into lessons, quizzes or assignments.
COURSE_CONTENT_NOT_FOUNDOn the finished job. We could not find any readable text in this document.