Changelog

All notable changes to the Mapademics Embedded API will be documented here.

[1.0.0] - Initial Release

Added

• Labor Market Intelligence API

  • POST /v1/labor-market-intelligence/by-cip - Get matched occupations by CIP codes

  • POST /v1/labor-market-intelligence/by-soc - Get occupation data by SOC codes

  • GET /v1/labor-market-intelligence/regions - List available regions

• Syllabus Skills Extraction API

  • POST /v1/skills-extraction/syllabus - Submit syllabus PDF for extraction

  • GET /v1/skills-extraction/syllabus/tasks/{taskId} - Check task status

  • GET /v1/skills-extraction/syllabus/{syllabusId} - Get extraction results

• Skills Library API

  • GET /v1/skills - List all skills

  • GET /v1/skills/{skillId} - Get skill details

  • GET /v1/skills/search - Search skills

  • GET /v1/skills/domains - List all domains

  • GET /v1/skills/domains/{domainId} - Get domain with skills

  • GET /v1/skills/tree - Get complete skill hierarchy

• Authentication

  • Primary API keys (pk_live_xxx, pk_test_xxx)

  • Optional end-customer scoping with end-customer keys (ck_xxx)

• Webhook Support

  • syllabus_extraction.completed event

  • syllabus_extraction.failed event

---

Versioning Policy

The API uses path-based versioning (e.g., /v1). We maintain backward compatibility within major versions.

Breaking Changes

Breaking changes are:

1. Announced at least 6 months in advance

2. Released as a new major version (e.g., /v2)

3. Documented in this changelog

What Constitutes a Breaking Change

• Removing an endpoint

• Removing a required field from responses

• Changing the type of an existing field

• Adding a new required field to requests

• Changing authentication requirements

Non-Breaking Changes

These changes may be made without a new version:

• Adding new endpoints

• Adding optional fields to requests

• Adding new fields to responses

• Adding new error codes

• Improving error messages