@iblai/iblai-api 2025.10.27-google-calendar-support-2-ai → 2025.11.3-teams-bot-renovation-ai

package/sdk_schema.yml

@@ -1,7 +1,7 @@
 openapi: 3.0.3
 info:
   title: ibl-data-manager
-  version: 4.73.0-ai-plus
+  version: 4.80.0-ai-plus
   description: API for iblai
 paths:
   /api/ai-account/connected-services/callback/:
@@ -24195,6 +24195,7 @@ paths:
   /api/ai-mentor/orgs/{org}/users/{user_id}/mentors/{mentor}/public-sharable-link/:
     get:
       operationId: ai_mentor_orgs_users_mentors_public_sharable_link_retrieve
+      description: Return True if the token is valid and link is enabled, else False
       parameters:
       - in: path
         name: mentor
@@ -32574,11 +32575,11 @@ paths:
           minimum: 1
         description: Number of results per page
       - in: query
-        name: llm
+        name: llm_providers
         schema:
           type: string
           minLength: 1
-        description: LLM model filter
+        description: LLM provider filter
       - in: query
         name: offset
         schema:
@@ -32772,6 +32773,155 @@ paths:
           description: Not found
         '500':
           description: Server error
+  /api/ai-search/personalized-mentors/:
+    get:
+      operationId: v2_personalized_mentors
+      description: "\n        Get mentors created by a specific user within a given\
+        \ organization/platform.\n        This endpoint provides a personalized view\
+        \ of the user's own mentors with\n        support for filtering, pagination,\
+        \ and detailed mentor information.\n\n        **Authentication Required:**\n\
+        \        - username: Required for personalized mentor access\n        - platform_key:\
+        \ Required for tenant-specific content\n\n        **Features:**\n        -\
+        \ User's own mentors only\n        - Personalization data (access counts,\
+        \ last used)\n        - Filtering and faceted search\n        - Pagination\
+        \ support\n        - Detail and list views\n        "
+      summary: Get mentors created by a specific user
+      parameters:
+      - in: query
+        name: audience
+        schema:
+          type: array
+          items:
+            type: string
+        description: Filter by audience
+      - in: query
+        name: category
+        schema:
+          type: string
+          minLength: 1
+        description: Mentor category filter
+      - in: query
+        name: limit
+        schema:
+          type: integer
+        description: Number of results per page
+      - in: query
+        name: llm_providers
+        schema:
+          type: array
+          items:
+            type: string
+        description: Filter by LLM provider
+      - in: query
+        name: offset
+        schema:
+          type: integer
+        description: Number of results to skip
+      - in: query
+        name: order_by
+        schema:
+          type: string
+          minLength: 1
+        description: Field to sort by
+      - in: query
+        name: order_direction
+        schema:
+          enum:
+          - asc
+          - desc
+          type: string
+          minLength: 1
+        description: |-
+          Sort direction
+
+          * `asc` - asc
+          * `desc` - desc
+      - in: query
+        name: platform_key
+        schema:
+          type: string
+          minLength: 1
+        description: Platform key for authentication
+        required: true
+      - in: query
+        name: query
+        schema:
+          type: string
+          minLength: 1
+        description: Search query for personalized mentors
+      - in: query
+        name: return_facet
+        schema:
+          type: boolean
+        description: Include facet data in response
+      - in: query
+        name: tags
+        schema:
+          type: array
+          items:
+            type: string
+        description: Filter by tags
+      - in: query
+        name: username
+        schema:
+          type: string
+          minLength: 1
+        description: Username for authentication (required for unauthenticated requests)
+      - in: query
+        name: visibility
+        schema:
+          type: array
+          items:
+            type: string
+        description: Filter by visibility
+      tags:
+      - ai-search
+      security:
+      - PlatformApiKeyAuthentication: []
+      - {}
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/V2PersonalizedMentorsResponse'
+              examples:
+                GetUser'sMentors:
+                  value:
+                    username: john.doe
+                    platform_key: example-university
+                    limit: 20
+                  summary: Get user's mentors
+                  description: Get all mentors created by john.doe
+                FilterByCategory:
+                  value:
+                    username: jane.smith
+                    platform_key: tech-institute
+                    category:
+                    - Computer Science
+                    visibility:
+                    - public
+                    return_facet: true
+                  summary: Filter by category
+                  description: Filter user's mentors by category and visibility
+                DetailViewByUUID:
+                  value:
+                    username: john.doe
+                    platform_key: example-university
+                    unique_id: 550e8400-e29b-41d4-a716-446655440000
+                  summary: Detail view by UUID
+                  description: Retrieve a specific mentor by UUID
+          description: ''
+        '400':
+          description: Bad request - invalid parameters
+        '401':
+          description: Unauthorized - missing credentials
+        '403':
+          description: Forbidden - insufficient permissions
+        '404':
+          description: Mentor not found
+        '500':
+          description: Internal server error
   /api/ai-search/prompts/:
     get:
       operationId: list_platform_prompts
