Embedded Integration

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 Required string The root of the application sending the request (e.g., jusoorlabs.com)
accept Required string Always set as application/json
token Required 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.
Response

On success, the API creates the experiment and returns an experiment_token, which must be stored and used for all subsequent actions, including updating, fetching grades, deleting, and playing the experiment as a student.

201 Created application/json
{
    "status": true,
    "message": "Experiment created successfully",
    "data": {
        "experiment_token": "b751595d-cf43-4ef0-8655-e7065f3d17fb"
    }
}

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 Required string The root of the application sending the request (e.g., jusoorlabs.com)
accept Required string Always set as application/json
token Required 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 Required string The root of the application sending the request (e.g., jusoorlabs.com)
accept Required string Always set as application/json
token Required 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.

Get Learning Path with Experiment

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

Tenant endpoint example: yoursubdomain.jusoorlabs.com

Headers
Name Required Type Description
referer Required string The root of the application sending the request (e.g., jusoorlabs.com)
accept Required string Always set as application/json
token Required string The API token provided by Jusoor Labs.
Path Parameters
Name Required Type Description
subject_uuid Required uuid/string The unique identifier of the subject, as provided when the learning path was created.
Response

Returns the learning path along with its linked experiment(s), assigned teacher(s), and enrolled student(s).

200 OK application/json
{
    "status": true,
    "data": {
        "learning_path": {
            "id": 5,
            "subject_uuid": "01",
            "subject_name": "Subject1",
            "description": "first class",
            "created_at": "2026-08-11T11:22:06.000000Z",
            "updated_at": "2026-08-11T11:22:06.000000Z"
        },
        "experiments": [
            {
                "id": 2,
                "experiment_id": 14,
                "experiment_name": "Lab1",
                "max_attempts": "5",
                "start_at": null,
                "end_at": null,
                "experiment_token": "dc4e9a42-0de5-474a-8139-0edee88c1b08"
            }
        ],
        "teachers": [
            {
                "id": 13,
                "name": "ali osama",
                "username": null
            }
        ],
        "students": [
            {
                "id": 14,
                "name": "Hamza Alzughbieh",
                "username": null
            }
        ]
    }
}

Get Experiment Grades

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

Tenant endpoint example: yoursubdomain.jusoorlabs.com

Headers
Name Required Type Description
referer Required string The root of the application sending the request (e.g., jusoorlabs.com)
accept Required string Always set as application/json
token Required string The API token provided by Jusoor Labs.
Path Parameters
Name Required Type Description
experiment_token Required uuid/string The unique token of the experiment, returned when the experiment was created.
Response

Returns the experiment's info along with the grade record for every student who attempted it.

200 OK application/json
{
    "status": true,
    "message": "Experiment grades fetched successfully",
    "data": {
        "experiment_token": "dc4e9a42-0de5-474a-8139-0edee88c1b08",
        "experiment_name": "Lab1",
        "grades": [
            {
                "jusoor_uuid": 14,
                "partner_uuid": "hamza-01",
                "student_name": "Hamza Alzughbieh",
                "time": 2.8619997501373,
                "progress": 36,
                "final_step": 4,
                "max_steps": 11,
                "quiz_mark": 100,
                "quiz_time": 0,
                "language": "Arabic",
                "experiment_type": "WithoutInstruction"
            }
        ]
    }
}

Get Learning Path Grades

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

Tenant endpoint example: yoursubdomain.jusoorlabs.com

Headers
Name Required Type Description
referer Required string The root of the application sending the request (e.g., jusoorlabs.com)
accept Required string Always set as application/json
token Required string The API token provided by Jusoor Labs.
Path Parameters
Name Required Type Description
subject_uuid Required uuid/string The unique identifier of the subject, as provided when the learning path was created.
Response

Returns the learning path along with every linked experiment and the grade records of all students who attempted each one.

200 OK application/json
{
    "status": true,
    "message": "Learning path grades fetched successfully",
    "data": {
        "learning_path": {
            "subject_uuid": "1a2e6ba2-d5fd-4a7f-99b3-48cd4a486b98",
            "subject_name": "Subject1"
        },
        "experiments": [
            {
                "experiment_token": "dc4e9a42-0de5-474a-8139-0edee88c1b08",
                "experiment_name": "Lab1",
                "attempts": [
                    {
                        "jusoor_uuid": 14,
                        "partner_uuid": "hamza-01",
                        "student_name": "Hamza Alzughbieh",
                        "time": 2.8619997501373,
                        "progress": 36,
                        "final_step": 4,
                        "max_steps": 11,
                        "quiz_mark": 100,
                        "quiz_time": 0,
                        "language": "Arabic",
                        "experiment_type": "WithoutInstruction",
                        "created_at": "2026-08-11 14:26:09"
                    }
                ]
            }
        ]
    }
}

Delete Experiment

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

Tenant endpoint example: yoursubdomain.jusoorlabs.com

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

Delete Learning Path

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

Tenant endpoint example: yoursubdomain.jusoorlabs.com

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