platform4 #
platform4 is Alpha School's education data API. Manage people, content, curriculum, assessment results, and learning events through one authenticated REST surface, or integrate through OneRoster 1.2, QTI, CASE, Caliper, Ed-Fi, and CLR. Get a token and make your first call in five minutes with Getting started.
Core API quickstart #
The Core API uses one base URL for Alpha School's domain APIs. The alpha hostname is a routing name for this surface, not a release-quality label.
- Mint a client-credentials token with
$TOKEN_URL,$CLIENT_ID, and$CLIENT_SECRETin Getting started. - Call the People & Orgs API:
curl -fsS -H "Authorization: Bearer $TOKEN" \
"https://alpha.platform4.alphaschool.dev/people-and-orgs/v1/person?limit=1"- Open the People & Orgs API reference and paste the Bearer token into the Authentication panel.
Use a dedicated module host when an education standard defines its own root paths. The integration skill pack provides routing and API context for coding agents.
Choose an API surface #
| Surface | Base URL | Use it for |
|---|---|---|
| Core API | https://alpha.platform4.alphaschool.dev |
Alpha School domain APIs under /<module-kebab>/v1/ |
| Standards integration | https://<module>.platform4.alphaschool.dev |
Standard-native paths for OneRoster, QTI, CASE, Caliper, Ed-Fi, CLR, and related services |
Platform APIs #
| API | Stable slug | Purpose |
|---|---|---|
| People & Orgs | peopleAndOrgs |
People, organizations, enrollments, and calendars |
| Applications | applications |
Application and publisher registry |
| Content | content |
Learning content |
| Curriculum | curriculum |
Curriculum policy |
| Events | events |
Learning events |
| Results | results |
Results, mastery, and XP |
| Analytics | analytics |
Analytics rollups |
Standards integrations and services #
| API | Host | Purpose |
|---|---|---|
| Platform | platform.platform4.alphaschool.dev |
Tenants, idempotency, and audit |
| OneRoster | oneroster.platform4.alphaschool.dev |
OneRoster 1.2 rostering and gradebook |
| Caliper | caliper.platform4.alphaschool.dev |
Caliper Sensor API |
| CASE | case.platform4.alphaschool.dev |
CASE 1.1 competencies |
| QTI | qti.platform4.alphaschool.dev |
QTI assessment content |
| Ed-Fi | edfi.platform4.alphaschool.dev |
Ed-Fi UDM |
| NWEA MAP | nweamap.platform4.alphaschool.dev |
NWEA MAP data |
| CLR & Open Badges | clr.platform4.alphaschool.dev |
CLR 2.0 and Open Badges 3.0 |
| Commerce | commerce.platform4.alphaschool.dev |
Usage events, subscriptions, and billing |
DNS hostnames are lowercase. OpenAPI paths and client artifacts retain camelCase slugs such as peopleAndOrgs.
Support and versioning #
Email platform4@alphaschool.dev for credentials, integration support, or production incidents. There is no public status page or changelog yet.
Breaking changes are communicated by email to registered integration contacts before deployment. The version shown in each OpenAPI document identifies that module's current contract. Formal deprecation windows are not yet published.
platform4 does not impose application-level rate limits. A network-level per-IP throttle of approximately 2,000 requests per five minutes applies. Use bounded concurrency, retry transient failures with backoff, and contact the team before sustained bulk loads. Contract and data-handling terms come from your Alpha School customer agreement.
Next steps #
- Getting started: Mint a token and make your first request.
- API reference: Browse all 16 APIs.
- Client packages: Download generated TypeScript clients and the integration skill pack.
- Architecture: Understand tenancy, authentication, and deployment boundaries.