@@ -32918,6 +33068,152 @@ paths:
           description: Admin permissions required or platform mismatch
         '404':
           description: Prompt not found
+  /api/ai-search/recommendation/prompts/:
+    get:
+      operationId: list_platform_prompts_2
+      description: Get all recommendation prompts for a specific platform. Optionally
+        filter by SPA URL or recommendation type.
+      summary: List recommendation prompts for a platform
+      tags:
+      - ai-search
+      security:
+      - PlatformApiKeyAuthentication: []
+      - {}
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/PlatformPromptResponse'
+          description: ''
+        '400':
+          description: Invalid parameters
+        '401':
+          description: Authentication required
+        '403':
+          description: Admin permissions required
+    post:
+      operationId: create_platform_prompt_2
+      description: Create a new recommendation prompt for a platform and SPA.
+      summary: Create a new recommendation prompt
+      tags:
+      - ai-search
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/PlatformPrompt'
+            examples:
+              CreateCoursePrompt:
+                value:
+                  platform_key: acme-corp
+                  recommendation_type: courses
+                  spa_url: catalog.acme-corp.com
+                  prompt_text: Focus on technical skills and certifications...
+                  active: true
+                summary: Create course prompt
+          application/scim+json:
+            schema:
+              $ref: '#/components/schemas/PlatformPrompt'
+          application/x-www-form-urlencoded:
+            schema:
+              $ref: '#/components/schemas/PlatformPrompt'
+          multipart/form-data:
+            schema:
+              $ref: '#/components/schemas/PlatformPrompt'
+          '*/*':
+            schema:
+              $ref: '#/components/schemas/PlatformPrompt'
+      security:
+      - PlatformApiKeyAuthentication: []
+      - {}
+      responses:
+        '201':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PlatformPromptResponse'
+              examples:
+                CreateCoursePrompt:
+                  value:
+                    platform_key: acme-corp
+                    recommendation_type: courses
+                    spa_url: catalog.acme-corp.com
+                    prompt_text: Focus on technical skills and certifications...
+                    active: true
+                  summary: Create course prompt
+          description: ''
+        '400':
+          description: Invalid data
+        '401':
+          description: Authentication required
+        '403':
+          description: Admin permissions required
+        '409':
+          description: Prompt already exists for this combination
+    put:
+      operationId: update_platform_prompt_2
+      description: Update an existing prompt by ID. Must provide platform_key to verify
+        ownership.
+      summary: Update an existing recommendation prompt
+      tags:
+      - ai-search
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/PlatformPrompt'
+          application/scim+json:
+            schema:
+              $ref: '#/components/schemas/PlatformPrompt'
+          application/x-www-form-urlencoded:
+            schema:
+              $ref: '#/components/schemas/PlatformPrompt'
+          multipart/form-data:
+            schema:
+              $ref: '#/components/schemas/PlatformPrompt'
+          '*/*':
+            schema:
+              $ref: '#/components/schemas/PlatformPrompt'
+      security:
+      - PlatformApiKeyAuthentication: []
+      - {}
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PlatformPromptResponse'
+          description: ''
+        '400':
+          description: Invalid data
+        '401':
+          description: Authentication required
+        '403':
+          description: Admin permissions required or platform mismatch
+        '404':
+          description: Prompt not found
+    delete:
+      operationId: delete_platform_prompt_2
+      description: Delete a recommendation prompt by ID. Must provide platform_key
+        to verify ownership. This permanently removes the prompt.
+      summary: Delete a recommendation prompt
+      tags:
+      - ai-search
+      security:
+      - PlatformApiKeyAuthentication: []
+      - {}
+      responses:
+        '204':
+          description: Prompt deleted successfully
+        '401':
+          description: Authentication required
+        '403':
+          description: Admin permissions required or platform mismatch
+        '404':
+          description: Prompt not found
   /api/ai-search/recommendations/:
     get:
       operationId: v2_course_recommendations
@@ -33024,7 +33320,14 @@ paths:
           type: string
           minLength: 1
         description: Platform key for tenant-scoped recommendations
-        required: true
+      - in: query
+        name: platform_org
+        schema:
+          type: string
+          nullable: true
+          minLength: 1
+        description: Platform org identifier (optional - avoids database lookup if
+          provided)
       - in: query
         name: ranking_prompt
         schema:
