Add a course package

POST/v1/organization/{orgId}/learning/workspace/packages

US Region: https://public-api.sessionboard.com · EU Region: https://public-api-eu.sessionboard.com

Registers an uploaded zip. It is unpacked and every file checked in the background (no paths outside the package, no links, no programs), and the answer is 202 with status: processing. Poll Get a course package until status is ready (or failed, with error). A lesson plays it with a package block. Requires write:learning. Also at POST /v1/learning/workspace/packages.

Request example

cURL

curl --request POST \
  --url 'https://public-api.sessionboard.com/v1/organization/{orgId}/learning/workspace/packages' \
  --header 'x-access-token: <api-token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "key": "<string>",
  "title": "<string>"
}'

JavaScript

const response = await fetch('https://public-api.sessionboard.com/v1/organization/{orgId}/learning/workspace/packages', {
  method: 'POST',
  headers: {
    "x-access-token": "<api-token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "key": "<string>",
    "title": "<string>"
  }),
});

const data = await response.json();
console.log(data);

Python

import requests

response = requests.request(
    "POST",
    "https://public-api.sessionboard.com/v1/organization/{orgId}/learning/workspace/packages",
    headers={
        "x-access-token": "<api-token>",
        "Content-Type": "application/json"
    },
    json={
        "key": "<string>",
        "title": "<string>"
    },
)

print(response.json())

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://public-api.sessionboard.com/v1/organization/{orgId}/learning/workspace/packages",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_POSTFIELDS => '{
  "key": "<string>",
  "title": "<string>"
}',
    CURLOPT_HTTPHEADER => [
        "x-access-token: <api-token>",
        "Content-Type: application/json",
    ],
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;

Go

package main

import (
  "fmt"
  "io"
  "net/http"
  "strings"
)

func main() {
  req, _ := http.NewRequest("POST", "https://public-api.sessionboard.com/v1/organization/{orgId}/learning/workspace/packages", strings.NewReader(`{
  "key": "<string>",
  "title": "<string>"
}`))
  req.Header.Add("x-access-token", "<api-token>")
  req.Header.Add("Content-Type", "application/json")

  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(string(body))
}

Java

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://public-api.sessionboard.com/v1/organization/{orgId}/learning/workspace/packages"))
    .header("x-access-token", "<api-token>")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\n  \"key\": \"<string>\",\n  \"title\": \"<string>\"\n}"))
    .build();

HttpResponse<String> response = HttpClient.newHttpClient()
    .send(request, HttpResponse.BodyHandlers.ofString());

System.out.println(response.body());

Try it

RegionUS Region — https://public-api.sessionboard.comEU Region — https://public-api-eu.sessionboard.com

Authorization

Send asAPI token (x-access-token)OAuth access token (Bearer)

Token

Your token stays in this page. It is sent only to the region above and is never saved; it is gone when you leave or reload the page.

Path parameters

orgId*

Body application/json

{ "key": "<string>", "title": "<string>" }

POST

Send request

Authorizations

• x-access-tokenstringheader

  Organization API token. Generate from Organization Settings → API Tokens.

• AuthorizationBearer <token>headeror

  OAuth 2.1 access token. Obtained via the OAuth PKCE flow at /oauth/token.

Send one of these. See Authentication.

Path parameters

• orgIdstringpathrequired

  Your organization ID. Any other organization returns 404.

Request body

application/jsonrequired

• keystringrequired

  The key from Get an upload URL for a course package.

  Max length

  500

• titlestring

  Leave out to use the course's own title.

  Max length

  255

Example

{
  "key": "<string>",
  "title": "<string>"
}

Responses

202application/json

Unpacking.

• successboolean
• payloadobject
  Show child attributes

  • packageLearningCoursePackage

    A SCORM 1.2, SCORM 2004, xAPI or cmi5 course package.

    Show child attributes

    • idstring<uuid>
    • titlestring
    • standardstring | null

      Allowed values

      "scorm12", "scorm2004", "xapi", "cmi5"

    • standard_labelstring | null

      Example

      "SCORM 2004"

    • statusstring

      Allowed values

      "processing", "ready", "failed"

    • errorstring | null

      Why it couldn't be unpacked.

    • file_countinteger | null
    • size_bytesinteger | null
    • versionstring | null
    • mastery_scorenumber | null

      The pass mark the package sets, 0 to 1.

    • warningsstring[]
    • skippedobject[]

      Files in the zip that aren't served, and why.

      Show child attributes

      • pathstring
      • reasonstring
    • skipped_countinteger
    • preview_urlstring | null

      The launcher, for a preview that saves nothing.

    • archivedboolean
    • created_atstring<date-time>
    • updated_atstring<date-time>

400application/json

