Skip to content
API Reference/
/
ai_mentor_orgs_users_subj...

ibl-data-manager (4.84.1-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_starred_mentors_list

Request

Retrieve a list of mentors starred by a specific user.

Args: request: The HTTP request. org: The organization/tenant identifier. user_id: The ID of the user to retrieve starred mentors for.

Returns: Response: A list of the user's starred mentors, sorted by most recently accessed.

Raises: NotFound: If the specified student does not exist. BadRequest: If the request is invalid.

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/starred-mentors/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/jsonArray [
is_starredboolean
updated_atstringread-onlyrequired
mentorstringread-onlyrequired
studentstringread-onlyrequired
recently_accessed_atstring or nullread-onlyrequired
]
Response
application/json
[
  [
    { … },
    { … }
  ]
]

ai_mentor_orgs_users_subjects_list

Request

Retrieve Subjects

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

Responses

Bodyapplication/jsonArray [
idintegerread-onlyrequired
namestring<= 255 charactersrequired
descriptionstring or null
]
Response
application/json
[
  [
    { … },
    { … }
  ]
]

ai_mentor_orgs_users_support_ticket_messages_list

Request

ViewSet for managing ticket messages.

This ViewSet provides endpoints to retrieve, create, and update ticket messages.

Permissions: - Platform Admins: - Platform admins are able to view all ticket messages for the tenant. - Students: - Students are able to view all ticket messages for only the ticket they are associated with.

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.

senderstring
ticketnumber
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/support-ticket-messages/?page=0&page_size=0&sender=string&ticket=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(TicketMessage)required
results[].​idintegerread-onlyrequired
results[].​ticketintegerrequired
results[].​senderinteger or null[ 0 .. 2147483647 ]

edX user ID

results[].​messagestringrequired
results[].​timestampstring(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

analytics

Operations

career

Operations

catalog

Operations

core

Operations

credentials

Operations

custom-domains

Operations

features

Operations

media

Operations

notifications

Operations

scim

Operations

commerce

Operations

recommendations

Operations

reports

Operations

skills

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