Interactive app

A small hands-on learning app built from your lesson, as a self-contained, sandboxed web page.

Price3 credits (30p) per app
Typical time60 s to 5 min
Scopemedia:write
Runs asA background job

Try it

Run interactive app 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.

Aurora Interactive designs one living little world for one idea in the lesson and builds it as plain HTML, CSS and JavaScript that passed EduMark's sandbox checks: no network, storage, cookies or access to the page around it. interactive.zip holds index.html (with a Content-Security-Policy that denies all network access) and manifest.json. Serve it in <iframe sandbox="allow-scripts">; theme it by overriding the CSS variables listed in the manifest; it posts {type: 'edumark-app', event, data} messages for size, score and errors.

Requires media:write. Costs 3 credits per app. 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.

Interactive app

POST/v1/interactives

Scope media:write

Headers

Interactive app: 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

Interactive app: request body
Field	Details
`title`	string, optionalThe lesson's title.Up to 160 characters
`course_title`	string, optionalUp to 160 characters
`focus`	string, optionalThe one idea the app should make hands-on.Up to 200 characters
`source_text`	string, optionalThe lesson material (up to 10,000 words).Up to 60,000 characters
`document`	FileReference or DocumentInput, optionalThe lesson as a PDF, DOCX or TXT.
`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

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/interactives' \
  -H "Authorization: Bearer $EDUMARK_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "title": "Balancing equations",
  "focus": "Why both sides must stay equal",
  "source_text": "An equation is like a balance: whatever you do to one side you must do to the other to keep it level."
}'

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

Finished job: resultJSON

{
  "status": "completed",
  "kind": "interactive",
  "title": "Balance the scale",
  "concept": "Why both sides must stay equal",
  "summary": "Add weights to each side and find what keeps the scale level.",
  "how_to_use": [
    "Add weight to one side.",
    "Make the other side match.",
    "Notice what keeps it balanced."
  ],
  "ideas": [
    {
      "label": "Uneven start",
      "instruction": "Start with one side already heavier."
    }
  ],
  "entry": "index.html",
  "manifest": {
    "format": "edumark-app-bundle",
    "version": 1,
    "kind": "interactive",
    "entry": "index.html",
    "title": "Balance the scale",
    "concept": "Why both sides must stay equal",
    "summary": "Add weights to each side and find what keeps the scale level.",
    "how_to_use": [
      "Add weight to one side.",
      "Make the other side match.",
      "Notice what keeps it balanced."
    ],
    "sandbox": {
      "iframe_sandbox": "allow-scripts",
      "content_security_policy": "default-src 'none'; script-src 'unsafe-inline'; style-src 'unsafe-inline'; img-src data: blob:; font-src data:; media-src data: blob:; connect-src 'none'; frame-src 'none'; form-action 'none'; base-uri 'none'",
      "network": false,
      "storage": false
    },
    "theme": {
      "variables": [
        "--accent",
        "--accent-contrast",
        "--bg",
        "--border",
        "--font",
        "--font-heading",
        "--font-mono",
        "--font-sans",
        "--good",
        "--muted",
        "--space-3",
        "--space-4",
        "--space-4-5",
        "--surface",
        "--text",
        "--warn"
      ],
      "note": "Override the CSS variables on :root to match your product."
    },
    "events": {
      "post_message_type": "edumark-app",
      "events": [
        "score",
        "size",
        "error"
      ]
    },
    "parts": [
      {
        "kind": "style",
        "id": "look",
        "label": "Look",
        "characters": 80
      },
      {
        "kind": "section",
        "id": "scale",
        "label": "Balance scale",
        "characters": 178
      },
      {
        "kind": "script",
        "id": "logic",
        "label": "Logic",
        "characters": 291
      }
    ],
    "provenance": {
      "engine": "edumark_interactive",
      "ai_generated": true,
      "sandbox": true
    }
  },
  "provenance": {
    "engine": "edumark_interactive",
    "ai_generated": true,
    "sandbox": true
  }
}