Syllabus Skills Extraction

Extract skills from course syllabi. Upload PDF files for analysis to identify skills students will develop. Supports asynchronous processing with webhook notifications.

Submit syllabus for skills extraction

post

https://embedded-api.mapademics.com/v1https://embedded-api.testing.mapademics.com/v1

/skills-extraction/syllabus

Submits a syllabus PDF for extraction. Upload the PDF file directly.

This is an asynchronous operation. The response includes a taskId that you can use to poll for status or configure a webhook for completion notification.

Processing Steps:

1. Document parsing and text extraction

2. Course metadata identification

3. Skills identification using MSL taxonomy

4. Proficiency level assignment

5. Confidence scoring and validation

Typical processing time is 30-90 seconds depending on document length.

Supported File Types: PDF only (application/pdf) Maximum File Size: 25MB

Authorizations

primaryApiKey

X-API-KeystringRequired

Primary API key for authentication. Format: pk_live_xxx (production) or pk_test_xxx (testing).

Body

multipart/form-data

filestring · binaryRequired

The syllabus PDF file to process

webhookUrlstring · uriOptional

URL to receive webhook notification when extraction completes. The webhook will receive a POST request with the extraction results.

Example: https://yourapp.com/webhooks/mapademics

metadatastringOptional

JSON string containing optional metadata to attach to this extraction. Example: {"courseCode": "CS101", "term": "Fall 2025"}

Example: {"courseCode": "CS101", "term": "Fall 2025"}

Responses

202

Extraction task created and queued for processing

application/json

400

Invalid request parameters

application/json

401

Missing or invalid API key

application/json

403

Access denied (insufficient permissions or quota exceeded)

application/json

429

Rate limit exceeded

application/json

500

Internal server error

application/json

post

/skills-extraction/syllabus

HTTPcURLJavaScriptPython

POST /v1/skills-extraction/syllabus HTTP/1.1
Host: embedded-api.mapademics.com
X-API-Key: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 138

{
  "file": "binary",
  "webhookUrl": "https://yourapp.com/webhooks/mapademics",
  "metadata": "{\"courseCode\": \"CS101\", \"term\": \"Fall 2025\"}"
}

{
  "object": "text",
  "data": {
    "taskId": "task_def456uvw",
    "syllabusId": "syl_ghi789rst",
    "status": "queued",
    "createdAt": "2025-01-30T12:00:00Z"
  },
  "meta": {
    "requestId": "req_abc123xyz",
    "timestamp": "2025-01-30T12:00:00Z"
  }
}

Check extraction task status

get

https://embedded-api.mapademics.com/v1https://embedded-api.testing.mapademics.com/v1

/skills-extraction/syllabus/tasks/{taskId}

Retrieves the current status of a syllabus extraction task. Poll this endpoint to track progress until status is completed or failed.

Status Values:

• queued - Task is waiting to be processed

• processing - Task is currently being processed

• completed - Extraction finished successfully

• failed - Extraction failed (see error for details)

Authorizations

primaryApiKey

X-API-KeystringRequired

Primary API key for authentication. Format: pk_live_xxx (production) or pk_test_xxx (testing).

Path parameters

taskIdstringRequired

The extraction task ID

Example: task_def456uvw

Responses

200

Task status retrieved

application/json

401

Missing or invalid API key

application/json

403

Access denied (insufficient permissions or quota exceeded)

application/json

404

Resource not found

application/json

429

Rate limit exceeded

application/json

500

Internal server error

application/json

get

/skills-extraction/syllabus/tasks/{taskId}

HTTPcURLJavaScriptPython

GET /v1/skills-extraction/syllabus/tasks/{taskId} HTTP/1.1
Host: embedded-api.mapademics.com
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "object": "extraction_task",
  "data": {
    "taskId": "task_def456uvw",
    "syllabusId": "syl_ghi789rst",
    "status": "processing",
    "progress": {
      "step": 3,
      "totalSteps": 4,
      "stepName": "skills_identification",
      "percentComplete": 75
    },
    "createdAt": "2025-01-30T12:00:00Z",
    "updatedAt": "2025-01-30T12:00:45Z"
  },
  "meta": {
    "requestId": "req_jkl012mno",
    "timestamp": "2025-01-30T12:00:50Z"
  }
}

Get extraction results

get

https://embedded-api.mapademics.com/v1https://embedded-api.testing.mapademics.com/v1

/skills-extraction/syllabus/{syllabusId}

Retrieves the extracted skills and metadata from a processed syllabus. Only available after the extraction task has completed successfully.

Authorizations

primaryApiKey

X-API-KeystringRequired

Primary API key for authentication. Format: pk_live_xxx (production) or pk_test_xxx (testing).

Path parameters

syllabusIdstringRequired

The syllabus ID

Example: syl_ghi789rst

Responses

200

Extraction results retrieved

application/json

401

Missing or invalid API key

application/json

403

Access denied (insufficient permissions or quota exceeded)

application/json

404

Resource not found

application/json

429

Rate limit exceeded

application/json

500

Internal server error

application/json

get

/skills-extraction/syllabus/{syllabusId}

HTTPcURLJavaScriptPython

GET /v1/skills-extraction/syllabus/{syllabusId} HTTP/1.1
Host: embedded-api.mapademics.com
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "object": "syllabus_extraction",
  "data": {
    "syllabusId": "syl_ghi789rst",
    "filename": "CS101-Fall2025-Syllabus.pdf",
    "metadata": {
      "courseCode": "CS101",
      "courseName": "Introduction to Computer Science",
      "term": "Fall 2025",
      "instructor": "Dr. Jane Smith",
      "institution": "State University"
    },
    "skills": [
      {
        "skillId": "msl_skill_0127",
        "skillName": "Software Development",
        "level": 2,
        "mode": "explicit",
        "confidence": 0.95,
        "rationale": "Learning objective: Students will write programs in Python"
      },
      {
        "skillId": "msl_skill_0412",
        "skillName": "Problem Solving",
        "level": 3,
        "mode": "implicit",
        "confidence": 0.85,
        "rationale": "Multiple assignments require algorithmic thinking and debugging"
      }
    ],
    "statistics": {
      "totalSkillsIdentified": 12,
      "explicitSkills": 8,
      "implicitSkills": 4,
      "averageConfidence": 0.88
    },
    "createdAt": "2025-01-30T12:00:00Z",
    "completedAt": "2025-01-30T12:01:15Z"
  },
  "meta": {
    "requestId": "req_vwx678yza",
    "timestamp": "2025-01-30T12:05:00Z"
  }
}