API DOCUMENTATION

Teacher Endpoints

Manage learning paths and experiments for teachers.

Create Learning Path with Experiment

POST


                                                    {Tenant
                                                        endpoint}/api/v2/learning-path/teacher/experiment

Tenant endpoint example: yoursubdomain.jusoorlabs.com
Create a new learning path with a linked experiment. Some parameters are optional.

Important: Creating an experiment returns an experiment_token, which is required for all future actions:

Update the experiment
Get student grades
Delete the experiment

Store this token securely, as it grants access to the experiment.

Headers

Name	Required	Type	Description
referer	YES	string	The root of the application sending the request (e.g., jusoorlabs.com)
accept	YES	string	Always set as `application/json`
token	YES	string	The API token provided by Jusoor Labs.

Parameters

Name	Type	Description
subject_name	string	(Required) Name for the subject. Displayed in UI and reports.
description	string	(Optional) Free text for additional description or internal notes.
subject_uuid	uuid/string	(Required) Unique identifier for the subject. Must be globally unique and immutable.
experiment_id	integer	(Required) Internal numeric ID of the experiment.
experiment_name	string	(Required) Experiment name.
max_attempts	integer	(Required) Maximum number of allowed attempts. Value must be ≥ 1.
start_at	datetime	(Optional) Experiment start datetime. Format: YYYY-MM-DD HH:mm:ss.
end_at	datetime	(Optional) Experiment end datetime. Must be later than start_at if both are provided.
teacher_uuid[0]	string	(Required) Unique identifier of the assigned teacher.
teacher_name[0]	string	(Required) Display name of the assigned teacher.
teacher_uuid[1]	string	Optional additional teacher UUID.
teacher_name[1]	string	Optional additional teacher name.

Update Learning Path

PATCH


                                                    {Tenant
                                                        endpoint}/api/v2/learning-path/teacher/{subject_uuid}

Tenant endpoint example: yoursubdomain.jusoorlabs.com
Update the learning path information. Only subject_name is required.

Headers

Name	Required	Type	Description
referer	YES	string	The root of the application sending the request (e.g., jusoorlabs.com)
accept	YES	string	Always set as `application/json`
token	YES	string	The API token provided by Jusoor Labs.

Parameters

Name	Type	Description
subject_name	string	(Required) Name for the subject. Displayed in UI and reports.
description	string	(Optional) Free text for additional description or internal notes.

Update Experiment

PATCH


                                            {Tenant
                                                endpoint}/api/v2/learning-path/teacher/experiment/{experiment_token}

Tenant endpoint example: yoursubdomain.jusoorlabs.com
Update experiment details using experiment_token returned at creation. Store this token for future operations.

Headers

Name	Required	Type	Description
referer	YES	string	The root of the application sending the request (e.g., jusoorlabs.com)
accept	YES	string	Always set as `application/json`
token	YES	string	The API token provided by Jusoor Labs.

Parameters

Name	Type	Description
experiment_name	string	(Required) Experiment name.
max_attempts	integer	(Required) Maximum number of allowed attempts. Must be ≥ 1.
start_at	datetime	(Optional) Experiment start datetime. Format: YYYY-MM-DD HH:mm:ss.
end_at	datetime	(Optional) Experiment end datetime. Must be later than start_at if provided.