Time Machine (Preview)

Time Machine is an AI-powered corporate learning platform. It turns company documents, videos, and expert knowledge into structured courses with modules, topics, quizzes, and role-play exercises, and tracks learner progress. Built for HR and L&D teams that onboard, train, and certify employees at scale. The connector automates the full learning lifecycle: manage courses, users, departments, and roles; generate quizzes from documents; and read completion analytics.

This connector is available in the following products and regions:

Service	Class	Regions
Copilot Studio	Premium	All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD)
Logic Apps	Standard	All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD)
Power Apps	Premium	All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD)
Power Automate	Premium	All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD)

Contact
Name	Time Machine Support
URL	https://timeml.ai

Connector Metadata
Publisher	Time Machine AI
Website	https://timeml.ai
Privacy policy	https://timeml.ai/privacy-policy
Categories	Productivity;AI

Time Machine — Power Automate connector

What is Time Machine

Time Machine is an AI-powered organizational learning platform that helps companies build, operate, and continuously improve adaptive learning systems for modern teams. Organizations use Time Machine to transform existing knowledge, documents, recordings, and workflows into scalable training experiences that accelerate onboarding, improve workforce readiness, and replicate top-performer expertise across the organization.

Tenant administrators manage users, learning content, organizational resources, and platform configuration through the Time Machine REST API. This connector exposes the public REST API as Power Automate actions, enabling you to automate user provisioning, content ingestion, knowledge synchronization, and lifecycle management without writing code.

Prerequisites