@@ -33061,7 +33364,7 @@ paths:
           default: courses
           minLength: 1
         description: |-
-          Type of resource to recommend (catalog items or mentors)
+          Type of resource to recommend. Catalog types (courses/programs/resources/pathways) will use the platform's 'catalog' prompt category if configured.
 
           * `mentors` - Mentor Recommendations
           * `courses` - Course Recommendations
@@ -51184,6 +51487,225 @@ paths:
               schema:
                 $ref: '#/components/schemas/UserPolicyUpdateForbidden'
           description: ''
+  /api/core/platforms/{platform_key}/public-image-assets/:
+    get:
+      operationId: core_platforms_public_image_assets_list
+      description: Shared functionality for platform public image asset views.
+      parameters:
+      - in: path
+        name: platform_key
+        schema:
+          type: string
+        required: true
+      tags:
+      - core
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/PlatformPublicImageAsset'
+          description: ''
+    post:
+      operationId: core_platforms_public_image_assets_create
+      description: Shared functionality for platform public image asset views.
+      parameters:
+      - in: path
+        name: platform_key
+        schema:
+          type: string
+        required: true
+      tags:
+      - core
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/PlatformPublicImageAsset'
+          application/scim+json:
+            schema:
+              $ref: '#/components/schemas/PlatformPublicImageAsset'
+          application/x-www-form-urlencoded:
+            schema:
+              $ref: '#/components/schemas/PlatformPublicImageAsset'
+          multipart/form-data:
+            schema:
+              $ref: '#/components/schemas/PlatformPublicImageAsset'
+          '*/*':
+            schema:
+              $ref: '#/components/schemas/PlatformPublicImageAsset'
+        required: true
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '201':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PlatformPublicImageAsset'
+          description: ''
+  /api/core/platforms/{platform_key}/public-image-assets/{asset_id}/:
+    get:
+      operationId: core_platforms_public_image_assets_retrieve
+      description: Shared functionality for platform public image asset views.
+      parameters:
+      - in: path
+        name: asset_id
+        schema:
+          type: integer
+        required: true
+      - in: path
+        name: platform_key
+        schema:
+          type: string
+        required: true
+      tags:
+      - core
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PlatformPublicImageAsset'
+          description: ''
+    put:
+      operationId: core_platforms_public_image_assets_update
+      description: Shared functionality for platform public image asset views.
+      parameters:
+      - in: path
+        name: asset_id
+        schema:
+          type: integer
+        required: true
+      - in: path
+        name: platform_key
+        schema:
+          type: string
+        required: true
+      tags:
+      - core
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/PlatformPublicImageAsset'
+          application/scim+json:
+            schema:
+              $ref: '#/components/schemas/PlatformPublicImageAsset'
+          application/x-www-form-urlencoded:
+            schema:
+              $ref: '#/components/schemas/PlatformPublicImageAsset'
+          multipart/form-data:
+            schema:
+              $ref: '#/components/schemas/PlatformPublicImageAsset'
+          '*/*':
+            schema:
+              $ref: '#/components/schemas/PlatformPublicImageAsset'
+        required: true
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PlatformPublicImageAsset'
+          description: ''
+    patch:
+      operationId: core_platforms_public_image_assets_partial_update
+      description: Shared functionality for platform public image asset views.
+      parameters:
+      - in: path
+        name: asset_id
+        schema:
+          type: integer
+        required: true
+      - in: path
+        name: platform_key
+        schema:
+          type: string
+        required: true
+      tags:
+      - core
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/PatchedPlatformPublicImageAsset'
+          application/scim+json:
+            schema:
+              $ref: '#/components/schemas/PatchedPlatformPublicImageAsset'
+          application/x-www-form-urlencoded:
+            schema:
+              $ref: '#/components/schemas/PatchedPlatformPublicImageAsset'
+          multipart/form-data:
+            schema:
+              $ref: '#/components/schemas/PatchedPlatformPublicImageAsset'
+          '*/*':
+            schema:
+              $ref: '#/components/schemas/PatchedPlatformPublicImageAsset'
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PlatformPublicImageAsset'
+          description: ''
+    delete:
+      operationId: core_platforms_public_image_assets_destroy
+      description: Shared functionality for platform public image asset views.
+      parameters:
+      - in: path
+        name: asset_id
+        schema:
+          type: integer
+        required: true
+      - in: path
+        name: platform_key
+        schema:
+          type: string
+        required: true
+      tags:
+      - core
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '204':
+          description: No response body
+  /api/core/platforms/{platform_key}/public-image-assets/{asset_id}/file/:
+    get:
+      operationId: core_platforms_public_image_assets_file_retrieve
+      description: Shared functionality for platform public image asset views.
+      parameters:
+      - in: path
+        name: asset_id
+        schema:
+          type: integer
+        required: true
+      - in: path
+        name: platform_key
+        schema:
+          type: string
+        required: true
+      tags:
+      - core
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                type: object
+                additionalProperties: {}
+                description: Unspecified response body
+          description: ''
   /api/core/rbac/groups/:
     get:
       operationId: core_rbac_groups_list
