Generate Course Structure

POST https://api.deep-learn.ai/v1/course/structure

Given some source text the DeepLearn model will produce a well structured list of page titles representing the course.

Request body

text

string

Required

Text to be used as the source for the course structure.

courseTitle

string

Optional

The title of the course, this helps to give the model context for the course structure.

learnerDescription

string

Optional

A description of the learner. Eg. "A beginner who want to learn about machine learning."

learnerLanguageLevel

string

Optional

Defaults to "adult"

A description of the learner's language level. Eg. "adult", "6 year old child child", "English not first language".

learningObjectives

string[]

Optional

An array of learning objectives for the course. The model will use these to ensure the learning objectives are covered in the course structure.

approxNumberOfPages

number

Optional

Defaults to 10

The approximate number of pages the course should have.

structure

string[]

An array of page titles representing the course structure.

success

boolean

Indicates if the request was successful.

errorCode

number or null

The error code if the request was not successful.

errorMessage

string or null

The error message if the request was not successful.