Course outlines

A course outline (modules, lessons, quizzes and outcomes) drafted from a brief, your text or a document.

Price5 credits (50p) per draft
Typical time15 s to 2 min
Scopeauthoring:write
Runs asA background job

Try it

Run course outlines 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.

Send one of prompt, text or document. The result is portable JSON: a title, summary, learning outcomes and modules, each with lessons of kind lesson (with a first draft of the lesson text), quiz or assignment. Set save_to_lms to also create an unpublished draft course in EduMark as the person who created the key (the key needs courses:write); the result then includes lms_draft.course_id. Outlines are drafts for a person to review.

Requires authoring:write. Costs 5 credits per draft. 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 outlines

POST/v1/authoring/course-outlines

Scope authoring:write

Headers

Course outlines: 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 outlines: request body
Field	Details
`prompt`	string, optionalA brief for the course, for example "A six-week introduction to first aid for warehouse staff".Up to 4,000 characters
`text`	string, optionalYour own course material (at most 10,000 words). The outline follows it.Up to 120,000 characters
`document`	FileReference or DocumentInput, optionalA PDF, DOCX or TXT to outline: `{"file_id"}` from POST /v1/files, or inline base64.
`file_id`document.file_id	stringRequiredThe id returned by POST /v1/files, after POST /v1/files/{id}/complete reported ready.When sending FileReferencePattern `^file_[a-f0-9]{32}$`
`filename`document.filename	stringRequiredWhen sending DocumentInputUp to 200 characters
`base64`document.base64	stringRequiredWhen sending DocumentInputUp to 27,962,028 characters
`mime_type`document.mime_type	string, optionalWhen sending DocumentInputUp to 150 characters
`title`	string, optionalThe course title. Suggested from your brief when left out.Up to 200 characters
`audience`	string, optionalWho the course is for, for example "New care workers".Up to 500 characters
`goal`	string, optionalWhat a learner should be able to do after the course.Up to 2,000 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-outlines' \
  -H "Authorization: Bearer $EDUMARK_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "prompt": "First aid at work. A short course for warehouse staff on staying safe and helping an unresponsive casualty.",
  "audience": "Warehouse staff",
  "goal": "Help a casualty safely until help arrives"
}'

# 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_outlines",
  "status": "queued",
  "poll_after_seconds": 2,
  "credits": 5,
  "result_available": false
}

Finished job: resultJSON

{
  "status": "needs_review",
  "requires_review": true,
  "outline": {
    "title": "First aid at work",
    "summary": "A practical first aid course for warehouse staff: how to stay safe, assess a casualty and give the right help until professionals arrive.",
    "outcomes": [
      "Assess a scene for danger before helping",
      "Check a casualty's response and breathing",
      "Place an unresponsive, breathing casualty in the recovery position",
      "Know when and how to call for help"
    ],
    "modules": [
      {
        "title": "Staying safe and assessing the scene",
        "description": "Danger first: protect yourself and others.",
        "lessons": [
          {
            "title": "Check for danger before you help",
            "kind": "lesson",
            "summary": "Why your safety comes first.",
            "body": "Before you go to someone who is hurt, stop and look around. Check for moving vehicles, spilled liquids, falling stock or live electricity. If it is not safe, keep back and call for help."
          },
          {
            "title": "Call for help the right way",
            "kind": "lesson",
            "summary": "What to say when you call 999 or 112.",
            "body": "Say where you are, what happened and how many people are hurt. Stay on the line."
          },
          {
            "title": "Scene safety check",
            "kind": "quiz",
            "summary": "Five quick questions on scene safety.",
            "body": ""
          }
        ]
      },
      {
        "title": "Helping an unresponsive casualty",
        "description": "Response, airway and breathing.",
        "lessons": [
          {
            "title": "Check for a response",
            "kind": "lesson",
            "summary": "Talk, then gently tap the shoulders.",
            "body": "Kneel beside the person. Ask loudly, \"Can you hear me?\" and gently tap their shoulders."
          },
          {
            "title": "Put someone in the recovery position",
            "kind": "lesson",
            "summary": "Step by step.",
            "body": "If they are breathing but not responding, roll them onto their side so their airway stays open."
          },
          {
            "title": "Practise a casualty check",
            "kind": "assignment",
            "summary": "A short observed practical.",
            "body": ""
          }
        ]
      }
    ],
    "lesson_count": 6
  },
  "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_outline",
    "method": "ai",
    "source": "prompt",
    "sandbox": true
  }
}