Skip to content
API Reference
/
ai-mentor
/
ai_mentor_orgs_users_course_creation_component_create

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_component_list

Request

API viewset for managing course units.

This viewset allows platform administrators to retrieve and manage units within course subsections, and generate content for them.

Permissions:

  • Restricted to platform administrators only
Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Query
courseinteger
orderingstring

Which field to use when ordering the results.

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

searchstring

A search term.

sectioninteger
subsectioninteger
taskinteger
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/course-creation/component/?course=0&ordering=string&page=0&page_size=0&search=string&section=0&subsection=0&task=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(Unit)required
results[].​idintegerread-onlyrequired
results[].​subsectionintegerrequired
results[].​display_namestring<= 255 charactersrequired
results[].​statusstringread-onlyrequired
  • published - Published
  • draft - Unsynced
  • error - Error
  • syncing - Syncing
Enum"published""draft""error""syncing"
results[].​typestring(TypeC42Enum)
  • tutorial - Tutorial
  • assessment - Assessment
Enum"tutorial""assessment"
results[].​created_atstring(date-time)read-onlyrequired
results[].​updated_atstring(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_mentor_orgs_users_course_creation_component_create

Request

API viewset for managing course units.

This viewset allows platform administrators to retrieve and manage units within course subsections, and generate content for them.

Permissions:

  • Restricted to platform administrators only
Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Body
required
subsectionintegerrequired
display_namestring<= 255 charactersrequired
typestring(TypeC42Enum)
  • tutorial - Tutorial
  • assessment - Assessment
Enum"tutorial""assessment"
curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/course-creation/component/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "subsection": 0,
    "display_name": "string",
    "type": "tutorial"
  }'

Responses

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

ai_mentor_orgs_users_course_creation_component_retrieve

Request

API viewset for managing course units.

This viewset allows platform administrators to retrieve and manage units within course subsections, and generate content for them.

Permissions:

  • Restricted to platform administrators only
Security
PlatformApiKeyAuthentication
Path
idintegerrequired

A unique integer value identifying this unit.

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

Responses

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

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