Skip to content
API Reference
/
ai-mentor
/
ai_mentor_orgs_users_course_creation_course_retrieve

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_course_list

Request

API viewset for managing EdX courses.

This viewset allows platform administrators to retrieve, delete, and perform various operations on EdX courses that were created through course creation tasks.

Permissions:

  • Restricted to platform administrators only
Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Query
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.

taskinteger
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/course-creation/course/?ordering=string&page=0&page_size=0&search=string&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(EdxCourse)required
results[].​idintegerread-onlyrequired
results[].​namestring<= 255 charactersrequired
results[].​runstring<= 50 charactersrequired
results[].​numberstring<= 50 charactersrequired
results[].​descriptionstring
results[].​xblock_idstring<= 200 charactersrequired
results[].​taskinteger or null
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_course_retrieve

Request

API viewset for managing EdX courses.

This viewset allows platform administrators to retrieve, delete, and perform various operations on EdX courses that were created through course creation tasks.

Permissions:

  • Restricted to platform administrators only
Security
PlatformApiKeyAuthentication
Path
idintegerrequired

A unique integer value identifying this edx course.

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

Responses

Bodyapplication/json
idintegerread-onlyrequired
namestring<= 255 charactersrequired
runstring<= 50 charactersrequired
numberstring<= 50 charactersrequired
descriptionstring
xblock_idstring<= 200 charactersrequired
taskinteger or null
created_atstring(date-time)read-onlyrequired
updated_atstring(date-time)read-onlyrequired
Response
application/json
{
  "id": 0,
  "name": "string",
  "run": "string",
  "number": "string",
  "description": "string",
  "xblock_id": "string",
  "task": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

ai_mentor_orgs_users_course_creation_course_destroy

Request

API viewset for managing EdX courses.

This viewset allows platform administrators to retrieve, delete, and perform various operations on EdX courses that were created through course creation tasks.

Permissions:

  • Restricted to platform administrators only
Security
PlatformApiKeyAuthentication
Path
idintegerrequired

A unique integer value identifying this edx course.

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

Responses

No response body

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