Skip to content
API Reference
/
catalog
/
catalog_courses_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-prompt

Operations

career

Operations

catalog

Operations

catalog_courses_list

Request

Retrieve courses matching specified filters.

Security
PlatformApiKeyAuthentication
Query
course_idstringnon-empty

Filter courses by their unique identifier

orgstringnon-empty

Filter courses by their associated organization

slugstringnon-empty

Filter courses by their slug (case-insensitive)

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/courses/?course_id=string&org=string&slug=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/jsonArray [
course_idstringread-onlyrequired

The edX course ID string for the course.

namestringread-onlyrequired

The display name of the course. (Should match edX)

slugstring or null^[-a-zA-Z0-9_]+$read-onlyrequired

An additional unique slug field. (Optional)

orgstring
]
Response
application/json
[
  {
    "course_id": "string",
    "name": "string",
    "slug": "string",
    "org": "string"
  }
]

catalog_courses_create

Request

Add or update a course in the database.

Security
PlatformApiKeyAuthentication
Query
course_idstringnon-empty

Filter courses by their unique identifier

orgstringnon-empty

Filter courses by their associated organization

slugstringnon-empty

Filter courses by their slug (case-insensitive)

Body
required
course_idstringrequired

The unique identifier for the course

orgstringrequired

The organization associated with the course

namestring

The name of the course

slugstring

The slug for the course

dataany

Additional course data

curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/courses/?course_id=string&org=string&slug=string' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "course_id": "string",
    "org": "string",
    "name": "string",
    "slug": "string",
    "data": null
  }'

Responses

Bodyapplication/json
course_idstringread-onlyrequired

The edX course ID string for the course.

namestringread-onlyrequired

The display name of the course. (Should match edX)

slugstring or null^[-a-zA-Z0-9_]+$read-onlyrequired

An additional unique slug field. (Optional)

orgstring
Response
application/json
{
  "course_id": "string",
  "name": "string",
  "slug": "string",
  "org": "string"
}

catalog_courses_destroy

Request

Remove a course from the database.

Security
PlatformApiKeyAuthentication
Query
course_idstringnon-emptyrequired

The unique identifier for the course to be deleted

orgstringnon-empty

Filter courses by their associated organization

slugstringnon-empty

Filter courses by their slug (case-insensitive)

curl -i -X DELETE \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/courses/?course_id=string&org=string&slug=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
countintegerrequired

Number of courses deleted

typeobjectrequired

Types of objects deleted

type.​property name*anyadditional property
Response
application/json
{
  "count": 0,
  "type": {
    "property1": null,
    "property2": null
  }
}

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