Skip to content
API Reference/
/
ai_mentor_orgs_users_cour...

ibl-data-manager (4.84.1-ai-plus)

API for iblai

Download OpenAPI description
ibl.json
ibl.yaml
Languages
Servers
Mock server
https://docs.ibl.ai/_mock/apis/ibl/
https://base.manager.iblai.app/

ai-account

Operations

ai-analytics

Operations

ai-bot

Operations

ai-finetuning

Operations

ai-index

Operations

ai-marketing

Operations

ai-media

Operations

ai-mentor

Operations

ai_mentor_orgs_users_course_creation_tasks_retrieve

Request

Create, retrieve and delete course creation tasks

Course creation tasks allow you to schedule the creation of a course on OpenEdx deployment connected to this data manager.

The course is created entirely by an ai model (as specified in your inputs).

The llm decides on the content of the course based on the name, description, target audience and other parameters. Bigger and newer models tend to outperform smaller once.

Clear and unambiguous parameters are more likely to produce better results.

Security
PlatformApiKeyAuthentication
Path
idintegerrequired

A unique integer value identifying this course creation task.

orgstringrequired
user_idstringrequired
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/course-creation-tasks/{id}/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
idintegerread-onlyrequired
user_idstringread-onlyrequired
studentinteger[ 0 .. 2147483647 ]read-onlyrequired

edX user ID

namestring<= 200 charactersrequired
descriptionstringrequired

Description of the course to create and its requirements

target_audiencestring<= 200 charactersrequired

The intended audience for the course. eg. Grade 11 students.

platformintegerread-onlyrequired
platform_keystringread-onlyrequired
statusstringread-onlyrequired
Enum"Pending""Scheduled""Success""Failed""Cancelled""In Progress"
publish_courseboolean
course_dataanyread-onlyrequired
providerstring<= 20 characters
modelstring<= 150 characters
desired_number_of_sectionsinteger[ 0 .. 2147483647 ]
logsstringread-onlyrequired
filesArray of objects(CourseCreationTaskFile)read-onlyrequired
files[].​idintegerread-onlyrequired
files[].​course_creation_taskintegerrequired
files[].​filestring(uri)required
files[].​date_createdstring(date-time)read-onlyrequired
files[].​last_modifiedstring(date-time)read-onlyrequired
date_createdstring(date-time)read-onlyrequired
last_modifiedstring(date-time)read-onlyrequired
Response
application/json
{
  "id": 0,
  "user_id": "string",
  "student": 2147483647,
  "name": "string",
  "description": "string",
  "target_audience": "string",
  "platform": 0,
  "platform_key": "string",
  "status": "Pending",
  "publish_course": true,
  "course_data": null,
  "provider": "string",
  "model": "string",
  "desired_number_of_sections": 2147483647,
  "logs": "string",
  "files": [
    { … }
  ],
  "date_created": "2019-08-24T14:15:22Z",
  "last_modified": "2019-08-24T14:15:22Z"
}

ai_mentor_orgs_users_course_creation_tasks_destroy

Request

Create, retrieve and delete course creation tasks

Course creation tasks allow you to schedule the creation of a course on OpenEdx deployment connected to this data manager.

The course is created entirely by an ai model (as specified in your inputs).

The llm decides on the content of the course based on the name, description, target audience and other parameters. Bigger and newer models tend to outperform smaller once.

Clear and unambiguous parameters are more likely to produce better results.

Security
PlatformApiKeyAuthentication
Path
idintegerrequired

A unique integer value identifying this course creation task.

orgstringrequired
user_idstringrequired
curl -i -X DELETE \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/course-creation-tasks/{id}/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

No response body

ai_mentor_orgs_users_course_creation_tasks_cancel_retrieve

Request

Cancel a course creation task run. ** Conditions Required **: The task must be running or pending. ** Response **:

  • 200: The course creation task is successfully cancelled.
  • 400: The course creation task is not in a running or pending state.
Security
PlatformApiKeyAuthentication
Path
idintegerrequired

A unique integer value identifying this course creation task.

orgstringrequired
user_idstringrequired
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/course-creation-tasks/{id}/cancel/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
idintegerread-onlyrequired
user_idstringread-onlyrequired
studentinteger[ 0 .. 2147483647 ]read-onlyrequired

edX user ID

namestring<= 200 charactersrequired
descriptionstringrequired

Description of the course to create and its requirements

target_audiencestring<= 200 charactersrequired

The intended audience for the course. eg. Grade 11 students.

platformintegerread-onlyrequired
platform_keystringread-onlyrequired
statusstringread-onlyrequired
Enum"Pending""Scheduled""Success""Failed""Cancelled""In Progress"
publish_courseboolean
course_dataanyread-onlyrequired
providerstring<= 20 characters
modelstring<= 150 characters
desired_number_of_sectionsinteger[ 0 .. 2147483647 ]
logsstringread-onlyrequired
filesArray of objects(CourseCreationTaskFile)read-onlyrequired
files[].​idintegerread-onlyrequired
files[].​course_creation_taskintegerrequired
files[].​filestring(uri)required
files[].​date_createdstring(date-time)read-onlyrequired
files[].​last_modifiedstring(date-time)read-onlyrequired
date_createdstring(date-time)read-onlyrequired
last_modifiedstring(date-time)read-onlyrequired
Response
application/json
{
  "id": 0,
  "user_id": "string",
  "student": 2147483647,
  "name": "string",
  "description": "string",
  "target_audience": "string",
  "platform": 0,
  "platform_key": "string",
  "status": "Pending",
  "publish_course": true,
  "course_data": null,
  "provider": "string",
  "model": "string",
  "desired_number_of_sections": 2147483647,
  "logs": "string",
  "files": [
    { … }
  ],
  "date_created": "2019-08-24T14:15:22Z",
  "last_modified": "2019-08-24T14:15:22Z"
}

ai-prompt

Operations

analytics

Operations

career

Operations

catalog

Operations

core

Operations

credentials

Operations

custom-domains

Operations

features

Operations

media

Operations

notifications

Operations

scim

Operations

commerce

Operations

recommendations

Operations

reports

Operations

skills

Operations
Copyright © ibl.ai | support@iblai.zendesk.com