Skip to content
API Reference/
/
ai_mentor_orgs_users_cust...

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_custom_instruction_create

Request

Create a new custom instruction for a user.

Args: request: The HTTP request containing the custom instruction data. org: The organization/tenant identifier. user_id: The ID of the user to create custom instructions for.

Returns: Response: The created custom instruction.

Raises: BadRequest: If the provided data is invalid.

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Body
about_userstring or null
mentor_tonestring or null
professionstring<= 100 characters

Position or work. eg: Engineer, student etc.

desired_mentor_traitsstring

Comma separated list of expected traits for mentor.

curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/custom-instruction/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "content": "Always explain concepts in simple terms with examples."
  }'

Responses

Bodyapplication/json
idintegerread-onlyrequired
about_userstring or null
mentor_tonestring or null
professionstring<= 100 characters

Position or work. eg: Engineer, student etc.

desired_mentor_traitsstring

Comma separated list of expected traits for mentor.

Response
application/json
{
  "id": 1,
  "username": "johndoe",
  "platform_key": "main",
  "content": "Always explain concepts in simple terms with examples.",
  "created_at": "2023-01-01T12:00:00Z",
  "updated_at": "2023-01-01T12:00:00Z"
}

ai_mentor_orgs_users_custom_instruction_update

Request

Update an existing custom instruction for a user.

Args: request: The HTTP request containing the updated custom instruction data. org: The organization/tenant identifier. user_id: The ID of the user to update custom instructions for.

Returns: Response: The updated custom instruction.

Raises: BadRequest: If the provided data is invalid. NotFound: If no custom instruction exists for the user.

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Body
about_userstring or null
mentor_tonestring or null
professionstring<= 100 characters

Position or work. eg: Engineer, student etc.

desired_mentor_traitsstring

Comma separated list of expected traits for mentor.

curl -i -X PUT \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/custom-instruction/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "content": "Always explain concepts in simple terms with examples and analogies."
  }'

Responses

Bodyapplication/json
idintegerread-onlyrequired
about_userstring or null
mentor_tonestring or null
professionstring<= 100 characters

Position or work. eg: Engineer, student etc.

desired_mentor_traitsstring

Comma separated list of expected traits for mentor.

Response
application/json
{
  "id": 1,
  "username": "johndoe",
  "platform_key": "main",
  "content": "Always explain concepts in simple terms with examples and analogies.",
  "created_at": "2023-01-01T12:00:00Z",
  "updated_at": "2023-01-02T14:30:00Z"
}

ai_mentor_orgs_users_disclaimer_agreements_list

Request

API view for managing disclaimer agreements.

This viewset provides Create Read and Delete operations for disclaimer agreements with different access levels:

Platform Admins:

  • Can view all disclaimer agreements for their platform
  • Have full access to create (for themselves) and delete agreements for themselves and other users.
  • Results are paginated and can be filtered

Students:

  • Can only view their own disclaimer agreements
  • Limited to agreements where they are the user
  • Results are paginated and can be filtered

List endpoint returns paginated results with disclaimer agreement objects:

{
    "count": int,
    "next": str,
    "previous": str,
    "results": [
        {
            "id": int,
            "user": str,
            "disclaimer": int,
            "agreed_at": datetime,

        },
        ...
    ]
}

Detail endpoints return a single disclaimer agreement object with the same structure

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Query
disclaimerinteger
mentor_idstring(uuid)
pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

usernamestring
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/disclaimer-agreements/?disclaimer=0&mentor_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&page=0&page_size=0&username=string' \
  -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(DisclaimerAgreement)required
results[].​idintegerread-onlyrequired
results[].​userinteger[ 0 .. 2147483647 ]read-onlyrequired

edX user ID

results[].​disclaimerintegerrequired
results[].​agreed_atstring(date-time)read-onlyrequired
results[].​platform_keystringread-onlyrequired
results[].​user_idstringread-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