@@ -75170,6 +75692,8 @@ components:
         platform_key:
           type: string
           readOnly: true
+        llm_config:
+          readOnly: true
         system_prompt:
           type: string
           readOnly: true
@@ -75274,6 +75798,7 @@ components:
       - id
       - is_deleted
       - is_guided_mentor
+      - llm_config
       - llm_name
       - llm_provider
       - llm_temperature
@@ -75490,6 +76015,8 @@ components:
         platform_key:
           type: string
           readOnly: true
+        llm_config:
+          readOnly: true
       required:
       - allow_anonymous
       - can_use_tools
@@ -75518,6 +76045,7 @@ components:
       - greeting_method
       - id
       - is_guided_mentor
+      - llm_config
       - llm_name
       - mentor
       - mentor_description
@@ -76161,6 +76689,7 @@ components:
             * `PROGRAM_INVITATION` - Program Invitation
             * `COURSE_INVITATION` - Course Invitation
             * `USER_NOTIF_LEARNER_PROGRESS` - User Notif Learner Progress
+            * `PROACTIVE_LEARNER_NOTIFICATION` - Proactive Learner Notification
             * `ROLE_CHANGE` - Role Change
             * `COURSE_LICENSE_ASSIGNMENT` - Course License Assignment
             * `COURSE_LICENSE_GROUP_ASSIGNMENT` - Course License Group Assignment
@@ -76169,7 +76698,7 @@ components:
             * `USER_LICENSE_ASSIGNMENT` - User License Assignment
             * `USER_LICENSE_GROUP_ASSIGNMENT` - User License Group Assignment
           oneOf:
-          - $ref: '#/components/schemas/Type768Enum'
+          - $ref: '#/components/schemas/Type2a5Enum'
           - $ref: '#/components/schemas/NullEnum'
         name:
           type: string
@@ -76289,6 +76818,7 @@ components:
             * `PROGRAM_INVITATION` - Program Invitation
             * `COURSE_INVITATION` - Course Invitation
             * `USER_NOTIF_LEARNER_PROGRESS` - User Notif Learner Progress
+            * `PROACTIVE_LEARNER_NOTIFICATION` - Proactive Learner Notification
             * `ROLE_CHANGE` - Role Change
             * `COURSE_LICENSE_ASSIGNMENT` - Course License Assignment
             * `COURSE_LICENSE_GROUP_ASSIGNMENT` - Course License Group Assignment
@@ -76297,7 +76827,7 @@ components:
             * `USER_LICENSE_ASSIGNMENT` - User License Assignment
             * `USER_LICENSE_GROUP_ASSIGNMENT` - User License Group Assignment
           oneOf:
-          - $ref: '#/components/schemas/Type768Enum'
+          - $ref: '#/components/schemas/Type2a5Enum'
           - $ref: '#/components/schemas/BlankEnum'
           - $ref: '#/components/schemas/NullEnum'
         name:
@@ -78942,6 +79472,7 @@ components:
             * `PROGRAM_INVITATION` - Program Invitation
             * `COURSE_INVITATION` - Course Invitation
             * `USER_NOTIF_LEARNER_PROGRESS` - User Notif Learner Progress
+            * `PROACTIVE_LEARNER_NOTIFICATION` - Proactive Learner Notification
             * `ROLE_CHANGE` - Role Change
             * `COURSE_LICENSE_ASSIGNMENT` - Course License Assignment
             * `COURSE_LICENSE_GROUP_ASSIGNMENT` - Course License Group Assignment
@@ -78950,7 +79481,7 @@ components:
             * `USER_LICENSE_ASSIGNMENT` - User License Assignment
             * `USER_LICENSE_GROUP_ASSIGNMENT` - User License Group Assignment
           oneOf:
-          - $ref: '#/components/schemas/Type768Enum'
+          - $ref: '#/components/schemas/Type2a5Enum'
           - $ref: '#/components/schemas/NullEnum'
         name:
           type: string
@@ -79111,6 +79642,31 @@ components:
           readOnly: true
           description: This will be fed into the run of this agent as part of its
             input prompt.