An active Time Machine tenant with admin access
A Time Machine API key issued from Settings → API Keys in the admin panel (https://web.timeml.ai). The key is a value starting with tm_live_.

Authentication

Every action authenticates with an API key in the Authorization header. When creating a connection in Power Automate:

Field: API key
Value: paste Bearer tm_live_<your-token> (the full string, including the Bearer prefix and a space before the token)

Available actions

The connector mirrors the Time Machine public REST API (116 endpoints). Actions are grouped by resource:

Courses — list / create / update / delete / publish courses, assign roles, generate AI-authored content
Users — list / create / update / deactivate / reactivate users
Documents — list / upload / update / delete documents
Media — list / upload / update / delete media items
Departments — list / create / update / delete departments, manage roles, assign users to roles
Experts — list / create expert profiles, ask experts questions, assign documents and roles
Demo Trainings — list / create / update / delete demo trainings
Course Content — modules, topics, lessons, exercises, quiz questions
Insights — per-student, per-course, and company-level analytics
Certificates — list student certificates, download certificate PDFs

Full endpoint reference is available at https://api.timeml.ai/api/v1/docs.

Example workflows

Confluence release → Time Machine: When a release page is published in Confluence, upload it as a Document in Time Machine so it flows into the learning byte library.
HR onboarding: When a new employee row appears in your HRIS, create a Time Machine user with their department and role assignments, triggering the magic-link invitation.
Course completion notifications: When a student completes a course, send a certificate PDF to Slack and log the completion to a Google Sheet.

Known limitations

API key rotation: connections must be updated manually when the API key is rotated. There is no auto-refresh mechanism.
Multipart uploads: file upload actions (Upload Document, Upload Media) accept files up to 50 MB. For larger media, split into multiple uploads or contact Time Machine support.
Batch operations: the API operates on one record at a time. For bulk actions, use Power Automate's built-in apply-to-each control.

Support

For questions or issues with the connector, contact your Time Machine account team or email support at support@timeml.ai.

Creating a connection

The connector supports the following authentication types:


Default	Parameters for creating connection.	All regions	Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name	Type	Description	Required
Time Machine API key (format: Bearer tm_live_...)	securestring	The Time Machine API key (format: Bearer tm_live_...) for this api	True

Actions

Add a learning byte to a topic	Creates a new learning byte inside the given topic.
Add a lesson to a learning byte	Creates a new lesson inside the given learning byte.
Add a module to a course	Creates a new module inside the given course.
Add a quiz question to a module	Creates a new quiz question inside the given module.
Add a quiz question to a topic	Creates a new quiz question inside the given topic.
Add a topic to a module	Creates a new topic inside the given module.
Add an ILE_TEXT exercise to a topic	Creates a new ILE_TEXT exercise inside the given topic.
Add an in-lesson question	type must be MULTIPLE_CHOICE (requires options) or OPEN_ENDED
Add an RPE_VIDEO exercise to a topic	Creates a new RPE_VIDEO role-play exercise inside the given topic.
Add an RPE_VOICE exercise to a topic	Creates a new RPE_VOICE role-play exercise inside the given topic.
Ask an expert a question	Synchronous wrapper around the streaming AI chat. Returns the assembled answer.
Assign a user to a role	Idempotent
Assign documents to an expert	Bulk link documents to the expert. Idempotent.
Assign roles to a course	Additive — roles already assigned are skipped. Returns the updated course detail
Assign roles to an expert	Additive — already-assigned roles are kept; new ones appended. Returns updated expert
Certificate detail	Returns one certificate scoped to the caller's company
Company-level insights	Top-line KPIs for the caller's company
Create a demo training	Creates a demo training from a previously uploaded video file and starts processing
Create a department	Creates a new department in the caller's company.
Create a role within a department	Creates a new role scoped to the given department.
Create a user	Creates a user and triggers the magic-link invitation flow
Create an empty course	Creates a new course shell with the given name
Deactivate a user	Idempotent — returns the user even if already deactivated
Delete (deactivate) a department	Idempotent — returns 204 even if already deactivated. Cascades to role assignments.
Delete (deactivate) a document	Idempotent — returns 204 even if the document is already deleted or missing
Delete (deactivate) a media item	Idempotent — returns 204 even if the item is already deleted or missing
Delete (soft) a course	Idempotent — returns 204 even if the course is already removed
Delete a demo training	Idempotent — returns 204 even if the demo training does not exist or is already gone
Delete a learning byte (soft)	Idempotent — 204 even if already removed
Delete a lesson (soft)	Idempotent — 204 even if already removed
Delete a module (soft)	Idempotent — returns 204 even if the module is already removed
Delete a topic (soft)	Idempotent — returns 204 even if the topic is already removed
Delete an exercise	Idempotent — 204 even if already removed
Delete an in-lesson question	Idempotent — 204 even if already removed
Delete one quiz question on a module	Idempotent — 204 even if already removed
Delete one quiz question on a topic	Idempotent — 204 even if already removed
Download certificate PDF	Streams the certificate PDF. Returns 404 if the certificate has no PDF yet
Generate a full course with AI content	Creates the course shell, all modules, all topics, and enqueues AI content generation for every topic
Get a course	Returns course metadata with module summaries and assigned roles/departments
Get a course version snapshot	Returns the full content tree (modules, topics, lessons, exercises, questions) for the given version
Get a demo training	Returns the full demo training with segments
Get a document	Returns document metadata and a short-lived signed download URL
Get a learning byte	Returns metadata and nested lessons
Get a lesson	Returns lesson content, media and in-lesson questions
Get a media item	Returns media metadata and a short-lived signed download URL
Get a module	Returns module details for the given ID.
Get a module intro	Returns the intro text set on the given module.
Get a topic	Returns topic details for the given ID.
Get a topic intro	Returns the intro text set on the given topic.
Get a user	Returns user metadata and department/role assignments
Get AI generation status for a course	Returns the list of active AI generation requests for the course with progress and target info
Get an exercise	Returns exercise details for the given ID.
Get an expert	Returns expert metadata, linked documents, and assigned roles/departments
Get one in-lesson question	Returns a single in-lesson question by its ID.
Get one quiz question on a module	Returns a single quiz question attached to the given module.
Get one quiz question on a topic	Returns a single quiz question attached to the given topic.
Link documents to a topic	Additive — already-linked documents are skipped
List a student's certificates	Returns certificates earned by the given student inside the caller's company
List course versions	Returns published version metadata (counts + publish info) ordered by version number
List courses	Paginated list of courses in the caller's company
List demo trainings	Paginated list scoped to the caller's company
List departments	All departments in the caller's company with nested roles
List documents	Paginated list of documents in the caller's company
List documents linked to a topic	Paginated; optional search by document name
List exercises in a topic	Mixed types (ILE_TEXT / RPE_VOICE / RPE_VIDEO) ordered by ordinalNumber
List experts	Paginated list of experts in the caller's company
List in-lesson questions	Returns knowledge-check questions attached to the given lesson.
List learning bytes in a topic	Returns learning bytes that belong to the given topic.
List lessons in a learning byte	Returns lessons that belong to the given learning byte.
List media	Paginated list of media items in the caller's company
List modules in a course	Returns active modules ordered by ordinalNumber
List quiz questions on a module	Returns quiz questions attached to the given module.
List quiz questions on a topic	Returns quiz questions attached to the given topic.
List topics in a module	Returns active topics ordered by ordinalNumber
List users	Paginated list of users in the caller's company
Move a topic to another module	targetOrdinalNumber is optional; if omitted the topic is appended to the target module
Per-student activity events	Paginated forward-only event stream
Per-student insights	Aggregated summary and per-course breakdown for the given window
Publish a course	Publishes the course; fails with 400 if it has no publishable content
Re-run video processing	Re-submits the video for AI segmentation. Optionally override the processing prompt.
Reactivate a user	Idempotent — returns the user even if already active
Regenerate a specific item via AI	Regenerates a single lesson, lesson questions, quiz, intro, or exercise
Remove a module intro	Idempotent — 204 even if no intro is set
Remove a topic intro	Idempotent — 204 even if no intro is set
Remove all role assignments from a course	Idempotent
Remove all role assignments from an expert	Idempotent
Remove one role assignment from a course	Idempotent
Remove one role assignment from an expert	Idempotent
Reorder in-lesson questions	questionIds must include every active question for the lesson, in the new order
Reorder modules in a course	moduleIds must include every active module exactly once, in the new order
Reorder quiz questions on a module	questionIds must include every active quiz question for the module, in the new order.
Reorder quiz questions on a topic	questionIds must include every active quiz question for the topic, in the new order.
Reorder topics inside a module	topicIds must include every active topic exactly once, in the new order
Replace document binary	Replaces the file binary of an existing document; metadata is preserved
Replace media binary	Replaces the file binary of an existing media item in place; metadata is preserved
Set module quiz count for one question type	Replaces the count for the given questionType (MULTIPLE_CHOICE or OPEN_ENDED). Other type's count is preserved
Set or replace a module intro	Upsert — creates if missing, replaces if present
Set or replace a topic intro	Upsert — creates if missing, replaces if present
Set topic quiz count for one question type	Replaces the count for the given questionType (MULTIPLE_CHOICE or OPEN_ENDED). Other type's count is preserved
Toggle availability to students	Set whether the demo training is published to students. Idempotent.
Trigger AI content generation for topics	Enqueues AI content generation for the specified topics within the course
Unassign a document from an expert	Idempotent
Unassign a user from a role	Idempotent — 204 even if was not assigned
Unlink one document from a topic	Idempotent
Update a demo training	Partial update. Pass only the fields you want to change. assignedRoleIds replaces the current set.
Update a department	Update name and/or description
Update a user	Update firstName, lastName, isAdmin, and role assignments. Email is not editable in v1.
Update an exercise	Type-aware: ILE_TEXT only uses prompt + generatedContent.scenario; RPE_* uses all RPE fields. Omitted fields preserve current values.
Update an in-lesson question	Provide fields matching the stored type; unrelated fields are ignored
Update course metadata	Update course name
Update document metadata	Update name and/or description
Update learning byte metadata	Omitted fields preserve current values
Update lesson content	Omitted content preserves current value
Update media metadata	Update name and/or description
Update module metadata	Updates name and/or description. Omitted fields preserve current values
Update one quiz question on a module	Provide fields matching the stored type; unrelated fields are ignored.
Update one quiz question on a topic	Provide fields matching the stored type; unrelated fields are ignored.
Update topic metadata	Updates name and/or description. Omitted fields preserve current values
Upload a document	Multipart upload (file + optional description). Max 50MB.
Upload a media item	Multipart upload (file + optional description). Max 50MB for images, 500MB for videos.

Add a learning byte to a topic

Operation ID:: addLearningByteToTopic

Creates a new learning byte inside the given topic.

Parameters

Name	Key	Required	Type	Description
Topic Id	topicId	True	uuid	Topic Id
name	name	True	string
description	description		string

Returns

Body: LearningByteDetailDto

Add a lesson to a learning byte

Operation ID:: addLessonToLearningByte

Creates a new lesson inside the given learning byte.

Parameters

Name	Key	Required	Type	Description
Lb Id	lbId	True	uuid	Lb Id
content	content	True	string

Returns

Body: LessonDetailDto

Add a module to a course

Operation ID:: addModuleToCourse

Creates a new module inside the given course.

Parameters

Name	Key	Required	Type	Description
Course Id	courseId	True	uuid	Course Id
name	name	True	string
description	description		string

Returns

Body: ModuleDetailDto

Add a quiz question to a module

Operation ID:: addModuleQuizQuestion

Creates a new quiz question inside the given module.

Parameters

Name	Key	Required	Type	Description
Module Id	moduleId	True	uuid	Module Id
type	type	True	string
text	text	True	string
ordinalNumber	ordinalNumber		integer
text	text	True	string
isCorrect	isCorrect		boolean
expectedAnswer	expectedAnswer		string

Returns

Body: QuestionDto

Add a quiz question to a topic

Operation ID:: addTopicQuizQuestion

Creates a new quiz question inside the given topic.

Parameters

Name	Key	Required	Type	Description
Topic Id	topicId	True	uuid	Topic Id
type	type	True	string
text	text	True	string
ordinalNumber	ordinalNumber		integer
text	text	True	string
isCorrect	isCorrect		boolean
expectedAnswer	expectedAnswer		string

Returns

Body: QuestionDto

Add a topic to a module

Operation ID:: addTopicToModule

Creates a new topic inside the given module.

Parameters

Name	Key	Required	Type	Description
Module Id	moduleId	True	uuid	Module Id
name	name	True	string
description	description		string

Returns

Body: TopicDto

Add an ILE_TEXT exercise to a topic

Operation ID:: addIleTextExercise

Creates a new ILE_TEXT exercise inside the given topic.

Parameters

Name	Key	Required	Type	Description
Topic Id	topicId	True	uuid	Topic Id
prompt	prompt		string

Returns

Body: ExerciseDto

Add an in-lesson question

Operation ID:: addLessonQuestion

type must be MULTIPLE_CHOICE (requires options) or OPEN_ENDED

Parameters

Name	Key	Required	Type	Description
Lesson Id	lessonId	True	uuid	Lesson Id
type	type	True	string
text	text	True	string
ordinalNumber	ordinalNumber		integer
text	text	True	string
isCorrect	isCorrect		boolean
expectedAnswer	expectedAnswer		string

Returns

Body: QuestionDto

Add an RPE_VIDEO exercise to a topic

Operation ID:: addRpeVideoExercise

Creates a new RPE_VIDEO role-play exercise inside the given topic.

Parameters

Name	Key	Required	Type	Description
Topic Id	topicId	True	uuid	Topic Id
prompt	prompt		string
avatarPictureId	avatarPictureId		uuid
avatarCharacteristics	avatarCharacteristics		string
reverseRolePlayEnabled	reverseRolePlayEnabled		boolean
reverseRolePlayMandatory	reverseRolePlayMandatory		boolean

Returns

Body: ExerciseDto

Add an RPE_VOICE exercise to a topic

Operation ID:: addRpeVoiceExercise

Creates a new RPE_VOICE role-play exercise inside the given topic.

Parameters

Name	Key	Required	Type	Description
Topic Id	topicId	True	uuid	Topic Id
prompt	prompt		string
avatarPictureId	avatarPictureId		uuid
avatarCharacteristics	avatarCharacteristics		string
reverseRolePlayEnabled	reverseRolePlayEnabled		boolean
reverseRolePlayMandatory	reverseRolePlayMandatory		boolean

Returns

Body: ExerciseDto

Ask an expert a question

Operation ID:: askExpert

Synchronous wrapper around the streaming AI chat. Returns the assembled answer.

Parameters

Name	Key	Required	Type	Description
Id	id	True	uuid	Id
question	question	True	string

Returns

Body: AskResponse

Assign a user to a role

Operation ID:: assignUserToRole

Idempotent

Parameters

Name	Key	Required	Type	Description
Id	id	True	uuid	Id
Role Id	roleId	True	uuid	Role Id
userId	userId	True	uuid

Returns

Body: DepartmentDto

Assign documents to an expert

Operation ID:: assignDocumentsToExpert

Bulk link documents to the expert. Idempotent.

Parameters

Name	Key	Required	Type	Description
Id	id	True	uuid	Id
documentIds	documentIds	True	array of uuid

Returns

Body: ExpertDetailDto

Assign roles to a course

Operation ID:: assignRolesToCourse

Additive — roles already assigned are skipped. Returns the updated course detail

Parameters

Name	Key	Required	Type	Description
Id	id	True	uuid	Id
roleIds	roleIds	True	array of uuid

Returns

Body: CourseDetailDto

Assign roles to an expert

Operation ID:: assignRolesToExpert

Additive — already-assigned roles are kept; new ones appended. Returns updated expert

Parameters

Name	Key	Required	Type	Description
Id	id	True	uuid	Id
roleIds	roleIds	True	array of uuid

Returns

Body: ExpertDetailDto

Certificate detail

Operation ID:: getCertificate

Returns one certificate scoped to the caller's company

Parameters

Name	Key	Required	Type	Description
Id	id	True	uuid	Id

Returns

Body: CertificateDto

Company-level insights

Operation ID:: getCompanyInsights

Top-line KPIs for the caller's company

Returns

Body: CompanyInsightsDto

Create a demo training

Operation ID:: createDemoTraining

Creates a demo training from a previously uploaded video file and starts processing

Parameters

Name	Key	Required	Type
name	name	True	string
description	description		string
trainingType	trainingType	True	string
videoFileId	videoFileId	True	uuid
departmentId	departmentId		uuid
processingPrompt	processingPrompt		string

Returns

Body: DemoTrainingDto

Create a department

Operation ID:: createDepartment

Creates a new department in the caller's company.

Parameters

Name	Key	Required	Type	Description
name	name	True	string
description	description		string

Returns

Body: DepartmentDto

Create a role within a department

Operation ID:: createRoleInDepartment

Creates a new role scoped to the given department.

Parameters

Name	Key	Required	Type	Description
Id	id	True	uuid	Id
name	name	True	string
fullName	fullName		string
description	description		string

Returns

Body: DepartmentDto

Create a user

Operation ID:: createUser

Creates a user and triggers the magic-link invitation flow

Parameters

Name	Key	Required	Type
email	email	True	email
firstName	firstName		string
lastName	lastName		string
isAdmin	isAdmin		boolean
departmentRoleIds	departmentRoleIds		array of uuid

Returns

Body: UserDto

Create an empty course

Operation ID:: createCourse

Creates a new course shell with the given name

Parameters

Name	Key	Required	Type	Description
name	name	True	string

Returns

Body: CourseDetailDto

Deactivate a user

Operation ID:: deactivateUser

Idempotent — returns the user even if already deactivated

Parameters

Name	Key	Required	Type	Description
Id	id	True	uuid	Id

Returns

Body: UserDto

Delete (deactivate) a department

Operation ID:: deleteDepartment

Idempotent — returns 204 even if already deactivated. Cascades to role assignments.

Parameters

Name	Key	Required	Type	Description
Id	id	True	uuid	Id

Delete (deactivate) a document

Operation ID:: deleteDocument

Idempotent — returns 204 even if the document is already deleted or missing

Parameters

Name	Key	Required	Type	Description
Id	id	True	uuid	Id

Delete (deactivate) a media item

Operation ID:: deleteMedia

Idempotent — returns 204 even if the item is already deleted or missing

Parameters

Name	Key	Required	Type	Description
Id	id	True	uuid	Id

Delete (soft) a course

Operation ID:: deleteCourse

Idempotent — returns 204 even if the course is already removed

Parameters

Name	Key	Required	Type	Description
Id	id	True	uuid	Id

Delete a demo training

Operation ID:: deleteDemoTraining

Idempotent — returns 204 even if the demo training does not exist or is already gone

Parameters

Name	Key	Required	Type	Description
Id	id	True	uuid	Id

Delete a learning byte (soft)

Operation ID:: deleteLearningByte

Idempotent — 204 even if already removed

Parameters

Name	Key	Required	Type	Description
Lb Id	lbId	True	uuid	Lb Id

Delete a lesson (soft)

Operation ID:: deleteLesson

Idempotent — 204 even if already removed

Parameters

Name	Key	Required	Type	Description
Lesson Id	lessonId	True	uuid	Lesson Id

Delete a module (soft)

Operation ID:: deleteModule

Idempotent — returns 204 even if the module is already removed

Parameters

Name	Key	Required	Type	Description
Module Id	moduleId	True	uuid	Module Id

Delete a topic (soft)

Operation ID:: deleteTopic

Idempotent — returns 204 even if the topic is already removed

Parameters

Name	Key	Required	Type	Description
Topic Id	topicId	True	uuid	Topic Id

Delete an exercise

Operation ID:: deleteExercise

Idempotent — 204 even if already removed

Parameters

Name	Key	Required	Type	Description
Id	id	True	uuid	Id

Delete an in-lesson question

Operation ID:: deleteLessonQuestion

Idempotent — 204 even if already removed

Parameters

Name	Key	Required	Type	Description
Lesson Id	lessonId	True	uuid	Lesson Id
Question Id	questionId	True	uuid	Question Id

Delete one quiz question on a module

Operation ID:: deleteModuleQuizQuestion

Idempotent — 204 even if already removed

Parameters

Name	Key	Required	Type	Description
Module Id	moduleId	True	uuid	Module Id
Question Id	questionId	True	uuid	Question Id

Delete one quiz question on a topic

Operation ID:: deleteTopicQuizQuestion

Idempotent — 204 even if already removed

Parameters

Name	Key	Required	Type	Description
Topic Id	topicId	True	uuid	Topic Id
Question Id	questionId	True	uuid	Question Id

Download certificate PDF

Operation ID:: downloadCertificatePdf

Streams the certificate PDF. Returns 404 if the certificate has no PDF yet

Parameters

Name	Key	Required	Type	Description
Id	id	True	uuid	Id

Returns

response: StreamingResponseBody

Generate a full course with AI content

Operation ID:: generateCourse

Creates the course shell, all modules, all topics, and enqueues AI content generation for every topic

Parameters

Name	Key	Required	Type
name	name	True	string
description	description		string
name	name	True	string
description	description		string
name	name	True	string
description	description		string

Returns

Body: GenerateCourseResponse

Get a course

Operation ID:: getCourse

Returns course metadata with module summaries and assigned roles/departments

Parameters

Name	Key	Required	Type	Description
Id	id	True	uuid	Id

Returns

Body: CourseDetailDto

Get a course version snapshot

Operation ID:: getCourseVersion

Returns the full content tree (modules, topics, lessons, exercises, questions) for the given version

Parameters

Name	Key	Required	Type	Description
Course Id	courseId	True	uuid	Course Id
Version Number	versionNumber	True	integer	Version Number

Returns

Body: CourseVersionSnapshotDto

Get a demo training

Operation ID:: getDemoTraining

Returns the full demo training with segments

Parameters

Name	Key	Required	Type	Description
Id	id	True	uuid	Id

Returns

Body: DemoTrainingDto

Get a document

Operation ID:: getDocument

Returns document metadata and a short-lived signed download URL

Parameters

Name	Key	Required	Type	Description
Id	id	True	uuid	Id

Returns

Body: DocumentDetailDto

Get a learning byte

Operation ID:: getLearningByte

Returns metadata and nested lessons

Parameters

Name	Key	Required	Type	Description
Lb Id	lbId	True	uuid	Lb Id

Returns

Body: LearningByteDetailDto

Get a lesson

Operation ID:: getLesson

Returns lesson content, media and in-lesson questions

Parameters

Name	Key	Required	Type	Description
Lesson Id	lessonId	True	uuid	Lesson Id

Returns

Body: LessonDetailDto

Get a media item

Operation ID:: getMediaItem

Returns media metadata and a short-lived signed download URL

Parameters

Name	Key	Required	Type	Description
Id	id	True	uuid	Id

Returns

Body: MediaDetailDto

Get a module

Operation ID:: getModule

Returns module details for the given ID.

Parameters

Name	Key	Required	Type	Description
Module Id	moduleId	True	uuid	Module Id

Returns

Body: ModuleDetailDto

Get a module intro

Operation ID:: getModuleIntro

Returns the intro text set on the given module.

Parameters

Name	Key	Required	Type	Description
Module Id	moduleId	True	uuid	Module Id

Returns

Body: IntroDto

Get a topic

Operation ID:: getTopic

Returns topic details for the given ID.

Parameters

Name	Key	Required	Type	Description
Topic Id	topicId	True	uuid	Topic Id

Returns

Body: TopicDto

Get a topic intro

Operation ID:: getTopicIntro

Returns the intro text set on the given topic.

Parameters

Name	Key	Required	Type	Description
Topic Id	topicId	True	uuid	Topic Id

Returns

Body: IntroDto

Get a user

Operation ID:: getUser

Returns user metadata and department/role assignments

Parameters

Name	Key	Required	Type	Description
Id	id	True	uuid	Id

Returns

Body: UserDto

Get AI generation status for a course

Operation ID:: getCourseGenerationStatus

Returns the list of active AI generation requests for the course with progress and target info

Parameters

Name	Key	Required	Type	Description
Id	id	True	uuid	Id

Returns

Body: GenerationStatusResponse

Get an exercise

Operation ID:: getExercise

Returns exercise details for the given ID.

Parameters

Name	Key	Required	Type	Description
Id	id	True	uuid	Id

Returns

Body: ExerciseDto

Get an expert

Operation ID:: getExpert

Returns expert metadata, linked documents, and assigned roles/departments

Parameters

Name	Key	Required	Type	Description
Id	id	True	uuid	Id

Returns

Body: ExpertDetailDto

Get one in-lesson question

Operation ID:: getLessonQuestion

Returns a single in-lesson question by its ID.

Parameters

Name	Key	Required	Type	Description
Lesson Id	lessonId	True	uuid	Lesson Id
Question Id	questionId	True	uuid	Question Id

Returns

Body: QuestionDto

Get one quiz question on a module

Operation ID:: getModuleQuizQuestion

Returns a single quiz question attached to the given module.

Parameters

Name	Key	Required	Type	Description
Module Id	moduleId	True	uuid	Module Id
Question Id	questionId	True	uuid	Question Id

Returns

Body: QuestionDto

Get one quiz question on a topic

Operation ID:: getTopicQuizQuestion

Returns a single quiz question attached to the given topic.

Parameters

Name	Key	Required	Type	Description
Topic Id	topicId	True	uuid	Topic Id
Question Id	questionId	True	uuid	Question Id

Returns

Body: QuestionDto

Link documents to a topic

Operation ID:: linkDocumentsToTopic

Additive — already-linked documents are skipped

Parameters

Name	Key	Required	Type	Description
Topic Id	topicId	True	uuid	Topic Id
documentIds	documentIds	True	array of uuid

List a student's certificates

Operation ID:: listStudentCertificates

Returns certificates earned by the given student inside the caller's company

Parameters

Name	Key	Required	Type	Description
User Id	userId	True	uuid	User Id

Returns

Body: CertificateListResponse

List course versions

Operation ID:: listCourseVersions

Returns published version metadata (counts + publish info) ordered by version number

Parameters

Name	Key	Required	Type	Description
Course Id	courseId	True	uuid	Course Id

Returns

Body: CourseVersionListResponse

List courses

Operation ID:: listCourses

Paginated list of courses in the caller's company

Parameters

Name	Key	Type	Description
Page	page	integer	Page
Size	size	integer	Size
Search	search	string	Search
Status	status	string	Status
Department Role Ids	departmentRoleIds	string	Department Role Ids

Returns

Body: CourseListResponse

List demo trainings

Operation ID:: listDemoTrainings

Paginated list scoped to the caller's company

Parameters

Name	Key	Type	Description
Page	page	integer	Page
Size	size	integer	Size
Search	search	string	Search
Training Types	trainingTypes	string	Training Types
Statuses	statuses	string	Statuses
Department Ids	departmentIds	string	Department Ids
Is Available	isAvailable	boolean	Is Available

Returns

Body: DemoTrainingListResponse

List departments

Operation ID:: listDepartments

All departments in the caller's company with nested roles

Returns

Body: DepartmentListResponse

List documents

Operation ID:: listDocuments

Paginated list of documents in the caller's company

Parameters

Name	Key	Type	Description
Page	page	integer	Page
Size	size	integer	Size
Search	search	string	Search
Mime Types	mimeTypes	string	Mime Types
Status	status	string	Status

Returns

Body: DocumentListResponse

List documents linked to a topic

Operation ID:: listTopicLinkedDocuments

Paginated; optional search by document name

Parameters

Name	Key	Required	Type	Description
Topic Id	topicId	True	uuid	Topic Id
Page	page		integer	Page
Size	size		integer	Size
Search	search		string	Search

Returns

Body: TopicLinkedDocumentListResponse

List exercises in a topic

Operation ID:: listExercisesInTopic

Mixed types (ILE_TEXT / RPE_VOICE / RPE_VIDEO) ordered by ordinalNumber

Parameters

Name	Key	Required	Type	Description
Topic Id	topicId	True	uuid	Topic Id

Returns

Body: ExerciseListResponse

List experts

Operation ID:: listExperts

Paginated list of experts in the caller's company

Parameters

Name	Key	Type	Description
Page	page	integer	Page
Size	size	integer	Size
Search	search	string	Search

Returns

Body: ExpertListResponse

List in-lesson questions

Operation ID:: listLessonQuestions

Returns knowledge-check questions attached to the given lesson.

Parameters

Name	Key	Required	Type	Description
Lesson Id	lessonId	True	uuid	Lesson Id

Returns

Body: QuestionListResponse

List learning bytes in a topic

Operation ID:: listLearningBytesInTopic

Returns learning bytes that belong to the given topic.

Parameters

Name	Key	Required	Type	Description
Topic Id	topicId	True	uuid	Topic Id

Returns

Body: LearningByteListResponse

List lessons in a learning byte

Operation ID:: listLessonsInLearningByte

Returns lessons that belong to the given learning byte.

Parameters

Name	Key	Required	Type	Description
Lb Id	lbId	True	uuid	Lb Id

Returns

Body: LessonListResponse

List media

Operation ID:: listMedia

Paginated list of media items in the caller's company

Parameters

Name	Key	Type	Description
Page	page	integer	Page
Size	size	integer	Size
Search	search	string	Search
Kind	kind	string	Kind
Status	status	string	Status

Returns

Body: MediaListResponse

List modules in a course

Operation ID:: listModulesInCourse

Returns active modules ordered by ordinalNumber

Parameters

Name	Key	Required	Type	Description
Course Id	courseId	True	uuid	Course Id

Returns

Body: ModuleListResponse

List quiz questions on a module

Operation ID:: listModuleQuizQuestions

Returns quiz questions attached to the given module.

Parameters

Name	Key	Required	Type	Description
Module Id	moduleId	True	uuid	Module Id

Returns

Body: QuestionListResponse

List quiz questions on a topic

Operation ID:: listTopicQuizQuestions

Returns quiz questions attached to the given topic.

Parameters

Name	Key	Required	Type	Description
Topic Id	topicId	True	uuid	Topic Id

Returns

Body: QuestionListResponse

List topics in a module

Operation ID:: listTopicsInModule

Returns active topics ordered by ordinalNumber

Parameters

Name	Key	Required	Type	Description
Module Id	moduleId	True	uuid	Module Id

Returns

Body: TopicListResponse

List users

Operation ID:: listUsers

Paginated list of users in the caller's company

Parameters

Name	Key	Type	Description
Page	page	integer	Page
Size	size	integer	Size
Search	search	string	Search
Status	status	string	Status
Department Ids	departmentIds	string	Department Ids
Role Ids	roleIds	string	Role Ids
Kind	kind	string	Kind

Returns

Body: UserListResponse

Move a topic to another module

Operation ID:: moveTopic

targetOrdinalNumber is optional; if omitted the topic is appended to the target module

Parameters

Name	Key	Required	Type	Description
Topic Id	topicId	True	uuid	Topic Id
targetModuleId	targetModuleId	True	uuid
targetOrdinalNumber	targetOrdinalNumber		integer

Returns

Body: TopicDto

Per-student activity events

Operation ID:: listStudentEvents

Paginated forward-only event stream

Parameters

Name	Key	Required	Type	Description
User Id	userId	True	uuid	User Id
Page	page		integer	Page
Size	size		integer	Size

Returns

Body: EventListResponse

Per-student insights

Operation ID:: getStudentInsights

Aggregated summary and per-course breakdown for the given window

Parameters

Name	Key	Required	Type	Description
User Id	userId	True	uuid	User Id
Window	window		string	Window

Returns

Body: StudentInsightsDto

Publish a course

Operation ID:: publishCourse

Publishes the course; fails with 400 if it has no publishable content

Parameters

Name	Key	Required	Type	Description
Id	id	True	uuid	Id

Returns

Body: CourseDetailDto

Re-run video processing

Operation ID:: reprocessDemoTraining

Re-submits the video for AI segmentation. Optionally override the processing prompt.

Parameters

Name	Key	Required	Type	Description
Id	id	True	uuid	Id
processingPrompt	processingPrompt		string

Returns

Body: DemoTrainingDto

Reactivate a user

Operation ID:: reactivateUser

Idempotent — returns the user even if already active

Parameters

Name	Key	Required	Type	Description
Id	id	True	uuid	Id

Returns

Body: UserDto

Regenerate a specific item via AI

Operation ID:: regenerateCourseItem

Regenerates a single lesson, lesson questions, quiz, intro, or exercise

Parameters

Name	Key	Required	Type
target	target	True	string
targetId	targetId	True	uuid
parentType	parentType		string

Returns

Body: GenerationRequestResponse

Remove a module intro

Operation ID:: removeModuleIntro

Idempotent — 204 even if no intro is set

Parameters

Name	Key	Required	Type	Description
Module Id	moduleId	True	uuid	Module Id

Remove a topic intro

Operation ID:: removeTopicIntro

Idempotent — 204 even if no intro is set

Parameters

Name	Key	Required	Type	Description
Topic Id	topicId	True	uuid	Topic Id

Remove all role assignments from a course

Operation ID:: removeAllRolesFromCourse

Idempotent

Parameters

Name	Key	Required	Type	Description
Id	id	True	uuid	Id

Remove all role assignments from an expert

Operation ID:: removeAllRolesFromExpert

Idempotent

Parameters

Name	Key	Required	Type	Description
Id	id	True	uuid	Id

Remove one role assignment from a course

Operation ID:: removeRoleFromCourse

Idempotent

Parameters

Name	Key	Required	Type	Description
Id	id	True	uuid	Id
Role Id	roleId	True	uuid	Role Id

Remove one role assignment from an expert

Operation ID:: removeRoleFromExpert

Idempotent

Parameters

Name	Key	Required	Type	Description
Id	id	True	uuid	Id
Role Id	roleId	True	uuid	Role Id

Reorder in-lesson questions

Operation ID:: reorderLessonQuestions

questionIds must include every active question for the lesson, in the new order

Parameters

Name	Key	Required	Type	Description
Lesson Id	lessonId	True	uuid	Lesson Id
questionIds	questionIds	True	array of uuid

Returns

Body: QuestionListResponse

Reorder modules in a course

Operation ID:: reorderModulesInCourse

moduleIds must include every active module exactly once, in the new order

Parameters

Name	Key	Required	Type	Description
Course Id	courseId	True	uuid	Course Id
moduleIds	moduleIds	True	array of uuid

Returns

Body: ModuleListResponse

Reorder quiz questions on a module

Operation ID:: reorderModuleQuizQuestions

questionIds must include every active quiz question for the module, in the new order.

Parameters

Name	Key	Required	Type	Description
Module Id	moduleId	True	uuid	Module Id
questionIds	questionIds	True	array of uuid

Returns

Body: QuestionListResponse

Reorder quiz questions on a topic

Operation ID:: reorderTopicQuizQuestions

questionIds must include every active quiz question for the topic, in the new order.

Parameters

Name	Key	Required	Type	Description
Topic Id	topicId	True	uuid	Topic Id
questionIds	questionIds	True	array of uuid

Returns

Body: QuestionListResponse

Reorder topics inside a module

Operation ID:: reorderTopicsInModule

topicIds must include every active topic exactly once, in the new order

Parameters

Name	Key	Required	Type	Description
Module Id	moduleId	True	uuid	Module Id
topicIds	topicIds	True	array of uuid

Returns

Body: TopicListResponse

Replace document binary

Operation ID:: replaceDocumentFile

Replaces the file binary of an existing document; metadata is preserved

Parameters

Name	Key	Required	Type	Description
Id	id	True	uuid	Id
File	file	True	file	File

Returns

Body: DocumentDetailDto

Replace media binary

Operation ID:: replaceMediaFile

Replaces the file binary of an existing media item in place; metadata is preserved

Parameters

Name	Key	Required	Type	Description
Id	id	True	uuid	Id
File	file	True	file	File

Returns

Body: MediaDetailDto

Set module quiz count for one question type

Operation ID:: setModuleQuizSettings

Replaces the count for the given questionType (MULTIPLE_CHOICE or OPEN_ENDED). Other type's count is preserved

Parameters

Name	Key	Required	Type	Description
Module Id	moduleId	True	uuid	Module Id
questionType	questionType	True	string
count	count		integer

Returns

Body: ModuleDetailDto

Set or replace a module intro

Operation ID:: setModuleIntro

Upsert — creates if missing, replaces if present

Parameters

Name	Key	Required	Type	Description
Module Id	moduleId	True	uuid	Module Id
introduction	introduction		string

Returns

Body: IntroDto

Set or replace a topic intro

Operation ID:: setTopicIntro

Upsert — creates if missing, replaces if present

Parameters

Name	Key	Required	Type	Description
Topic Id	topicId	True	uuid	Topic Id
introduction	introduction		string

Returns

Body: IntroDto

Set topic quiz count for one question type

Operation ID:: setTopicQuizSettings

Replaces the count for the given questionType (MULTIPLE_CHOICE or OPEN_ENDED). Other type's count is preserved

Parameters

Name	Key	Required	Type	Description
Topic Id	topicId	True	uuid	Topic Id
questionType	questionType	True	string
count	count		integer

Returns

Body: TopicDto

Toggle availability to students

Operation ID:: updateDemoTrainingAvailability

Set whether the demo training is published to students. Idempotent.

Parameters

Name	Key	Required	Type	Description
Id	id	True	uuid	Id
available	available	True	boolean

Returns

Body: DemoTrainingDto

Trigger AI content generation for topics

Operation ID:: generateCourseContent

Enqueues AI content generation for the specified topics within the course

Parameters

Name	Key	Required	Type	Description
Id	id	True	uuid	Id
topicIds	topicIds	True	array of uuid

Returns

Body: GenerationRequestResponse

Unassign a document from an expert

Operation ID:: unassignDocumentFromExpert

Idempotent

Parameters

Name	Key	Required	Type	Description
Id	id	True	uuid	Id
Document Id	documentId	True	uuid	Document Id

Unassign a user from a role

Operation ID:: unassignUserFromRole

Idempotent — 204 even if was not assigned

Parameters

Name	Key	Required	Type	Description
Id	id	True	uuid	Id
Role Id	roleId	True	uuid	Role Id
User Id	userId	True	uuid	User Id

Unlink one document from a topic

Operation ID:: unlinkDocumentFromTopic

Idempotent

Parameters

Name	Key	Required	Type	Description
Topic Id	topicId	True	uuid	Topic Id
Document Id	documentId	True	uuid	Document Id

Update a demo training

Operation ID:: updateDemoTraining

Partial update. Pass only the fields you want to change. assignedRoleIds replaces the current set.

Parameters

Name	Key	Required	Type	Description
Id	id	True	uuid	Id
name	name		string
description	description		string
trainingType	trainingType		string
departmentId	departmentId		uuid
assignedRoleIds	assignedRoleIds		array of uuid

Returns

Body: DemoTrainingDto

Update a department

Operation ID:: updateDepartment

Update name and/or description

Parameters

Name	Key	Required	Type	Description
Id	id	True	uuid	Id
name	name		string
description	description		string

Returns

Body: DepartmentDto

Update a user

Operation ID:: updateUser

Update firstName, lastName, isAdmin, and role assignments. Email is not editable in v1.

Parameters

Name	Key	Required	Type	Description
Id	id	True	uuid	Id
firstName	firstName		string
lastName	lastName		string
isAdmin	isAdmin		boolean
departmentRoleIds	departmentRoleIds		array of uuid

Returns

Body: UserDto

Update an exercise

Operation ID:: updateExercise

Type-aware: ILE_TEXT only uses prompt + generatedContent.scenario; RPE_* uses all RPE fields. Omitted fields preserve current values.

Parameters

Name	Key	Required	Type	Description
Id	id	True	uuid	Id
prompt	prompt		string
avatarPictureId	avatarPictureId		uuid
avatarCharacteristics	avatarCharacteristics		string
reverseRolePlayEnabled	reverseRolePlayEnabled		boolean
reverseRolePlayMandatory	reverseRolePlayMandatory		boolean
scenario	scenario		string
traineeRole	traineeRole		string
avatarName	avatarName		string
avatarDescription	avatarDescription		string
operationalChallenge	operationalChallenge		string
successMetric	successMetric		string

Returns

Body: ExerciseDto

Update an in-lesson question

Operation ID:: updateLessonQuestion

Provide fields matching the stored type; unrelated fields are ignored

Parameters

Name	Key	Required	Type	Description
Lesson Id	lessonId	True	uuid	Lesson Id
Question Id	questionId	True	uuid	Question Id
text	text		string
text	text	True	string
isCorrect	isCorrect		boolean
expectedAnswer	expectedAnswer		string

Returns

Body: QuestionDto

Update course metadata

Operation ID:: updateCourse

Update course name

Parameters

Name	Key	Required	Type	Description
Id	id	True	uuid	Id
name	name		string

Returns

Body: CourseDetailDto

Update document metadata

Operation ID:: updateDocumentMetadata

Update name and/or description

Parameters

Name	Key	Required	Type	Description
Id	id	True	uuid	Id
name	name		string
description	description		string

Returns

Body: DocumentDetailDto

Update learning byte metadata

Operation ID:: updateLearningByte

Omitted fields preserve current values

Parameters

Name	Key	Required	Type	Description
Lb Id	lbId	True	uuid	Lb Id
name	name		string
description	description		string

Returns

Body: LearningByteDetailDto

Update lesson content

Operation ID:: updateLesson

Omitted content preserves current value

Parameters

Name	Key	Required	Type	Description
Lesson Id	lessonId	True	uuid	Lesson Id
content	content		string

Returns

Body: LessonDetailDto

Update media metadata

Operation ID:: updateMediaMetadata

Update name and/or description

Parameters

Name	Key	Required	Type	Description
Id	id	True	uuid	Id
name	name		string
description	description		string

Returns

Body: MediaDetailDto

Update module metadata

Operation ID:: updateModule

Updates name and/or description. Omitted fields preserve current values

Parameters

Name	Key	Required	Type	Description
Module Id	moduleId	True	uuid	Module Id
name	name		string
description	description		string

Returns

Body: ModuleDetailDto

Update one quiz question on a module

Operation ID:: updateModuleQuizQuestion

Provide fields matching the stored type; unrelated fields are ignored.

Parameters

Name	Key	Required	Type	Description
Module Id	moduleId	True	uuid	Module Id
Question Id	questionId	True	uuid	Question Id
text	text		string
text	text	True	string
isCorrect	isCorrect		boolean
expectedAnswer	expectedAnswer		string

Returns

Body: QuestionDto

Update one quiz question on a topic

Operation ID:: updateTopicQuizQuestion

Provide fields matching the stored type; unrelated fields are ignored.

Parameters

Name	Key	Required	Type	Description
Topic Id	topicId	True	uuid	Topic Id
Question Id	questionId	True	uuid	Question Id
text	text		string
text	text	True	string
isCorrect	isCorrect		boolean
expectedAnswer	expectedAnswer		string

Returns

Body: QuestionDto

Update topic metadata

Operation ID:: updateTopic

Updates name and/or description. Omitted fields preserve current values

Parameters

Name	Key	Required	Type	Description
Topic Id	topicId	True	uuid	Topic Id
name	name		string
description	description		string

Returns

Body: TopicDto

Upload a document

Operation ID:: uploadDocument

Multipart upload (file + optional description). Max 50MB.

Parameters

Name	Key	Required	Type	Description
File	file	True	file	File
Description	description		string	Description

Returns

Body: DocumentDetailDto

Upload a media item

Operation ID:: uploadMedia

Multipart upload (file + optional description). Max 50MB for images, 500MB for videos.

Parameters

Name	Key	Required	Type	Description
File	file	True	file	File
Description	description		string	Description

Returns

Body: MediaDetailDto

Definitions

QuizSettingDto

Name	Path	Type	Description
questionType	questionType	string
count	count	integer

TopicDto

Name	Path	Type
id	id	uuid
moduleId	moduleId	uuid
name	name	string
description	description	string
ordinalNumber	ordinalNumber	integer
hasContent	hasContent	boolean
quizSettings	quizSettings	array of QuizSettingDto

IntroDto

Name	Path	Type
id	id	uuid
componentId	componentId	uuid
componentType	componentType	string
introduction	introduction	string
source	source	string
createdAt	createdAt	date-time
updatedAt	updatedAt	date-time

ModuleDetailDto

Name	Path	Type
id	id	uuid
courseId	courseId	uuid
name	name	string
description	description	string
productId	productId	uuid
ordinalNumber	ordinalNumber	integer
lockedForGeneration	lockedForGeneration	boolean
quizSettings	quizSettings	array of QuizSettingDto
topics	topics	array of TopicDto

MediaDetailDto

Name	Path	Type
id	id	uuid
name	name	string
description	description	string
kind	kind	string
mimeType	mimeType	string
sizeBytes	sizeBytes	integer
status	status	string
processingStatus	processingStatus	string
createdAt	createdAt	date-time
uploadedBy	uploadedBy	UploadedByDto
downloadUrl	downloadUrl	string

UploadedByDto

Name	Path	Type
id	id	uuid
kind	kind	string
name	name	string

DocumentDetailDto

Name	Path	Type
id	id	uuid
name	name	string
description	description	string
mimeType	mimeType	string
sizeBytes	sizeBytes	integer
status	status	string
createdAt	createdAt	date-time
uploadedBy	uploadedBy	UploadedByDto
downloadUrl	downloadUrl	string

DepartmentRoleDto

Name	Path	Type
departmentId	departmentId	uuid
departmentName	departmentName	string
roleId	roleId	uuid
roleName	roleName	string

UserDto

Name	Path	Type
id	id	uuid
email	email	string
firstName	firstName	string
lastName	lastName	string
status	status	string
kind	kind	string
isAdmin	isAdmin	boolean
createdAt	createdAt	date-time
departmentRoles	departmentRoles	array of DepartmentRoleDto

QuestionDto

Name	Path	Type
id	id	uuid
type	type	string
parentId	parentId	uuid
parentType	parentType	string
text	text	string
ordinalNumber	ordinalNumber	integer
source	source	string
expectedAnswer	expectedAnswer	string
options	options	array of QuestionOptionDto
createdAt	createdAt	date-time
updatedAt	updatedAt	date-time

QuestionOptionDto

Name	Path	Type
text	text	string
isCorrect	isCorrect	boolean
ordinalNumber	ordinalNumber	integer

QuestionListResponse

Name	Path	Type	Description
items	items	array of QuestionDto

LearningByteDetailDto

Name	Path	Type
id	id	uuid
topicId	topicId	uuid
name	name	string
description	description	string
ordinalNumber	ordinalNumber	integer
source	source	string
createdAt	createdAt	date-time
updatedAt	updatedAt	date-time
lessons	lessons	array of LessonDto

LessonDto

Name	Path	Type
id	id	uuid
learningByteId	learningByteId	uuid
content	content	string
ordinalNumber	ordinalNumber	integer
source	source	string
questionCount	questionCount	integer
mediaCount	mediaCount	integer
createdAt	createdAt	date-time
updatedAt	updatedAt	date-time

ExerciseDto

Name	Path	Type
id	id	uuid
topicId	topicId	uuid
type	type	string
prompt	prompt	string
ordinalNumber	ordinalNumber	integer
source	source	string
isGenerated	isGenerated	boolean
avatarPictureId	avatarPictureId	uuid
avatarCharacteristics	avatarCharacteristics	string
reverseRolePlayEnabled	reverseRolePlayEnabled	boolean
reverseRolePlayMandatory	reverseRolePlayMandatory	boolean
generatedContent	generatedContent	ExerciseGeneratedContentDto
createdAt	createdAt	date-time
updatedAt	updatedAt	date-time

ExerciseGeneratedContentDto

Name	Path	Type
id	id	uuid
regenerationId	regenerationId	uuid
scenario	scenario	string
traineeRole	traineeRole	string
avatarName	avatarName	string
avatarDescription	avatarDescription	string
operationalChallenge	operationalChallenge	string
successMetric	successMetric	string
instruction	instruction	string
instructionReverse	instructionReverse	string
exerciseKnowledgeBase	exerciseKnowledgeBase	string
topicKnowledgeBase	topicKnowledgeBase	string

TopicListResponse

Name	Path	Type	Description
items	items	array of TopicDto

LessonDetailDto

Name	Path	Type
id	id	uuid
learningByteId	learningByteId	uuid
content	content	string
ordinalNumber	ordinalNumber	integer
source	source	string
createdAt	createdAt	date-time
updatedAt	updatedAt	date-time
media	media	array of MediaLinkDto
questions	questions	array of QuestionDto

MediaLinkDto

Name	Path	Type
id	id	uuid
fileId	fileId	uuid
ordinalNumber	ordinalNumber	integer
source	source	string

ExpertDetailDto

Name	Path	Type
id	id	uuid
name	name	string
description	description	string
status	status	string
linkedDocumentCount	linkedDocumentCount	integer
createdAt	createdAt	date-time
updatedAt	updatedAt	date-time
assignedRoleIds	assignedRoleIds	array of uuid
assignedDepartmentIds	assignedDepartmentIds	array of uuid
linkedDocuments	linkedDocuments	array of LinkedDocumentDto

LinkedDocumentDto

Name	Path	Type
id	id	uuid
name	name	string
extension	extension	string
sizeBytes	sizeBytes	integer
description	description	string
linkedAt	linkedAt	date-time

AskResponse

Name	Path	Type	Description
answer	answer	string
durationMs	durationMs	integer

DepartmentDto

Name	Path	Type
id	id	uuid
name	name	string
description	description	string
status	status	string
createdAt	createdAt	date-time
roles	roles	array of DepartmentRoleDto

DemoTrainingDto

Name	Path	Type
id	id	uuid
companyId	companyId	uuid
departmentId	departmentId	uuid
name	name	string
description	description	string
trainingType	trainingType	string
status	status	string
isAvailable	isAvailable	boolean
videoFileId	videoFileId	uuid
processingPrompt	processingPrompt	string
errorMessage	errorMessage	string
assignedRoleIds	assignedRoleIds	array of uuid
segments	segments	array of DemoTrainingSegmentDto
createdAt	createdAt	date-time
updatedAt	updatedAt	date-time

DemoTrainingSegmentDto

Name	Path	Type
id	id	uuid
ordinalNumber	ordinalNumber	integer
name	name	string
transcript	transcript	string
durationSeconds	durationSeconds	integer

CourseDetailDto

Name	Path	Type
id	id	uuid
name	name	string
status	status	string
moduleCount	moduleCount	integer
topicCount	topicCount	integer
hasUnpublishedChanges	hasUnpublishedChanges	boolean
currentVersionNumber	currentVersionNumber	integer
createdAt	createdAt	date-time
updatedAt	updatedAt	date-time
assignedRoleIds	assignedRoleIds	array of uuid
assignedDepartmentIds	assignedDepartmentIds	array of uuid
modules	modules	array of ModuleSummaryDto

ModuleSummaryDto

Name	Path	Type
id	id	uuid
name	name	string
ordinalNumber	ordinalNumber	integer
topicCount	topicCount	integer

GenerationRequestResponse

Name	Path	Type	Description
id	id	uuid
status	status	string

ModuleDto

Name	Path	Type
id	id	uuid
courseId	courseId	uuid
name	name	string
description	description	string
productId	productId	uuid
ordinalNumber	ordinalNumber	integer
lockedForGeneration	lockedForGeneration	boolean
topicCount	topicCount	integer
quizSettings	quizSettings	array of QuizSettingDto

ModuleListResponse

Name	Path	Type	Description
items	items	array of ModuleDto

GenerateCourseResponse

Name	Path	Type	Description
courseId	courseId	uuid
generationRequestId	generationRequestId	uuid

PageInfo

Name	Path	Type
size	size	integer
number	number	integer
totalElements	totalElements	integer
totalPages	totalPages	integer

UserListResponse

Name	Path	Type	Description
items	items	array of UserDto
page	page	PageInfo

TopicLinkedDocumentDto

Name	Path	Type
id	id	uuid
name	name	string
extension	extension	string
size	size	integer
processingStatus	processingStatus	string
description	description	string
source	source	string
linkType	linkType	string
linkedAt	linkedAt	date-time

TopicLinkedDocumentListResponse

Name	Path	Type	Description
items	items	array of TopicLinkedDocumentDto
page	page	PageInfo

LearningByteDto

Name	Path	Type
id	id	uuid
topicId	topicId	uuid
name	name	string
description	description	string
ordinalNumber	ordinalNumber	integer
source	source	string
lessonCount	lessonCount	integer
createdAt	createdAt	date-time
updatedAt	updatedAt	date-time

LearningByteListResponse

Name	Path	Type	Description
items	items	array of LearningByteDto

ExerciseListResponse

Name	Path	Type	Description
items	items	array of ExerciseDto

CertificateDto

Name	Path	Type
id	id	uuid
enrollmentId	enrollmentId	uuid
studentId	studentId	uuid
companyId	companyId	uuid
courseId	courseId	uuid
courseVersionId	courseVersionId	uuid
studentName	studentName	string
companyName	companyName	string
courseName	courseName	string
serialNumber	serialNumber	string
completedAt	completedAt	date-time
issuedAt	issuedAt	date-time
pdfFileId	pdfFileId	uuid
pdfAvailable	pdfAvailable	boolean

CertificateListResponse

Name	Path	Type	Description
items	items	array of CertificateDto

MediaDto

Name	Path	Type
id	id	uuid
name	name	string
description	description	string
kind	kind	string
mimeType	mimeType	string
sizeBytes	sizeBytes	integer
status	status	string
processingStatus	processingStatus	string
createdAt	createdAt	date-time
uploadedBy	uploadedBy	UploadedByDto

MediaListResponse

Name	Path	Type	Description
items	items	array of MediaDto
page	page	PageInfo

LessonListResponse

Name	Path	Type	Description
items	items	array of LessonDto

CourseBreakdownDto

Name	Path	Type
courseId	courseId	uuid
courseName	courseName	string
progressPercent	progressPercent	integer
hoursSpent	hoursSpent	double
startedAt	startedAt	date-time
completedAt	completedAt	date-time

StudentInsightsDto

Name	Path	Type
userId	userId	uuid
window	window	WindowDto
summary	summary	StudentSummaryDto
byCourse	byCourse	array of CourseBreakdownDto

StudentSummaryDto

Name	Path	Type
activeDays	activeDays	integer
lessonsCompleted	lessonsCompleted	integer
exercisesCompleted	exercisesCompleted	integer
quizzesPassed	quizzesPassed	integer
hoursSpent	hoursSpent	double

WindowDto

Name	Path	Type
kind	kind	string
from	from	date-time
to	to	date-time

EventItemDto

Name	Path	Type
id	id	uuid
kind	kind	string
action	action	string
courseId	courseId	uuid
courseName	courseName	string
occurredAt	occurredAt	date-time

EventListResponse

Name	Path	Type	Description
items	items	array of EventItemDto
page	page	PageInfo

CompanyInsightsDto

Name	Path	Type	Description
companyId	companyId	uuid
summary	summary	CompanySummaryDto

CompanySummaryDto

Name	Path	Type
totalStudents	totalStudents	integer
averageProgressPercent	averageProgressPercent	integer
activeThisWeekCount	activeThisWeekCount	integer
completedCount	completedCount	integer
completionRatePercent	completionRatePercent	integer

ExpertDto

Name	Path	Type
id	id	uuid
name	name	string
description	description	string
status	status	string
linkedDocumentCount	linkedDocumentCount	integer
createdAt	createdAt	date-time
updatedAt	updatedAt	date-time

ExpertListResponse

Name	Path	Type	Description
items	items	array of ExpertDto
page	page	PageInfo

DocumentDto

Name	Path	Type
id	id	uuid
name	name	string
description	description	string
mimeType	mimeType	string
sizeBytes	sizeBytes	integer
status	status	string
createdAt	createdAt	date-time
uploadedBy	uploadedBy	UploadedByDto

DocumentListResponse

Name	Path	Type	Description
items	items	array of DocumentDto
page	page	PageInfo

DepartmentListResponse

Name	Path	Type	Description
items	items	array of DepartmentDto

DemoTrainingListItemDto

Name	Path	Type
id	id	uuid
departmentId	departmentId	uuid
videoFileId	videoFileId	uuid
name	name	string
description	description	string
trainingType	trainingType	string
status	status	string
isAvailable	isAvailable	boolean
assignedRoleIds	assignedRoleIds	array of uuid
segmentCount	segmentCount	integer
durationSeconds	durationSeconds	integer
createdAt	createdAt	date-time

DemoTrainingListResponse

Name	Path	Type	Description
items	items	array of DemoTrainingListItemDto
page	page	PageInfo

CourseDto

Name	Path	Type
id	id	uuid
name	name	string
status	status	string
moduleCount	moduleCount	integer
topicCount	topicCount	integer
hasUnpublishedChanges	hasUnpublishedChanges	boolean
currentVersionNumber	currentVersionNumber	integer
latestPublishedAt	latestPublishedAt	date-time
createdAt	createdAt	date-time

CourseListResponse

Name	Path	Type	Description
items	items	array of CourseDto
page	page	PageInfo

GenerationProgressDto

Name	Path	Type
totalTasks	totalTasks	integer
completedTasks	completedTasks	integer
failedTasks	failedTasks	integer

GenerationRequestInfoDto

Name	Path	Type
id	id	uuid
status	status	string
createdAt	createdAt	string
completedAt	completedAt	string
error	error	string
progress	progress	GenerationProgressDto
target	target	string
targetId	targetId	uuid
parentType	parentType	string
topicIds	topicIds	array of uuid
moduleIds	moduleIds	array of uuid

GenerationStatusResponse

Name	Path	Type	Description
activeRequests	activeRequests	array of GenerationRequestInfoDto

CourseVersionDto

Name	Path	Type
id	id	uuid
courseId	courseId	uuid
versionNumber	versionNumber	integer
publishedAt	publishedAt	date-time
publishedBy	publishedBy	uuid
moduleCount	moduleCount	integer
topicCount	topicCount	integer
lessonCount	lessonCount	integer
exerciseCount	exerciseCount	integer
questionCount	questionCount	integer
estimatedTimeSeconds	estimatedTimeSeconds	integer

CourseVersionListResponse

Name	Path	Type	Description
items	items	array of CourseVersionDto

AuditSnapshot

Name	Path	Type
createdAt	createdAt	date-time
createdBy	createdBy	uuid
updatedAt	updatedAt	date-time
updatedBy	updatedBy	uuid

CourseSnapshot

Name	Path	Type
name	name	string
coverImageId	coverImageId	uuid
prerequisiteCourseId	prerequisiteCourseId	uuid
courseGuideline	courseGuideline	string
lessonsGuideline	lessonsGuideline	string
questionsGuideline	questionsGuideline	string
exercisesGuideline	exercisesGuideline	string
modules	modules	array of ModuleSnapshot

CourseVersionSnapshotDto

Name	Path	Type
id	id	uuid
courseId	courseId	uuid
versionNumber	versionNumber	integer
snapshot	snapshot	CourseSnapshot

ExerciseSnapshot

Name	Path	Type
id	id	uuid
topicId	topicId	uuid
exerciseType	exerciseType	string
prompt	prompt	string
ordinalNumber	ordinalNumber	integer
isGenerated	isGenerated	boolean
source	source	string
audit	audit	AuditSnapshot
avatarCharacteristics	avatarCharacteristics	string
avatarPictureId	avatarPictureId	uuid
reverseRolePlayEnabled	reverseRolePlayEnabled	boolean
reverseRolePlayMandatory	reverseRolePlayMandatory	boolean
scenario	scenario	string
traineeRole	traineeRole	string
avatarName	avatarName	string
avatarDescription	avatarDescription	string
operationalChallenge	operationalChallenge	string
successMetric	successMetric	string
instruction	instruction	string
instructionReverse	instructionReverse	string
exerciseKnowledgeBase	exerciseKnowledgeBase	string

LearningByteSnapshot

Name	Path	Type
id	id	uuid
topicId	topicId	uuid
name	name	string
description	description	string
ordinalNumber	ordinalNumber	integer
source	source	string
audit	audit	AuditSnapshot
lessons	lessons	array of LessonSnapshot

LessonSnapshot

Name	Path	Type
id	id	uuid
learningByteId	learningByteId	uuid
content	content	string
ordinalNumber	ordinalNumber	integer
source	source	string
audit	audit	AuditSnapshot
media	media	array of MediaSnapshot
questions	questions	array of QuestionSnapshot

LinkedDocumentSnapshot

Name	Path	Type
id	id	uuid
fileId	fileId	uuid
linkType	linkType	string
isSupplement	isSupplement	boolean
name	name	string
extension	extension	string
size	size	integer
description	description	string

MediaSnapshot

Name	Path	Type
id	id	uuid
fileId	fileId	uuid
ordinalNumber	ordinalNumber	integer
mediaType	mediaType	string
source	source	string

ModuleSnapshot

Name	Path	Type
id	id	uuid
courseId	courseId	uuid
productId	productId	uuid
name	name	string
description	description	string
intro	intro	string
ordinalNumber	ordinalNumber	integer
quizSettings	quizSettings	array of QuizSettingSnapshot
quizQuestions	quizQuestions	array of QuestionSnapshot
topics	topics	array of TopicSnapshot

OptionSnapshot

Name	Path	Type
id	id	uuid
optionText	optionText	string
isCorrect	isCorrect	boolean
ordinalNumber	ordinalNumber	integer

QuestionSnapshot

Name	Path	Type
id	id	uuid
questionType	questionType	string
questionText	questionText	string
expectedAnswer	expectedAnswer	string
ordinalNumber	ordinalNumber	integer
source	source	string
audit	audit	AuditSnapshot
options	options	array of OptionSnapshot

QuizSettingSnapshot

Name	Path	Type	Description
questionType	questionType	string
count	count	integer

TopicSnapshot

Name	Path	Type
id	id	uuid
moduleId	moduleId	uuid
name	name	string
description	description	string
intro	intro	string
ordinalNumber	ordinalNumber	integer
quizSettings	quizSettings	array of QuizSettingSnapshot
quizQuestions	quizQuestions	array of QuestionSnapshot
learningBytes	learningBytes	array of LearningByteSnapshot
exercises	exercises	array of ExerciseSnapshot
linkedDocuments	linkedDocuments	array of LinkedDocumentSnapshot
topicKnowledgeBase	topicKnowledgeBase	string

StreamingResponseBody