Syllabus Skills Extraction

This guide is coming soon. Check back for detailed documentation on the Syllabus Skills Extraction API.

Overview

The Syllabus Skills Extraction API analyzes course syllabi to identify the skills that students will develop.

Quick Reference

Endpoints

Endpoint	Description
POST /v1/skills-extraction/syllabus	Submit syllabus PDF for extraction
GET /v1/skills-extraction/syllabus/tasks/{taskId}	Check extraction task status
GET /v1/skills-extraction/syllabus/{syllabusId}	Get extraction results

Upload Flow

1. Submit PDF - POST /syllabus with PDF file

2. Poll for completion - GET /tasks/{taskId} until status is completed

3. Get results - GET /syllabus/{syllabusId}

Example: Submit a Syllabus

# Step 1: Submit PDF for extraction
curl -X POST "https://embedded-api.mapademics.com/v1/skills-extraction/syllabus" \
  -H "X-API-Key: pk_live_xxx" \
  -H "X-End-Customer-API-Key: ck_xxx" \
  -H "Content-Type: multipart/form-data" \
  -F "[email protected]"

# Step 2: Poll for completion (use taskId from response)
curl -X GET "https://embedded-api.mapademics.com/v1/skills-extraction/syllabus/tasks/task_xxx" \
  -H "X-API-Key: pk_live_xxx" \
  -H "X-End-Customer-API-Key: ck_xxx"

# Step 3: Get results (use syllabusId from task response)
curl -X GET "https://embedded-api.mapademics.com/v1/skills-extraction/syllabus/syl_xxx" \
  -H "X-API-Key: pk_live_xxx" \
  -H "X-End-Customer-API-Key: ck_xxx"

Topics Covered (Coming Soon)

• Complete upload-to-results flow with code examples

• Understanding extraction task status

• Interpreting extracted skills and confidence scores

• Working with explicit vs implicit skills

• Best practices for document preparation