Quick Start

Make your first request to the Mapademics Embedded API in minutes.

This guide helps you make a real request to the Mapademics Embedded API and receive data back in just a few minutes.

By the end, you'll have:

• Authenticated with the API

• Made a successful request

• Received structured skills or labor market data

---

Keys you'll need

All requests to the Embedded API are authenticated using API keys.

You'll use:

• Platform API key — identifies your application

• Customer API key — identifies the end customer (required for most production requests)

Include both keys as HTTP headers:

• Authorization: Bearer <PLATFORM_API_KEY>

• X-Customer-Key: <CUSTOMER_API_KEY>

In test environments, the customer key may not be required. In production, assume the customer key is required unless an endpoint explicitly says otherwise.

If you don't have keys yet, see Authentication.

---

Choose a starting point

Pick the path that matches what you're building:

• Syllabus skills extraction

• Labor market intelligence

---

Syllabus skills extraction

Use this path if you want to analyze academic content (such as syllabi or curricula) and extract structured, normalized skills.

What you'll need

• Platform API key

• Customer API key

• A syllabus file (PDF)

---

Make your first request

Upload a syllabus and extract skills from it.

curl -X POST https://embedded-api.mapademics.com/v1/skills-extraction/syllabus \
  -H "Authorization: Bearer $MAPADEMICS_API_KEY" \
  -H "X-Customer-Key: $MAPADEMICS_CUSTOMER_KEY" \
  -F "[email protected]"

This returns a task ID. Poll for completion, then retrieve the results:

curl https://embedded-api.mapademics.com/v1/skills-extraction/syllabus/syl_abc123 \
  -H "Authorization: Bearer $MAPADEMICS_API_KEY" \
  -H "X-Customer-Key: $MAPADEMICS_CUSTOMER_KEY"

Example response (truncated)

{
  "object": "syllabus_extraction",
  "data": {
    "extractionId": "ext_abc123",
    "skills": [
      {
        "skillId": "msl_skill_0089",
        "level": 3,
        "mode": "implicit"
      },
      {
        "skillId": "msl_skill_0091",
        "level": 2,
        "mode": "explicit"
      }
    ]
  }
}

What you just got

• A list of normalized skills extracted from the syllabus

• Proficiency levels indicating depth of coverage

• Mode indicating whether skills were explicit or inferred

• Stable skill identifiers you can store and reuse

These skills can be embedded directly into your product or used downstream for analysis and reporting.

Next steps

• Go deeper → Syllabus Skills Extraction

• See all endpoints → API Reference

---

Labor market intelligence

Use this path if you want to retrieve workforce data for catalogs, planning tools, or discovery experiences.

What you'll need

• Platform API key

• Customer API key

---

Make your first request

Retrieve occupations and labor market data for a CIP code (educational program classification).

curl -X POST https://embedded-api.mapademics.com/v1/labor-market-intelligence/by-cip \
  -H "Authorization: Bearer $MAPADEMICS_API_KEY" \
  -H "X-Customer-Key: $MAPADEMICS_CUSTOMER_KEY" \
  -H "Content-Type: application/json" \
  -d '{"cipCodes": ["11.0701"]}'

Example response (truncated)

{
  "object": "cip_labor_market",
  "data": {
    "cipCodes": ["11.0701"],
    "matchedOccupations": [
      {
        "name": "Software Developers",
        "socCode": "15-1252",
        "laborMarketData": {
          "medianAnnualSalary": 127260,
          "forecastedEmploymentGrowth": 0.252,
          "demand": {
            "score": 2,
            "factors": ["Rapid Growth", "High Hiring Demand"]
          }
        }
      }
    ]
  }
}

What you just got

• Occupations matched to the educational program

• Salary and employment projections

• Demand scores and outlook factors

• Data suitable for catalogs, dashboards, or planning workflows

Next steps

• Go deeper → Labor Market Intelligence

• See all endpoints → API Reference

---

Common issues

Error	Cause	Fix
401 Unauthorized	Missing or incorrect platform API key	Verify the Authorization header is present and correct
403 Forbidden	Missing or invalid customer API key	Confirm the X-Customer-Key header is included

Production requests require both keys in most cases.

For details, see Authentication.

---

Where to go next

• End-to-end integrations → Use Cases

• Exact request details → API Reference

• How data is structured → Core Concepts