+    PatchedPlatformPublicImageAsset:
+      type: object
+      properties:
+        id:
+          type: integer
+          readOnly: true
+        category:
+          type: string
+          description: Category of the asset
+          maxLength: 200
+        image:
+          type: string
+          format: uri
+          writeOnly: true
+        url:
+          type: string
+          readOnly: true
+        created_on:
+          type: string
+          format: date-time
+          readOnly: true
+        last_updated:
+          type: string
+          format: date-time
+          readOnly: true
     PatchedPlatformPublicMetadata:
       type: object
       properties:
@@ -81579,15 +82135,12 @@ components:
         recommendation_type:
           allOf:
           - $ref: '#/components/schemas/RecommendationTypeEnum'
-          default: courses
+          default: catalog
           description: |-
-            Type of resource to recommend (catalog items or mentors)
+            Prompt category. Use 'catalog' for courses/programs/resources/pathways; use 'mentors' for mentor prompts.
 
             * `mentors` - Mentor Recommendations
-            * `courses` - Course Recommendations
-            * `programs` - Program Recommendations
-            * `resources` - Resource Recommendations
-            * `pathways` - Pathway Recommendations
+            * `catalog` - Catalog Recommendations
         spa_url:
           type: string
           nullable: true
@@ -81630,6 +82183,38 @@ components:
       - prompt_text
       - recommendation_type
       - updated_at
+    PlatformPublicImageAsset:
+      type: object
+      properties:
+        id:
+          type: integer
+          readOnly: true
+        category:
+          type: string
+          description: Category of the asset
+          maxLength: 200
+        image:
+          type: string
+          format: uri
+          writeOnly: true
+        url:
+          type: string
+          readOnly: true
+        created_on:
+          type: string
+          format: date-time
+          readOnly: true
+        last_updated:
+          type: string
+          format: date-time
+          readOnly: true
+      required:
+      - category
+      - created_on
+      - id
+      - image
+      - last_updated
+      - url
     PlatformPublicMetadata:
       type: object
       properties:
@@ -84154,17 +84739,11 @@ components:
     RecommendationTypeEnum:
       enum:
       - mentors
-      - courses
-      - programs
-      - resources
-      - pathways
+      - catalog
       type: string
       description: |-
         * `mentors` - Mentor Recommendations
-        * `courses` - Course Recommendations
-        * `programs` - Program Recommendations
-        * `resources` - Resource Recommendations
-        * `pathways` - Pathway Recommendations
+        * `catalog` - Catalog Recommendations
     RecommendedCoursesResponse:
       type: object
       description: Response serializer for RecommendedCoursesView
@@ -87737,7 +88316,7 @@ components:
         * `openai` - Openai
         * `google` - Google
         * `elevenlabs` - Elevenlabs
-    Type768Enum:
+    Type2a5Enum:
       enum:
       - DEFAULT_TEMPLATE
       - APP_REGISTRATION
@@ -87752,6 +88331,7 @@ components:
       - PROGRAM_INVITATION
       - COURSE_INVITATION
       - USER_NOTIF_LEARNER_PROGRESS
+      - PROACTIVE_LEARNER_NOTIFICATION
       - ROLE_CHANGE
       - COURSE_LICENSE_ASSIGNMENT
       - COURSE_LICENSE_GROUP_ASSIGNMENT
@@ -87774,6 +88354,7 @@ components:
         * `PROGRAM_INVITATION` - Program Invitation
         * `COURSE_INVITATION` - Course Invitation
         * `USER_NOTIF_LEARNER_PROGRESS` - User Notif Learner Progress
+        * `PROACTIVE_LEARNER_NOTIFICATION` - Proactive Learner Notification
         * `ROLE_CHANGE` - Role Change
         * `COURSE_LICENSE_ASSIGNMENT` - Course License Assignment
         * `COURSE_LICENSE_GROUP_ASSIGNMENT` - Course License Group Assignment
@@ -89231,6 +89812,38 @@ components:
       - current_page
       - results
       - total_pages
+    V2PersonalizedMentorsResponse:
+      type: object
+      description: Response serializer for V2 Personalized Mentors Search.
+      properties:
+        results:
+          type: array
+          items: {}
+          description: List of personalized mentor search results
+        count:
+          type: integer
+          description: Total number of results
+        next:
+          type: string
+          nullable: true
+          description: URL for next page of results
+        previous:
+          type: string
+          nullable: true
+          description: URL for previous page of results
+        current_page:
+          type: integer
+          description: Current page number
+        total_pages:
+          type: integer
+          description: Total number of pages
+      required:
+      - count
+      - current_page
+      - next
+      - previous
+      - results
+      - total_pages
     V2RecommendationResponse:
       type: object
       description: |-