Skip to content
API Reference/
/
Retrieve a project

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

Create a new project

Request

Create a new project with optional mentors.

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
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 POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/projects/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Machine Learning Basics",
    "description": "A project for learning machine learning fundamentals",
    "shared": true,
    "mentors_to_add": [
      "550e8400-e29b-41d4-a716-446655440000",
      "550e8400-e29b-41d4-a716-446655440001"
    ]
  }'

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": 1,
  "name": "Machine Learning Basics",
  "description": "A project for learning machine learning fundamentals",
  "shared": true,
  "owner": 1,
  "owner_username": "john_doe",
  "platform": 1,
  "platform_key": "main",
  "platform_name": "main",
  "mentor_count": 2,
  "is_personal": false,
  "mentors": [
    { … }
  ],
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

Retrieve a project

Request

Get detailed information about a specific project including its mentors.

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

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": [
    { … }
  ]
}

Update a project

Request

Update project information and optionally modify its mentors.

Security
PlatformApiKeyAuthentication
Path
idintegerrequired
orgstringrequired
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}/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-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