Getting Started with Plum APIs

Welcome to Plum's API documentation. Here you'll find everything you need to start building education solutions.

Quick Start

bash

npm install @plum/sdk
# or
yarn add @plum/sdk

Authentication

All API requests require authentication using your API key.

javascript

const plum = require('@plum/sdk');

const client = new plum.Client({
  apiKey: process.env.PLUM_API_KEY
});

Making Your First Request

javascript

// Create a new lesson
const lesson = await client.lessons.create({
  title: "Introduction to APIs",
  type: "interactive",
  duration: "45min",
  objectives: [
    "Understanding RESTful APIs",
    "Making HTTP requests",
    "Handling responses"
  ]
});

API Reference

GET /v1/lessons

Retrieve a list of lessons

Query Parameters

limit - Number of records to return
offset - Number of records to skip

POST /v1/lessons

Create a new lesson

Request Body

{
  "title": "string",
  "type": "string",
  "duration": "string",
  "objectives": "string[]"
}