Skip to content
API Reference/
/
ai_mentor_orgs_users_proj...

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

Update a project

Request

Update project information and optionally modify its mentors.

Security
PlatformApiKeyAuthentication
Path
idintegerrequired

A unique integer value identifying this Project.

orgstringrequired
user_idstringrequired
Body
required
namestring<= 255 charactersrequired

Name of the project

descriptionstring

Description of the project

sharedboolean

Whether this project is shared with others or personal

mentors_to_addArray of strings(uuid)write-only

List of mentor unique IDs to add to the project

mentors_to_removeArray of strings(uuid)write-only

List of mentor unique IDs to remove from the project

curl -i -X PUT \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/projects/{id}/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "description": "string",
    "shared": true,
    "mentors_to_add": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "mentors_to_remove": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ]
  }'

Responses

Bodyapplication/json
idintegerread-onlyrequired
namestring<= 255 charactersrequired

Name of the project

descriptionstring

Description of the project

sharedboolean

Whether this project is shared with others or personal

ownerinteger[ 0 .. 2147483647 ]read-onlyrequired

User who created this project

owner_usernamestringread-onlyrequired
platforminteger or nullread-onlyrequired

Platform this project belongs to

platform_keystringread-onlyrequired
platform_namestringread-onlyrequired
mentor_countintegerread-onlyrequired
is_personalbooleanread-onlyrequired
created_atstring(date-time)read-onlyrequired
updated_atstring(date-time)read-onlyrequired
mentorsArray of objects(ProjectMentor)read-onlyrequired
mentors[].​idintegerread-onlyrequired
mentors[].​namestring<= 255 charactersrequired
mentors[].​descriptionstring or null
mentors[].​unique_idstring(uuid)read-onlyrequired
mentors[].​slugstring^[-a-zA-Z0-9_]+$read-onlyrequired
mentors[].​created_atstring or null(date-time)read-onlyrequired
Response
application/json
{
  "id": 0,
  "name": "string",
  "description": "string",
  "shared": true,
  "owner": 2147483647,
  "owner_username": "string",
  "platform": 0,
  "platform_key": "string",
  "platform_name": "string",
  "mentor_count": 0,
  "is_personal": true,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "mentors": [
    { … }
  ]
}

ai_mentor_orgs_users_projects_partial_update

Request

API ViewSet for managing projects.

Projects are groups of mentors that can be created by anyone (students and tenant admins). They serve as a way to organize and group related mentors together.

Projects can be:

  • Personal (shared=False): Only visible to their owners
  • Shared (shared=True): Visible to platform admins and potentially other users

Projects are accessed through integrated URLs within the mentor router: /orgs//projects/ - All accessible projects in a platform (admin access) /orgs//projects// - Specific project (admin access) /orgs//users/<user_id>/projects/ - User's projects (user access) /orgs//users/<user_id>/projects// - User's specific project

Query Parameters:

  • username: Filter projects by owner's username (admin routes only)
  • shared: Filter by shared status (true/false)
  • search: Search in name and description
  • sort: Order by field (prefix with - for descending). Example: sort=name or sort=-created_at

Permissions:

  • GET: Accessible to project owners and platform admins (for shared projects)
  • POST: Any authenticated user can create projects
  • PUT, PATCH, DELETE: Accessible to project owners only
Security
PlatformApiKeyAuthentication
Path
idintegerrequired

A unique integer value identifying this Project.

orgstringrequired
user_idstringrequired
Body
namestring<= 255 characters

Name of the project

descriptionstring

Description of the project

sharedboolean

Whether this project is shared with others or personal

mentors_to_addArray of strings(uuid)write-only

List of mentor unique IDs to add to the project

mentors_to_removeArray of strings(uuid)write-only

List of mentor unique IDs to remove from the project

curl -i -X PATCH \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/projects/{id}/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "description": "string",
    "shared": true,
    "mentors_to_add": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "mentors_to_remove": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ]
  }'

Responses

Bodyapplication/json
idintegerread-onlyrequired
namestring<= 255 charactersrequired

Name of the project

descriptionstring

Description of the project

sharedboolean

Whether this project is shared with others or personal

ownerinteger[ 0 .. 2147483647 ]read-onlyrequired

User who created this project

owner_usernamestringread-onlyrequired
platforminteger or nullread-onlyrequired

Platform this project belongs to

platform_keystringread-onlyrequired
platform_namestringread-onlyrequired
mentor_countintegerread-onlyrequired
is_personalbooleanread-onlyrequired
created_atstring(date-time)read-onlyrequired
updated_atstring(date-time)read-onlyrequired
mentorsArray of objects(ProjectMentor)read-onlyrequired
mentors[].​idintegerread-onlyrequired
mentors[].​namestring<= 255 charactersrequired
mentors[].​descriptionstring or null
mentors[].​unique_idstring(uuid)read-onlyrequired
mentors[].​slugstring^[-a-zA-Z0-9_]+$read-onlyrequired
mentors[].​created_atstring or null(date-time)read-onlyrequired
Response
application/json
{
  "id": 0,
  "name": "string",
  "description": "string",
  "shared": true,
  "owner": 2147483647,
  "owner_username": "string",
  "platform": 0,
  "platform_key": "string",
  "platform_name": "string",
  "mentor_count": 0,
  "is_personal": true,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "mentors": [
    { … }
  ]
}

Delete a project

Request

Delete a project permanently.

Security
PlatformApiKeyAuthentication
Path
idintegerrequired

A unique integer value identifying this Project.

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

Responses

Project deleted successfully

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