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

Operations

career

Operations

catalog

Operations

catalog_programs_destroy

Request

Remove a program from the database. Requires program_id and org as parameters.

Security
PlatformApiKeyAuthentication
Query
orgstringnon-emptyrequired

Organization of the program

program_idstringnon-emptyrequired

Program ID to delete

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

Responses

Bodyapplication/json
countintegerrequired

Number of programs deleted

typeobjectrequired

Types of objects deleted

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

catalog_recommendation_courses_retrieve

Request

GET Get a 'next' course

This method retrieves the next recommended course for a user based on the provided parameters. It expects the following parameters in the request query:

  • user_id: The ID of the user for whom the next course is being recommended.
  • course_id: The ID of the current course.
  • org: The organization associated with the course.

Returns:

  • A serialized representation of the next course if found, with a status code of 200.
  • A status code of 400 if the course_id is not provided.
  • A status code of 200 with a None response if no next course is found.

Error Conditions:

  • Returns a 400 status code if the course_id is missing from the request parameters.

Side Effects:

  • None
Security
PlatformApiKeyAuthentication
Query
course_idstringnon-emptyrequired

Current course ID

orgstringnon-empty

Organization to filter recommendations

user_idstringnon-empty

User ID for personalized recommendations

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

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_resources_list

Request

Retrieve resources matching query. Limited parameters.

Security
PlatformApiKeyAuthentication
Query
idinteger

Resource ID

item_idstringnon-empty

Item ID associated with the resource

keystringnon-empty

Platform key

namestringnon-empty

Resource name

orgstringnon-empty

Platform organization

platform_keystringnon-empty

Platform key (alternative to key)

platform_orgstringnon-empty

Platform organization (alternative to org)

resource_typestringnon-empty

Type of resource

user_idinteger

User ID who owns the resource

usernamestringnon-empty

Username who owns the resource

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/resources/?id=0&item_id=string&key=string&name=string&org=string&platform_key=string&platform_org=string&resource_type=string&user_id=0&username=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/jsonArray [
item_idstring
idintegerread-onlyrequired
namestring or nullread-onlyrequired

The display name of the resource.

urlstring or nullread-onlyrequired

Resource URL.

resource_typestring or nullread-onlyrequired

Resource type.

dataany or nullread-onlyrequired

Metadata

imagestring or null(uri)
descriptionstring or null
]
Response
application/json
[
  {
    "item_id": "string",
    "id": 0,
    "name": "string",
    "url": "string",
    "resource_type": "string",
    "data": null,
    "image": "http://example.com",
    "description": "string"
  }
]

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