Skip to content
API Reference
/
ai-mentor
/
ai_mentor_orgs_users_course_creation_subsection_destroy

ibl-data-manager (3.59.0-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_subsection_partial_update

Request

API viewset for managing course subsections.

This viewset allows platform administrators to retrieve and manage subsections within course sections.

Permissions:

  • Restricted to platform administrators only
Security
PlatformApiKeyAuthentication
Path
idintegerrequired

A unique integer value identifying this sub section.

orgstringrequired
user_idstringrequired
Body
sectioninteger
display_namestring<= 255 characters
curl -i -X PATCH \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/course-creation/subsection/{id}/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "section": 0,
    "display_name": "string"
  }'

Responses

Bodyapplication/json
idintegerread-onlyrequired
sectionintegerrequired
display_namestring<= 255 charactersrequired
statusstringread-onlyrequired
  • published - Published
  • draft - Unsynced
  • error - Error
  • syncing - Syncing
Enum"published""draft""error""syncing"
created_atstring(date-time)read-onlyrequired
updated_atstring(date-time)read-onlyrequired
Response
application/json
{
  "id": 0,
  "section": 0,
  "display_name": "string",
  "status": "published",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

ai_mentor_orgs_users_course_creation_subsection_destroy

Request

API viewset for managing course subsections.

This viewset allows platform administrators to retrieve and manage subsections within course sections.

Permissions:

  • Restricted to platform administrators only
Security
PlatformApiKeyAuthentication
Path
idintegerrequired

A unique integer value identifying this sub section.

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

Responses

No response body

ai_mentor_orgs_users_course_creation_tasks_list_2

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
orgstringrequired
user_idstringrequired
Query
pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/course-creation/tasks/?page=0&page_size=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
countintegerrequired
Example: 123
nextstring or null(uri)
Example: "http://api.example.org/accounts/?page=4"
previousstring or null(uri)
Example: "http://api.example.org/accounts/?page=2"
resultsArray of objects(CourseCreationTask)required
results[].​idintegerread-onlyrequired
results[].​user_idstringread-onlyrequired
results[].​studentinteger[ 0 .. 2147483647 ]read-onlyrequired

edX user ID

results[].​namestring<= 200 charactersrequired
results[].​descriptionstringrequired

Description of the course to create and its requirements

results[].​target_audiencestring<= 200 charactersrequired

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

results[].​platformintegerread-onlyrequired
results[].​platform_keystringread-onlyrequired
results[].​statusstringread-onlyrequired
  • Pending - Pending
  • Scheduled - Scheduled
  • Success - Success
  • Failed - Failed
  • Cancelled - Cancelled
  • In Progress - In Progress
Enum"Pending""Scheduled""Success""Failed""Cancelled""In Progress"
results[].​publish_courseboolean
results[].​course_dataanyread-onlyrequired
results[].​providerstring<= 20 characters
results[].​modelstring<= 150 characters
results[].​desired_number_of_sectionsinteger[ 0 .. 2147483647 ]
results[].​logsstringread-onlyrequired
results[].​filesArray of objects(CourseCreationTaskFile)read-onlyrequired
results[].​files[].​idintegerread-onlyrequired
results[].​files[].​course_creation_taskintegerrequired
results[].​files[].​filestring(uri)required
results[].​files[].​date_createdstring(date-time)read-onlyrequired
results[].​files[].​last_modifiedstring(date-time)read-onlyrequired
results[].​date_createdstring(date-time)read-onlyrequired
results[].​last_modifiedstring(date-time)read-onlyrequired
Response
application/json
{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    { … }
  ]
}

ai-prompt

Operations

career

Operations

catalog

Operations

core

Operations

credentials

Operations

features

Operations

media

Operations

notifications

Operations

scim

Operations

commerce

Operations

recommendations

Operations

reports

Operations

skills

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