A path, query or body value failed validation, or an unknown body property was sent. message names the field. (A source object naming the assistant, with the person's prompt, is accepted on every write and removed before validation.) For an {eventId} path that is not a whole number: error: VALIDATION_ERROR, eventId must be a valid integer.

Gateway errors carry error (a code) and message. Errors from Learning itself carry status, success: false, message, name, and sometimes code (and feature or paused_at).

• errorstring | object

  The gateway's error code (SCOPE_REQUIRED, ORG_WIDE_TOKEN_REQUIRED, NOT_FOUND, …).

• messagestring
• statusinteger
• successboolean
• namestring
• codestring

  FEATURE_NOT_ENABLED, AGENT_WRITES_PAUSED, …

• featurestring
• paused_atstring<date-time>

401

Missing, invalid or expired token.

403application/json

• SCOPE_REQUIRED — the token lacks read:learning (reads) or write:learning (writes). Legacy tokens with no scopes cannot write.
• ORG_WIDE_TOKEN_REQUIRED — the token is restricted to particular events: "The Learning workspace covers every event and learner in the organization, so this API key (restricted to particular events) cannot use it. Use a key without an event restriction."
• FEATURE_NOT_ENABLED (feature: lessons_credits) — Learning is not on for the organization.
• FORBIDDEN — the token's user is not an active member of the organization, or lacks the Lessons permission the operation needs.

Gateway errors carry error (a code) and message. Errors from Learning itself carry status, success: false, message, name, and sometimes code (and feature or paused_at).

• errorstring | object

  The gateway's error code (SCOPE_REQUIRED, ORG_WIDE_TOKEN_REQUIRED, NOT_FOUND, …).

• messagestring
• statusinteger
• successboolean
• namestring
• codestring

  FEATURE_NOT_ENABLED, AGENT_WRITES_PAUSED, …

• featurestring
• paused_atstring<date-time>

404application/json

orgId is not your organization (error: NOT_FOUND, message: Organization not found).

Gateway errors carry error (a code) and message. Errors from Learning itself carry status, success: false, message, name, and sometimes code (and feature or paused_at).

• errorstring | object

  The gateway's error code (SCOPE_REQUIRED, ORG_WIDE_TOKEN_REQUIRED, NOT_FOUND, …).

• messagestring
• statusinteger
• successboolean
• namestring
• codestring

  FEATURE_NOT_ENABLED, AGENT_WRITES_PAUSED, …

• featurestring
• paused_atstring<date-time>

429application/json

• The token's request limit (100 requests per 15 minutes per bucket by default — see Rate Limiting). Wait Retry-After seconds.
• QUOTA_EXCEEDED (writes) — the token's daily write quota (10,000 a day). Resets at midnight UTC.

Gateway errors carry error (a code) and message. Errors from Learning itself carry status, success: false, message, name, and sometimes code (and feature or paused_at).

• errorstring | object

  The gateway's error code (SCOPE_REQUIRED, ORG_WIDE_TOKEN_REQUIRED, NOT_FOUND, …).

• messagestring
• statusinteger
• successboolean
• namestring
• codestring

  FEATURE_NOT_ENABLED, AGENT_WRITES_PAUSED, …

• featurestring
• paused_atstring<date-time>

• Retry-Afterintegerheader

  Seconds to wait before retrying.

Response examples

202

{
  "success": true,
  "payload": {
    "package": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "<string>",
      "standard": "scorm12",
      "standard_label": "SCORM 2004",
      "status": "processing",
      "error": "<string>",
      "file_count": 123,
      "size_bytes": 123,
      "version": "<string>",
      "mastery_score": 123.45,
      "warnings": [
        "<string>"
      ],
      "skipped": [
        {
          "path": "<string>",
          "reason": "<string>"
        }
      ],
      "skipped_count": 123,
      "preview_url": "<string>",
      "archived": true,
      "created_at": "2026-01-15T09:30:00Z",
      "updated_at": "2026-01-15T09:30:00Z"
    }
  }
}

400

{
  "error": "<string>",
  "message": "<string>",
  "status": 123,
  "success": true,
  "name": "<string>",
  "code": "<string>",
  "feature": "<string>",
  "paused_at": "2026-01-15T09:30:00Z"
}

403 · Event-restricted key

{
  "error": "ORG_WIDE_TOKEN_REQUIRED",
  "message": "The Learning workspace covers every event and learner in the organization, so this API key (restricted to particular events) cannot use it. Use a key without an event restriction."
}

403 · Token lacks the write scope

{
  "error": "SCOPE_REQUIRED",
  "message": "This operation requires the 'write:learning' scope."
}

403 · Learning is off

{
  "status": 403,
  "success": false,
  "message": "Feature 'lessons_credits' is not enabled for this organization",
  "name": "FeatureNotEnabledError",
  "code": "FEATURE_NOT_ENABLED",
  "feature": "lessons_credits"
}

404

{
  "error": "NOT_FOUND",
  "message": "Organization not found"
}

429

{
  "error": "<string>",
  "message": "<string>",
  "status": 123,
  "success": true,
  "name": "<string>",
  "code": "<string>",
  "feature": "<string>",
  "paused_at": "2026-01-15T09:30:00Z"
}