Skip to content
API Reference/
/
ai_mentor_orgs_metadata_c...

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

Get accessible mentors by email

Request

Returns a list of mentor unique IDs that a user can access via email in the specified organization.

Path
orgstringrequired
Body
required
emailstring(email)required

The user email to check mentor access for

all_mentorsboolean

If true, return all mentors in the platform. If false (default), return only mentors owned by the user's email.

Default false
curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/mentors/by-email/' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "user@example.com",
    "all_mentors": false
  }'

Responses

Bodyapplication/json
mentorsArray of strings(uuid)read-onlyrequired

List of mentor unique IDs

user_idintegerread-onlyrequired

The user ID that mentors belong to

Response
application/json
{
  "mentors": [
    "550e8400-e29b-41d4-a716-446655440000",
    "6ba7b810-9dad-11d1-80b4-00c04fd430c8"
  ],
  "user_id": 1234
}

ai_mentor_orgs_metadata_create

Request

Create or update metadata for a mentor.

Args: request: The HTTP request containing the metadata. org: The organization/tenant identifier.

Returns: Response: The created or updated mentor metadata.

Raises: BadRequest: If the provided data is invalid.

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
Body
required
metadataanyrequired
mentorstring
mentor_idinteger
curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/metadata/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "metadata": {
      "specialty": "machine learning",
      "experience_level": "expert",
      "languages": [
        "English",
        "Spanish"
      ]
    },
    "mentor_id": 123
  }'

Responses

Bodyapplication/json
metadataanyrequired
mentorstring
mentor_idinteger
Response
application/json
{
  "metadata": {
    "specialty": "machine learning",
    "experience_level": "expert",
    "languages": [ … ]
  },
  "mentor_id": 123
}

List projects

Request

Retrieve a list of projects with optional filtering and search.

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
Query
limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

orderingstring

Which field to use when ordering the results.

searchstring

Search in project name and description

sharedboolean

Filter by shared status (true/false)

sortstring

Order by field (prefix with - for descending). Example: name or -created_at

Examples:
sort=name
sort=-name
sort=created_at
sort=-created_at
usernamestring

Filter projects by owner's username

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/projects/?limit=0&offset=0&ordering=string&search=string&shared=true&sort=string&username=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
countintegerrequired
Example: 123
nextstring or null(uri)
Example: "http://api.example.org/accounts/?offset=400&limit=100"
previousstring or null(uri)
Example: "http://api.example.org/accounts/?offset=200&limit=100"
resultsArray of objects(Project)required
results[].​idintegerread-onlyrequired
results[].​namestring<= 255 charactersrequired

Name of the project

results[].​descriptionstring

Description of the project

results[].​sharedboolean

Whether this project is shared with others or personal

results[].​ownerinteger[ 0 .. 2147483647 ]read-onlyrequired

User who created this project

results[].​owner_usernamestringread-onlyrequired
results[].​platforminteger or nullread-onlyrequired

Platform this project belongs to

results[].​platform_keystringread-onlyrequired
results[].​platform_namestringread-onlyrequired
results[].​mentor_countintegerread-onlyrequired
results[].​is_personalbooleanread-onlyrequired
results[].​created_atstring(date-time)read-onlyrequired
results[].​updated_atstring(date-time)read-onlyrequired
results[].​mentorsArray of objects(ProjectMentor)read-onlyrequired
results[].​mentors[].​idintegerread-onlyrequired
results[].​mentors[].​namestring<= 255 charactersrequired
results[].​mentors[].​descriptionstring or null
results[].​mentors[].​unique_idstring(uuid)read-onlyrequired
results[].​mentors[].​slugstring^[-a-zA-Z0-9_]+$read-onlyrequired
results[].​mentors[].​created_atstring or null(date-time)read-onlyrequired
Response
application/json
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "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