class-management

Start a class focus session and invite every enrolled student

post/class-management/sessions

Request

  • Base URL
    https://api.focusbear.io (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Request body

namestring
allowed_appsstring[]
allowed_urlsstring[]
team_idstring uuid required
timezonestring

Client-asserted IANA timezone for the session-window check. Ambiguous UTC/GMT aliases remain valid input but defer to the stored timezone. This request-scoped value is not persisted.

focus_mode_idstring uuid

Start from an existing shared focus mode (its allow-list is snapshotted into the session). When omitted, allowed_apps/allowed_urls are required and a team-shared focus mode (team_id = class) is created and linked for reuse.

block_level'gentle' | 'strict' | 'super-strict'
ai_blocking_enabledboolean

When true, student apps run their (slow) AI relevance check before blocking a non-listed site; when false/omitted they block immediately (defaults false — Mac-App#2092).

ai_contest_enabledboolean

Whether a student may explain an AI block and have the server re-run the AI (defaults true; only meaningful when ai_blocking_enabled is on).

block_bypass_sitesboolean

Whether students' apps block Focus Bear's bypass-site list during the class (defaults true).

scheduled_finish_timestring date-time

Example request

{
  "app_identities": [
    {
      "mac_bundle_id": "com.valvesoftware.steam",
      "windows_identity": {
        "exe": "steam.exe",
        "exes": [
          "OUTLOOK.EXE",
          "olk.exe"
        ],
        "publisher": "Valve Corp."
      }
    }
  ]
}

Response

object required

Changes

No recorded changes to this operation across all 1 revision of this API.