ibl_ai_data_manager_sdk 0.0.1 copy "ibl_ai_data_manager_sdk: ^0.0.1" to clipboard
ibl_ai_data_manager_sdk: ^0.0.1 copied to clipboard

OpenAPI API client

ibl_ai_data_manager_sdk (EXPERIMENTAL) #

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This Dart package is automatically generated by the OpenAPI Generator project:

  • API version: 2.0.12-ai-plus
  • Build package: org.openapitools.codegen.languages.DartDioClientCodegen

Requirements #

Installation & Usage #

pub.dev #

To use the package from pub.dev, please include the following in pubspec.yaml

dependencies:
  ibl_ai_data_manager_sdk: 1.0.0

Github #

If this Dart package is published to Github, please include the following in pubspec.yaml

dependencies:
  ibl_ai_data_manager_sdk:
    git:
      url: https://github.com/GIT_USER_ID/GIT_REPO_ID.git
      #ref: main

Local development #

To use the package from your local drive, please include the following in pubspec.yaml

dependencies:
  ibl_ai_data_manager_sdk:
    path: /path/to/ibl_ai_data_manager_sdk

Getting Started #

Please follow the installation procedure and then run the following:

import 'package:ibl_ai_data_manager_sdk/ibl_ai_data_manager_sdk.dart';


final api = IblAiDataManagerSdk().getAiAccountApi();
final String org = org_example; // String | 
final CredentialRequest credentialRequest = ; // CredentialRequest | 

try {
    final response = await api.aiAccountOrgsCredentialCreate(org, credentialRequest);
    print(response);
} catch on DioException (e) {
    print("Exception when calling AiAccountApi->aiAccountOrgsCredentialCreate: $e\n");
}

Documentation for API Endpoints #

All URIs are relative to https://base.manager.mentor.iblai.tech

Class Method HTTP request Description
AiAccountApi aiAccountOrgsCredentialCreate POST /api/ai-account/orgs/{org}/credential/
AiAccountApi aiAccountOrgsCredentialPartialUpdate PATCH /api/ai-account/orgs/{org}/credential/
AiAccountApi aiAccountOrgsCredentialRetrieve GET /api/ai-account/orgs/{org}/credential/
AiAccountApi aiAccountOrgsIntegrationCredentialCreate POST /api/ai-account/orgs/{org}/integration-credential/
AiAccountApi aiAccountOrgsIntegrationCredentialPartialUpdate PATCH /api/ai-account/orgs/{org}/integration-credential/
AiAccountApi aiAccountOrgsIntegrationCredentialRetrieve GET /api/ai-account/orgs/{org}/integration-credential/
AiAccountApi aiAccountOrgsPlatformMetadataCreate POST /api/ai-account/orgs/{org}/platform-metadata/
AiAccountApi aiAccountOrgsPlatformMetadataList GET /api/ai-account/orgs/{org}/platform-metadata/
AiAccountApi aiAccountOrgsPlatformMetadataUpdate PUT /api/ai-account/orgs/{org}/platform-metadata/
AiAccountApi aiAccountOrgsTokensList GET /api/ai-account/orgs/{org}/tokens/
AiBotApi aiBotV1BotsBotCommandsCreate POST /api/ai-bot/v1/bots/{org}/bot-commands/
AiBotApi aiBotV1BotsBotCommandsDestroy DELETE /api/ai-bot/v1/bots/{org}/bot-commands/{id}/
AiBotApi aiBotV1BotsBotCommandsList GET /api/ai-bot/v1/bots/{org}/bot-commands/
AiBotApi aiBotV1BotsBotCommandsPartialUpdate PATCH /api/ai-bot/v1/bots/{org}/bot-commands/{id}/
AiBotApi aiBotV1BotsBotCommandsRetrieve GET /api/ai-bot/v1/bots/{org}/bot-commands/{id}/
AiBotApi aiBotV1BotsBotCommandsUpdate PUT /api/ai-bot/v1/bots/{org}/bot-commands/{id}/
AiBotApi aiBotV1BotsBotCreate POST /api/ai-bot/v1/bots/{org}/bot/
AiBotApi aiBotV1BotsBotDestroy DELETE /api/ai-bot/v1/bots/{org}/bot/{id}/
AiBotApi aiBotV1BotsBotList GET /api/ai-bot/v1/bots/{org}/bot/
AiBotApi aiBotV1BotsBotPartialUpdate PATCH /api/ai-bot/v1/bots/{org}/bot/{id}/
AiBotApi aiBotV1BotsBotRetrieve GET /api/ai-bot/v1/bots/{org}/bot/{id}/
AiBotApi aiBotV1BotsBotUpdate PUT /api/ai-bot/v1/bots/{org}/bot/{id}/
AiBotApi aiBotV1BotsWebhooksDiscordCreate POST /api/ai-bot/v1/bots/webhooks/{org}/discord/
AiBotApi aiBotV1BotsWebhooksSlackCreate POST /api/ai-bot/v1/bots/webhooks/{org}/slack/
AiBotApi aiBotV1BotsWebhooksWebexCreate POST /api/ai-bot/v1/bots/webhooks/{org}/webex/
AiBotApi aiBotV1BotsWebhooksWhatsappCreate POST /api/ai-bot/v1/bots/webhooks/{org}/whatsapp/
AiBotApi aiBotV1BotsWebhooksWhatsappRetrieve GET /api/ai-bot/v1/bots/webhooks/{org}/whatsapp/
AiIndexApi aiIndexOrgsUsersDocumentsPathwaysRetrieve GET /api/ai-index/orgs/{org}/users/{user_id}/documents/pathways/{pathway}/
AiIndexApi aiIndexOrgsUsersDocumentsRetrieve GET /api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/
AiIndexApi aiIndexOrgsUsersDocumentsSearchCreate POST /api/ai-index/orgs/{org}/users/{user_id}/documents/search/
AiIndexApi aiIndexOrgsUsersDocumentsSourcesCreate POST /api/ai-index/orgs/{org}/users/{user_id}/documents/sources/
AiIndexApi aiIndexOrgsUsersDocumentsTasksRetrieve GET /api/ai-index/orgs/{org}/users/{user_id}/documents/tasks/{task_id}/
AiIndexApi aiIndexOrgsUsersDocumentsTrainCreate POST /api/ai-index/orgs/{org}/users/{user_id}/documents/train/
AiIndexApi aiIndexOrgsUsersDocumentsTrainMultilingualRetrieverCreate POST /api/ai-index/orgs/{org}/users/{user_id}/documents/train/multilingual-retriever/
AiIndexApi aiIndexOrgsUsersDocumentsTrainRetrieverCreate POST /api/ai-index/orgs/{org}/users/{user_id}/documents/train/retriever/
AiIndexApi aiIndexOrgsUsersDocumentsTrainSessionsCreate POST /api/ai-index/orgs/{org}/users/{user_id}/documents/train/sessions/{session_id}/
AiIndexApi aiIndexOrgsUsersDocumentsUpdate PUT /api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/
AiMathApi aiMathMathMathStudentsCreate POST /api/ai-math/math/{org}/math-students/
AiMathApi aiMathMathMathStudentsDestroy DELETE /api/ai-math/math/{org}/math-students/{id}/
AiMathApi aiMathMathMathStudentsList GET /api/ai-math/math/{org}/math-students/
AiMathApi aiMathMathMathStudentsPartialUpdate PATCH /api/ai-math/math/{org}/math-students/{id}/
AiMathApi aiMathMathMathStudentsRetrieve GET /api/ai-math/math/{org}/math-students/{id}/
AiMathApi aiMathMathMathStudentsUpdate PUT /api/ai-math/math/{org}/math-students/{id}/
AiMathApi aiMathMathQuestionsDestroy DELETE /api/ai-math/math/{org}/questions/{id}/
AiMathApi aiMathMathQuestionsList GET /api/ai-math/math/{org}/questions/
AiMathApi aiMathMathQuestionsPartialUpdate PATCH /api/ai-math/math/{org}/questions/{id}/
AiMathApi aiMathMathQuestionsRetrieve GET /api/ai-math/math/{org}/questions/{id}/
AiMathApi aiMathMathSampleQuestionsCreate POST /api/ai-math/math/{org}/sample-questions/
AiMathApi aiMathMathSampleQuestionsDestroy DELETE /api/ai-math/math/{org}/sample-questions/{id}/
AiMathApi aiMathMathSampleQuestionsList GET /api/ai-math/math/{org}/sample-questions/
AiMathApi aiMathMathSampleQuestionsRetrieve GET /api/ai-math/math/{org}/sample-questions/{id}/
AiMathApi aiMathMathSkillsCreate POST /api/ai-math/math/{org}/skills/
AiMathApi aiMathMathSkillsDestroy DELETE /api/ai-math/math/{org}/skills/{id}/
AiMathApi aiMathMathSkillsList GET /api/ai-math/math/{org}/skills/
AiMathApi aiMathMathSkillsPartialUpdate PATCH /api/ai-math/math/{org}/skills/{id}/
AiMathApi aiMathMathSkillsRetrieve GET /api/ai-math/math/{org}/skills/{id}/
AiMathApi aiMathMathSkillsUpdate PUT /api/ai-math/math/{org}/skills/{id}/
AiMathApi aiMathMathStudentAnswersCreate POST /api/ai-math/math/{org}/student-answers/
AiMathApi aiMathMathStudentAnswersDestroy DELETE /api/ai-math/math/{org}/student-answers/{id}/
AiMathApi aiMathMathStudentAnswersList GET /api/ai-math/math/{org}/student-answers/
AiMathApi aiMathMathStudentAnswersPartialUpdate PATCH /api/ai-math/math/{org}/student-answers/{id}/
AiMathApi aiMathMathStudentAnswersRetrieve GET /api/ai-math/math/{org}/student-answers/{id}/
AiMathApi aiMathMathStudentAnswersUpdate PUT /api/ai-math/math/{org}/student-answers/{id}/
AiMentorApi aiMentorGenerationsStopGenerationCreate POST /api/ai-mentor/generations/{generation_id}/stop-generation/
AiMentorApi aiMentorOrgsSessionsCreate POST /api/ai-mentor/orgs/{org}/sessions/
AiMentorApi aiMentorOrgsUsersAudioToTextCreate POST /api/ai-mentor/orgs/{org}/users/{user_id}/audio-to-text/
AiMentorApi aiMentorOrgsUsersCategoryCreate POST /api/ai-mentor/orgs/{org}/users/{user_id}/category
AiMentorApi aiMentorOrgsUsersCategoryDestroy DELETE /api/ai-mentor/orgs/{org}/users/{user_id}/category
AiMentorApi aiMentorOrgsUsersCategoryRetrieve GET /api/ai-mentor/orgs/{org}/users/{user_id}/category
AiMentorApi aiMentorOrgsUsersCreate POST /api/ai-mentor/orgs/{org}/users/{user_id}/
AiMentorApi aiMentorOrgsUsersDestroy DELETE /api/ai-mentor/orgs/{org}/users/{user_id}/{name}/
AiMentorApi aiMentorOrgsUsersFreeUsageCountRetrieve GET /api/ai-mentor/orgs/{org}/users/{user_id}/free-usage-count/
AiMentorApi aiMentorOrgsUsersList GET /api/ai-mentor/orgs/{org}/users/{user_id}/
AiMentorApi aiMentorOrgsUsersMentorFeedbackCreateCreate POST /api/ai-mentor/orgs/{org}/users/{user_id}/mentor-feedback/create/
AiMentorApi aiMentorOrgsUsersMentorFeedbackRetrieve GET /api/ai-mentor/orgs/{org}/users/{user_id}/mentor-feedback/{feedback_id}/
AiMentorApi aiMentorOrgsUsersMentorFeedbackUpdate PUT /api/ai-mentor/orgs/{org}/users/{user_id}/mentor-feedback/{feedback_id}/
AiMentorApi aiMentorOrgsUsersMentorFromTemplateCreate POST /api/ai-mentor/orgs/{org}/users/{user_id}/mentor-from-template/
AiMentorApi aiMentorOrgsUsersMentorLlmsRetrieve GET /api/ai-mentor/orgs/{org}/users/{user_id}/mentor-llms/
AiMentorApi aiMentorOrgsUsersMentorWithSettingsCreate POST /api/ai-mentor/orgs/{org}/users/{user_id}/mentor-with-settings/
AiMentorApi aiMentorOrgsUsersMentorsPublicSettingsRetrieve GET /api/ai-mentor/orgs/{org}/users/{user_id}/mentors/{mentor}/public-settings/
AiMentorApi aiMentorOrgsUsersMentorsRetrieve GET /api/ai-mentor/orgs/{org}/users/{user_id}/mentors/{mentor}/
AiMentorApi aiMentorOrgsUsersMentorsSettingsRetrieve GET /api/ai-mentor/orgs/{org}/users/{user_id}/mentors/{mentor}/settings/
AiMentorApi aiMentorOrgsUsersMentorsSettingsUpdate PUT /api/ai-mentor/orgs/{org}/users/{user_id}/mentors/{mentor}/settings/
AiMentorApi aiMentorOrgsUsersPartialUpdate PATCH /api/ai-mentor/orgs/{org}/users/{user_id}/{name}/
AiMentorApi aiMentorOrgsUsersPinMessageCreate POST /api/ai-mentor/orgs/{org}/users/{user_id}/pin-message/
AiMentorApi aiMentorOrgsUsersPinMessageDestroy DELETE /api/ai-mentor/orgs/{org}/users/{user_id}/pin-message/
AiMentorApi aiMentorOrgsUsersPinMessageRetrieve GET /api/ai-mentor/orgs/{org}/users/{user_id}/pin-message/
AiMentorApi aiMentorOrgsUsersPredictiveAnalyticsCreate POST /api/ai-mentor/orgs/{org}/users/{user_id}/predictive-analytics/
AiMentorApi aiMentorOrgsUsersRecentMessagesRetrieve GET /api/ai-mentor/orgs/{org}/users/{user_id}/recent-messages/
AiMentorApi aiMentorOrgsUsersRecommendCoursesRetrieve GET /api/ai-mentor/orgs/{org}/users/{user_id}/recommend-courses/
AiMentorApi aiMentorOrgsUsersRetrieve GET /api/ai-mentor/orgs/{org}/users/{user_id}/{name}/
AiMentorApi aiMentorOrgsUsersSessionidList GET /api/ai-mentor/orgs/{org}/users/{user_id}/sessionid/
AiMentorApi aiMentorOrgsUsersSessionsCreate POST /api/ai-mentor/orgs/{org}/users/{user_id}/sessions/
AiMentorApi aiMentorOrgsUsersSessionsDestroy DELETE /api/ai-mentor/orgs/{org}/users/{user_id}/sessions/{session_id}/
AiMentorApi aiMentorOrgsUsersSessionsDownloadSessionRetrieve GET /api/ai-mentor/orgs/{org}/users/{user_id}/sessions/{session_id}/download-session
AiMentorApi aiMentorOrgsUsersSessionsRetrieve GET /api/ai-mentor/orgs/{org}/users/{user_id}/sessions/{session_id}/
AiMentorApi aiMentorOrgsUsersSessionsSuggestionRetrieve GET /api/ai-mentor/orgs/{org}/users/{user_id}/sessions/{session_id}/suggestion
AiMentorApi aiMentorOrgsUsersSessionsTasksRetrieve GET /api/ai-mentor/orgs/{org}/users/{user_id}/sessions/{session_id}/tasks/{task_id}/
AiMentorApi aiMentorOrgsUsersSessionsUpdate PUT /api/ai-mentor/orgs/{org}/users/{user_id}/sessions/{session_id}/
AiMentorApi aiMentorOrgsUsersTasksRetrieve GET /api/ai-mentor/orgs/{org}/users/{user_id}/tasks/{task_id}
AiMentorApi aiMentorOrgsUsersTasksSessionsCreate POST /api/ai-mentor/orgs/{org}/users/{user_id}/tasks/sessions/{session_id}/
AiMentorApi aiMentorOrgsUsersUpdate PUT /api/ai-mentor/orgs/{org}/users/{user_id}/{name}/
AiMentorApi aiMentorOrgsUsersUsageRetrieve GET /api/ai-mentor/orgs/{org}/users/{user_id}/usage/
AiPromptApi aiPromptOrgsUsersMentorsSuggestedPromptsCreate POST /api/ai-prompt/orgs/{org}/users/{user_id}/mentors/{mentor}/suggested-prompts/
AiPromptApi aiPromptOrgsUsersMentorsSuggestedPromptsDestroy DELETE /api/ai-prompt/orgs/{org}/users/{user_id}/mentors/{mentor}/suggested-prompts/
AiPromptApi aiPromptOrgsUsersMentorsSuggestedPromptsRetrieve GET /api/ai-prompt/orgs/{org}/users/{user_id}/mentors/{mentor}/suggested-prompts/
AiPromptApi aiPromptOrgsUsersMentorsSuggestedPromptsUpdate PUT /api/ai-prompt/orgs/{org}/users/{user_id}/mentors/{mentor}/suggested-prompts/
AiPromptApi aiPromptOrgsUsersPromptCreate POST /api/ai-prompt/orgs/{org}/users/{user_id}/prompt/
AiPromptApi aiPromptOrgsUsersPromptDestroy DELETE /api/ai-prompt/orgs/{org}/users/{user_id}/prompt/{id}/
AiPromptApi aiPromptOrgsUsersPromptList GET /api/ai-prompt/orgs/{org}/users/{user_id}/prompt/
AiPromptApi aiPromptOrgsUsersPromptPartialUpdate PATCH /api/ai-prompt/orgs/{org}/users/{user_id}/prompt/{id}/
AiPromptApi aiPromptOrgsUsersPromptRetrieve GET /api/ai-prompt/orgs/{org}/users/{user_id}/prompt/{id}/
AiPromptApi aiPromptOrgsUsersPromptUpdate PUT /api/ai-prompt/orgs/{org}/users/{user_id}/prompt/{id}/
AiPromptApi aiPromptOrgsUsersPromptsCategoryCreate POST /api/ai-prompt/orgs/{org}/users/{user_id}/prompts/category/
AiPromptApi aiPromptOrgsUsersPromptsCategoryDestroy DELETE /api/ai-prompt/orgs/{org}/users/{user_id}/prompts/category/
AiPromptApi aiPromptOrgsUsersPromptsCategoryRetrieve GET /api/ai-prompt/orgs/{org}/users/{user_id}/prompts/category/
AiPromptApi aiPromptOrgsUsersSessionsGuidedPromptsRetrieve GET /api/ai-prompt/orgs/{org}/users/{user_id}/sessions/{session_id}/guided-prompts/
AudienceApi audienceOrgsActiveUsersOverTimeRetrieve GET /api/audience/orgs/{org}/active-users/over-time
AudienceApi audienceOrgsActiveUsersPerCourseRetrieve GET /api/audience/orgs/{org}/active-users/per-course
AudienceApi audienceOrgsActiveUsersUsersRetrieve GET /api/audience/orgs/{org}/active-users/users
AudienceApi audienceOrgsEnrollmentsCoursesOverTimeRetrieve GET /api/audience/orgs/{org}/enrollments/courses/{course_id}/over-time
AudienceApi audienceOrgsEnrollmentsCoursesUsersRetrieve GET /api/audience/orgs/{org}/enrollments/courses/{course_id}/users
AudienceApi audienceOrgsEnrollmentsOverTimeRetrieve GET /api/audience/orgs/{org}/enrollments/over-time
AudienceApi audienceOrgsEnrollmentsPerCourseRetrieve GET /api/audience/orgs/{org}/enrollments/per-course
AudienceApi audienceOrgsRegisteredUsersOverTimeRetrieve GET /api/audience/orgs/{org}/registered-users/over-time
AudienceApi audienceOrgsRegisteredUsersPerCourseRetrieve GET /api/audience/orgs/{org}/registered-users/per-course
AudienceApi audienceOrgsRegisteredUsersRetrieve GET /api/audience/orgs/{org}/registered-users/
CatalogApi catalogConditionalsCourseEligibilityRetrieve GET /api/catalog/conditionals/course/eligibility/
CatalogApi catalogConditionalsCoursePrerequisitesManageBulkCreate POST /api/catalog/conditionals/course/prerequisites/manage/bulk/
CatalogApi catalogConditionalsCoursePrerequisitesManageRetrieve GET /api/catalog/conditionals/course/prerequisites/manage/
CatalogApi catalogCoursesCreate POST /api/catalog/courses/
CatalogApi catalogCoursesDestroy DELETE /api/catalog/courses/
CatalogApi catalogCoursesRetrieve GET /api/catalog/courses/
CatalogApi catalogEligibilityCoursesCheckRetrieve GET /api/catalog/eligibility/courses/check/
CatalogApi catalogEligibilityCoursesRetrieve GET /api/catalog/eligibility/courses/
CatalogApi catalogEnrollmentCoursesSearchRetrieve GET /api/catalog/enrollment/courses/search/
CatalogApi catalogEnrollmentProgramsCreate POST /api/catalog/enrollment/programs/
CatalogApi catalogEnrollmentProgramsDestroy DELETE /api/catalog/enrollment/programs/
CatalogApi catalogEnrollmentProgramsRetrieve GET /api/catalog/enrollment/programs/
CatalogApi catalogIncrementCreate POST /api/catalog/increment/
CatalogApi catalogIncrementRetrieve GET /api/catalog/increment/
CatalogApi catalogInvitationsCourseBulkCreate POST /api/catalog/invitations/course/bulk/
CatalogApi catalogInvitationsCourseCreate POST /api/catalog/invitations/course/
CatalogApi catalogInvitationsCourseDestroy DELETE /api/catalog/invitations/course/
CatalogApi catalogInvitationsCourseRedeemCreate POST /api/catalog/invitations/course/redeem/
CatalogApi catalogInvitationsCourseRetrieve GET /api/catalog/invitations/course/
CatalogApi catalogInvitationsPlatformBulkCreate POST /api/catalog/invitations/platform/bulk/
CatalogApi catalogInvitationsPlatformCreate POST /api/catalog/invitations/platform/
CatalogApi catalogInvitationsPlatformDestroy DELETE /api/catalog/invitations/platform/
CatalogApi catalogInvitationsPlatformRedeemCreate POST /api/catalog/invitations/platform/redeem/
CatalogApi catalogInvitationsPlatformRetrieve GET /api/catalog/invitations/platform/
CatalogApi catalogInvitationsProgramBulkCreate POST /api/catalog/invitations/program/bulk/
CatalogApi catalogInvitationsProgramCreate POST /api/catalog/invitations/program/
CatalogApi catalogInvitationsProgramDestroy DELETE /api/catalog/invitations/program/
CatalogApi catalogInvitationsProgramRedeemCreate POST /api/catalog/invitations/program/redeem/
CatalogApi catalogInvitationsProgramRetrieve GET /api/catalog/invitations/program/
CatalogApi catalogMetadataChoicesRetrieve GET /api/catalog/metadata/choices/
CatalogApi catalogMetadataCourseCreate POST /api/catalog/metadata/course/
CatalogApi catalogMetadataCourseCreate2 POST /api/catalog/metadata/course/{field}/
CatalogApi catalogMetadataCoursePublicRetrieve GET /api/catalog/metadata/course-public/
CatalogApi catalogMetadataCoursePublicRetrieve2 GET /api/catalog/metadata/course-public/{field}/
CatalogApi catalogMetadataCourseRetrieve GET /api/catalog/metadata/course/
CatalogApi catalogMetadataCourseRetrieve2 GET /api/catalog/metadata/course/{field}/
CatalogApi catalogMetadataProgramCreate POST /api/catalog/metadata/program/
CatalogApi catalogMetadataProgramCreate2 POST /api/catalog/metadata/program/{field}/
CatalogApi catalogMetadataProgramPublicRetrieve GET /api/catalog/metadata/program-public/
CatalogApi catalogMetadataProgramPublicRetrieve2 GET /api/catalog/metadata/program-public/{field}/
CatalogApi catalogMetadataProgramRetrieve GET /api/catalog/metadata/program/
CatalogApi catalogMetadataProgramRetrieve2 GET /api/catalog/metadata/program/{field}/
CatalogApi catalogMilestonesCompletionsCourseCatalogRetrieve GET /api/catalog/milestones/completions/course/catalog/
CatalogApi catalogMilestonesCompletionsCourseManageCreate POST /api/catalog/milestones/completions/course/manage/
CatalogApi catalogMilestonesCompletionsCourseManageRetrieve GET /api/catalog/milestones/completions/course/manage/
CatalogApi catalogMilestonesCompletionsResourceManageCreate POST /api/catalog/milestones/completions/resource/manage/
CatalogApi catalogMilestonesCompletionsResourceManageRetrieve GET /api/catalog/milestones/completions/resource/manage/
CatalogApi catalogMilestonesSkillPointsBlockCreate POST /api/catalog/milestones/skill_points/block/
CatalogApi catalogMilestonesSkillPointsBlockRetrieve GET /api/catalog/milestones/skill_points/block/
CatalogApi catalogMilestonesSkillPointsCourseCreate POST /api/catalog/milestones/skill_points/course/
CatalogApi catalogMilestonesSkillPointsCourseRetrieve GET /api/catalog/milestones/skill_points/course/
CatalogApi catalogMilestonesSkillPointsUserRetrieve GET /api/catalog/milestones/skill_points/user/
CatalogApi catalogPathwaysCreate POST /api/catalog/pathways/
CatalogApi catalogPathwaysDestroy DELETE /api/catalog/pathways/
CatalogApi catalogPathwaysRetrieve GET /api/catalog/pathways/
CatalogApi catalogProgramsCreate POST /api/catalog/programs/
CatalogApi catalogProgramsDestroy DELETE /api/catalog/programs/
CatalogApi catalogProgramsRetrieve GET /api/catalog/programs/
CatalogApi catalogRecommendationCoursesRetrieve GET /api/catalog/recommendation/courses/
CatalogApi catalogResourcesCreate POST /api/catalog/resources/
CatalogApi catalogResourcesDestroy DELETE /api/catalog/resources/
CatalogApi catalogResourcesRetrieve GET /api/catalog/resources/
CatalogApi catalogReviewsCoursesCreate POST /api/catalog/reviews/courses/
CatalogApi catalogReviewsCoursesRetrieve GET /api/catalog/reviews/courses/
CatalogApi catalogRolesCreate POST /api/catalog/roles/
CatalogApi catalogRolesDesiredCreate POST /api/catalog/roles/desired/
CatalogApi catalogRolesDesiredRetrieve GET /api/catalog/roles/desired/
CatalogApi catalogRolesReportedCreate POST /api/catalog/roles/reported/
CatalogApi catalogRolesReportedRetrieve GET /api/catalog/roles/reported/
CatalogApi catalogRolesRetrieve GET /api/catalog/roles/
CatalogApi catalogSearchProgramsCreate POST /api/catalog/search/programs/
CatalogApi catalogSkillsCreate POST /api/catalog/skills/
CatalogApi catalogSkillsDesiredCreate POST /api/catalog/skills/desired/
CatalogApi catalogSkillsDesiredRetrieve GET /api/catalog/skills/desired/
CatalogApi catalogSkillsReportedCreate POST /api/catalog/skills/reported/
CatalogApi catalogSkillsReportedRetrieve GET /api/catalog/skills/reported/
CatalogApi catalogSkillsRetrieve GET /api/catalog/skills/
CoreApi coreLauncherCreate POST /api/core/launcher/
CoreApi coreLauncherRetrieve GET /api/core/launcher/
CoreApi corePlatformConfigSiteCreate POST /api/core/platform/config/site/
CoreApi corePlatformConfigSiteRetrieve GET /api/core/platform/config/site/
CoreApi corePlatformCreate POST /api/core/platform/
CoreApi corePlatformRetrieve GET /api/core/platform/
CoreApi corePlatformUsersRetrieve GET /api/core/platform/users/
CoreApi coreSignalsEdxCreate POST /api/core/signals/edx/
CoreApi coreUsersPlatformsCreate POST /api/core/users/platforms/
CoreApi coreUsersPlatformsList GET /api/core/users/platforms/
CoreApi coreUsersProxyBulkCreate POST /api/core/users/proxy/bulk/
CoreApi coreUsersProxyCreate POST /api/core/users/proxy/
CoreApi coreUsersProxyRetrieve GET /api/core/users/proxy/
CoreApi coreUsersSearchRetrieve GET /api/core/users/search
CredApi credV2AssertionsRetrieve GET /api/cred/v2/assertions/
CredApi credV2AssertionsRetrieve2 GET /api/cred/v2/assertions/{entity_id}
CredApi credV2AssertionsUpdate PUT /api/cred/v2/assertions/{entity_id}
CredApi credV2CredentialsAssertionsBulkCreate POST /api/cred/v2/credentials/{entity_id}/assertions/bulk/
CredApi credV2CredentialsAssertionsCreate POST /api/cred/v2/credentials/{entity_id}/assertions/
CredApi credV2CredentialsAssertionsRetrieve GET /api/cred/v2/credentials/{entity_id}/assertions/
CredApi credV2CredentialsCreate POST /api/cred/v2/credentials/
CredApi credV2CredentialsDestroy DELETE /api/cred/v2/credentials/{entity_id}
CredApi credV2CredentialsRetrieve GET /api/cred/v2/credentials/
CredApi credV2CredentialsRetrieve2 GET /api/cred/v2/credentials/{entity_id}
CredApi credV2CredentialsUpdate PUT /api/cred/v2/credentials/{entity_id}
CredApi credV2IssuersAuthorityCreate POST /api/cred/v2/issuers/authority/
CredApi credV2IssuersCreate POST /api/cred/v2/issuers/
CredApi credV2IssuersDestroy DELETE /api/cred/v2/issuers/{entity_id}
CredApi credV2IssuersRetrieve GET /api/cred/v2/issuers/
CredApi credV2IssuersRetrieve2 GET /api/cred/v2/issuers/{entity_id}
CredApi credV2IssuersUpdate PUT /api/cred/v2/issuers/{entity_id}
CredentialsApi credentialsOrgsAssertionsList GET /api/credentials/orgs/{org}/assertions/
CredentialsApi credentialsOrgsAssertionsOverTimeRetrieve GET /api/credentials/orgs/{org}/assertions-over-time/
CredentialsApi credentialsOrgsCourseAssertionsOverTimeRetrieve GET /api/credentials/orgs/{org}/course-assertions-over-time/
CredentialsApi credentialsOrgsCourseCredentialsList GET /api/credentials/orgs/{org}/course-credentials/
CredentialsApi credentialsOrgsCredentialsOverTimeRetrieve GET /api/credentials/orgs/{org}/credentials-over-time/
CredentialsApi credentialsOrgsCredentialsRetrieve GET /api/credentials/orgs/{org}/credentials/{id}/
CredentialsApi credentialsOrgsList GET /api/credentials/orgs/{org}/
DocumentsearchApi documentsearchRetrieve GET /documentsearch/
EngagementApi engagementOrgsActivityRetrieve GET /api/engagement/orgs/{org}/activity
EngagementApi engagementOrgsCourseCompletionPerCourseRetrieve GET /api/engagement/orgs/{org}/course_completion/per-course
EngagementApi engagementOrgsCoursesTimeAverageRetrieve GET /api/engagement/orgs/{org}/courses/{course_id}/time/average
EngagementApi engagementOrgsCoursesTimeDetailRetrieve GET /api/engagement/orgs/{org}/courses/{course_id}/time/detail
EngagementApi engagementOrgsCoursesTimeOverTimeRetrieve GET /api/engagement/orgs/{org}/courses/{course_id}/time/over-time
EngagementApi engagementOrgsCoursesTimeUsersDetailRetrieve GET /api/engagement/orgs/{org}/courses/{course_id}/time/users/{user_id}/detail
EngagementApi engagementOrgsCoursesTimeUsersOverTimeRetrieve GET /api/engagement/orgs/{org}/courses/{course_id}/time/users/{user_id}/over-time
EngagementApi engagementOrgsCoursesTimeUsersRetrieve GET /api/engagement/orgs/{org}/courses/{course_id}/time/users
EngagementApi engagementOrgsCoursesVideosOverTimeRetrieve GET /api/engagement/orgs/{org}/courses/{course_id}/videos/over-time
EngagementApi engagementOrgsCoursesVideosRetrieve GET /api/engagement/orgs/{org}/courses/{course_id}/videos/
EngagementApi engagementOrgsCoursesVideosSummaryRetrieve GET /api/engagement/orgs/{org}/courses/{course_id}/videos/summary
EngagementApi engagementOrgsCoursesVideosUsersRetrieve GET /api/engagement/orgs/{org}/courses/{course_id}/videos/users
EngagementApi engagementOrgsTimeAveragePerlearnerPercourseRetrieve GET /api/engagement/orgs/{org}/time/average-perlearner-percourse
EngagementApi engagementOrgsTimeAverageWithOverTimeRetrieve GET /api/engagement/orgs/{org}/time/average-with-over-time
EngagementApi engagementOrgsTimeOverTimeRetrieve GET /api/engagement/orgs/{org}/time/over-time
EngagementApi engagementOrgsTimePerCourseRetrieve GET /api/engagement/orgs/{org}/time/per-course
EngagementApi engagementOrgsVideosOverTimeRetrieve GET /api/engagement/orgs/{org}/videos/over-time
EngagementApi engagementOrgsVideosRetrieve GET /api/engagement/orgs/{org}/videos/
EsHealthApi esHealthRetrieve GET /es-health/
FinanceApi financeOrgsProductsOrdersRetrieve GET /api/finance/orgs/{org}/products/{item_id}/orders
FinanceApi financeOrgsProductsRetrieve GET /api/finance/orgs/{org}/products
FinanceApi financeOrgsProductsSalesOverTimeRetrieve GET /api/finance/orgs/{org}/products/{item_id}/sales-over-time
FinanceApi financeOrgsRevenueNetOverTimeRetrieve GET /api/finance/orgs/{org}/revenue/net-over-time
FinanceApi financeOrgsRevenueProductsRetrieve GET /api/finance/orgs/{org}/revenue/products
MonitoringApi monitoringConnectorsRetrieve GET /monitoring/connectors/
OverviewApi overviewOrgsActiveUsersRetrieve GET /api/overview/orgs/{org}/active-users
OverviewApi overviewOrgsAverageGradeRetrieve GET /api/overview/orgs/{org}/average-grade
OverviewApi overviewOrgsCoursesCompletionsRetrieve GET /api/overview/orgs/{org}/courses/completions
OverviewApi overviewOrgsLearnersRetrieve GET /api/overview/orgs/{org}/learners
OverviewApi overviewOrgsMostActiveCoursesRetrieve GET /api/overview/orgs/{org}/most-active-courses
OverviewApi overviewOrgsRegisteredUsersRetrieve GET /api/overview/orgs/{org}/registered-users
PerformanceApi performanceOrgsCoursesGradingAverageRetrieve GET /api/performance/orgs/{org}/courses/{course_id}/grading/average
PerformanceApi performanceOrgsCoursesGradingAverageWithCutoffRetrieve GET /api/performance/orgs/{org}/courses/{course_id}/grading/average-with-cutoff
PerformanceApi performanceOrgsCoursesGradingDetailRetrieve GET /api/performance/orgs/{org}/courses/{course_id}/grading/detail
PerformanceApi performanceOrgsCoursesGradingPerLearnerRetrieve GET /api/performance/orgs/{org}/courses/{course_id}/grading/per-learner
PerformanceApi performanceOrgsCoursesGradingSummaryRetrieve GET /api/performance/orgs/{org}/courses/{course_id}/grading/summary
PerformanceApi performanceOrgsGradingAverageRetrieve GET /api/performance/orgs/{org}/grading/average
PerformanceApi performanceOrgsGradingPerCourseRetrieve GET /api/performance/orgs/{org}/grading/per-course
PerlearnerApi perlearnerOrgsUsersActivityRetrieve GET /api/perlearner/orgs/{org}/users/{user_id}/activity/
PerlearnerApi perlearnerOrgsUsersCoursesGradingCutoffsRetrieve GET /api/perlearner/orgs/{org}/users/{user_id}/courses/{course_id}/grading/cutoffs
PerlearnerApi perlearnerOrgsUsersCoursesGradingDetailRetrieve GET /api/perlearner/orgs/{org}/users/{user_id}/courses/{course_id}/grading/detail
PerlearnerApi perlearnerOrgsUsersCoursesGradingSummaryRetrieve GET /api/perlearner/orgs/{org}/users/{user_id}/courses/{course_id}/grading/summary
PerlearnerApi perlearnerOrgsUsersCoursesOverviewEngagementIndexRetrieve GET /api/perlearner/orgs/{org}/users/{user_id}/courses/{course_id}/overview/engagement-index
PerlearnerApi perlearnerOrgsUsersCoursesOverviewGradeRetrieve GET /api/perlearner/orgs/{org}/users/{user_id}/courses/{course_id}/overview/grade
PerlearnerApi perlearnerOrgsUsersCoursesOverviewPerformanceIndexRetrieve GET /api/perlearner/orgs/{org}/users/{user_id}/courses/{course_id}/overview/performance-index
PerlearnerApi perlearnerOrgsUsersCoursesOverviewTimeOverTimeRetrieve GET /api/perlearner/orgs/{org}/users/{user_id}/courses/{course_id}/overview/time/over-time
PerlearnerApi perlearnerOrgsUsersCoursesVideosOverTimeRetrieve GET /api/perlearner/orgs/{org}/users/{user_id}/courses/{course_id}/videos/over-time
PerlearnerApi perlearnerOrgsUsersCoursesVideosRetrieve GET /api/perlearner/orgs/{org}/users/{user_id}/courses/{course_id}/videos
PerlearnerApi perlearnerOrgsUsersGradesPerCourseRetrieve GET /api/perlearner/orgs/{org}/users/{user_id}/grades/per-course
PerlearnerApi perlearnerOrgsUsersInfoRetrieve GET /api/perlearner/orgs/{org}/users/{user_id}/info
PerlearnerApi perlearnerOrgsUsersLastAccessRetrieve GET /api/perlearner/orgs/{org}/users/{user_id}/last-access
PerlearnerApi perlearnerOrgsUsersOverviewEngagementIndexRetrieve GET /api/perlearner/orgs/{org}/users/{user_id}/overview/engagement-index
PerlearnerApi perlearnerOrgsUsersOverviewGradesAverageRetrieve GET /api/perlearner/orgs/{org}/users/{user_id}/overview/grades/average
PerlearnerApi perlearnerOrgsUsersOverviewPerformanceIndexRetrieve GET /api/perlearner/orgs/{org}/users/{user_id}/overview/performance-index
PerlearnerApi perlearnerOrgsUsersOverviewTimeOverTimeRetrieve GET /api/perlearner/orgs/{org}/users/{user_id}/overview/time/over-time
PerlearnerApi perlearnerOrgsUsersRetrieve GET /api/perlearner/orgs/{org}/users
PerlearnerApi perlearnerOrgsUsersVideosOverTimeRetrieve GET /api/perlearner/orgs/{org}/users/{user_id}/videos/over-time
PerlearnerApi perlearnerOrgsUsersVideosPerCourseRetrieve GET /api/perlearner/orgs/{org}/users/{user_id}/videos/per-course
PlatformApi platformOrgsCoursesCountRetrieve GET /api/platform/orgs/{org}/courses/count
PlatformApi platformOrgsCoursesGradesRetrieve GET /api/platform/orgs/{org}/courses/grades
PlatformApi platformOrgsCoursesProgressAverageDaysToCompleteRetrieve GET /api/platform/orgs/{org}/courses/{course_id}/progress/average-days-to-complete
PlatformApi platformOrgsCoursesProgressAverageTimeToCompleteRetrieve GET /api/platform/orgs/{org}/courses/{course_id}/progress/average-time-to-complete
PlatformApi platformOrgsCoursesProgressCompletedRetrieve GET /api/platform/orgs/{org}/courses/{course_id}/progress/completed
PlatformApi platformOrgsCoursesProgressCompletionRateRetrieve GET /api/platform/orgs/{org}/courses/{course_id}/progress/completion-rate
PlatformApi platformOrgsCoursesProgressInProgressRetrieve GET /api/platform/orgs/{org}/courses/{course_id}/progress/in-progress
PlatformApi platformOrgsCoursesProgressRetrieve GET /api/platform/orgs/{org}/courses/{course_id}/progress/
PlatformApi platformOrgsCoursesProgressStartedRetrieve GET /api/platform/orgs/{org}/courses/{course_id}/progress/started
PlatformApi platformOrgsCoursesUsersGradesPassedRetrieve GET /api/platform/orgs/{org}/courses/{course_id}/users/{user_id}/grades/passed
PlatformApi platformOrgsCoursesUsersProgressDaysToCompleteRetrieve GET /api/platform/orgs/{org}/courses/{course_id}/users/{user_id}/progress/days-to-complete
PlatformApi platformOrgsCoursesUsersProgressRetrieve GET /api/platform/orgs/{org}/courses/{course_id}/users/{user_id}/progress
PlatformApi platformOrgsCoursesUsersTimeCountRetrieve GET /api/platform/orgs/{org}/courses/{course_id}/users/{user_id}/time/count
PlatformApi platformOrgsCoursesUsersVideosCountRetrieve GET /api/platform/orgs/{org}/courses/{course_id}/users/{user_id}/videos/count
PlatformApi platformOrgsCoursesVideosRetrieve GET /api/platform/orgs/{org}/courses/videos
PlatformApi platformOrgsCoursesVideosRetrieve2 GET /api/platform/orgs/{org}/courses/{course_id}/videos/
PlatformApi platformOrgsProgressCompletedRetrieve GET /api/platform/orgs/{org}/progress/completed
PlatformApi platformOrgsProgressCompletionRateRetrieve GET /api/platform/orgs/{org}/progress/completion-rate
PlatformApi platformOrgsProgressInProgressRetrieve GET /api/platform/orgs/{org}/progress/in-progress
PlatformApi platformOrgsProgressStartedRetrieve GET /api/platform/orgs/{org}/progress/started
PlatformApi platformOrgsRetrieve GET /api/platform/orgs/{org}/
PlatformApi platformOrgsTimeCountRetrieve GET /api/platform/orgs/{org}/time/count
PlatformApi platformOrgsUsersActiveCountRetrieve GET /api/platform/orgs/{org}/users/active/count
PlatformApi platformOrgsUsersCountRetrieve GET /api/platform/orgs/{org}/users/count
PlatformApi platformOrgsUsersCoursesCompletedCountRetrieve GET /api/platform/orgs/{org}/users/courses-completed/count
RecommendationsApi recommendationsOrgsUsersRetrieve GET /api/recommendations/orgs/{org}/users/{user_id}/
ReportsApi reportsOrgsList GET /api/reports/orgs/{org}/
ReportsApi reportsOrgsNewCreate POST /api/reports/orgs/{org}/new
RolesApi rolesPlatformOrgsRolesUsersDesiredRolesRetrieve GET /api/roles/platform/orgs/{org}/roles/users/{username}/desired-roles/
RolesApi rolesPlatformOrgsRolesUsersReportedRolesRetrieve GET /api/roles/platform/orgs/{org}/roles/users/{username}/reported-roles/
SaasApi saasAwsSubscriptionExpiryWebhookCreate POST /api/saas/aws/subscription/expiry/webhook/
SaasApi saasCreateStripeCustomerCreate POST /api/saas/create/stripe/customer/
SaasApi saasCreateStripeCustomerPortalCreate POST /api/saas/create/stripe/customer/portal/
SaasApi saasCreateSubscriptionRetrieve GET /api/saas/create/subscription/
SaasApi saasCustomerPortalWebhookRetrieve GET /api/saas/customer/portal/webhook/
SaasApi saasLaunchTenantCreate POST /api/saas/launch/tenant/
SaasApi saasPaymentCancelRetrieve GET /api/saas/payment/cancel/
SaasApi saasPaymentSuccessRetrieve GET /api/saas/payment/success/
SaasApi saasStripeProductPurchaseRetrieve GET /api/saas/stripe/product/purchase/
SaasApi saasSubscriptionCancelRetrieve GET /api/saas/subscription/cancel/
SaasApi saasSubscriptionSuccessRetrieve GET /api/saas/subscription/success/
SearchApi searchDocumentsearchRetrieve GET /api/search/documentsearch/
SearchApi searchEsHealthRetrieve GET /api/search/es-health/
SearchApi searchRetrieve GET /search/
SearchApi searchSearchRetrieve GET /api/search/search/
ServiceApi serviceLaunchTenantCreate POST /api/service/launch/tenant/
ServiceApi serviceManageUserCreate POST /api/service/manage/user/
ServiceApi serviceManageUserRoleCreate POST /api/service/manage/user/role/
ServiceApi serviceTenantValidationCreate POST /api/service/tenant/validation/
ServiceApi serviceTokenRetrieve GET /api/service/token/
ServiceApi serviceUserValidationCreate POST /api/service/user/validation/
SkillsApi skillsOrgsSkillsList GET /api/skills/orgs/{org}/skills
SkillsApi skillsOrgsSkillsPercentileList GET /api/skills/orgs/{org}/skills/percentile/
SkillsApi skillsOrgsSkillsPercentileRetrieve GET /api/skills/orgs/{org}/skills/{skill_id}/percentile/
SkillsApi skillsOrgsSkillsRetrieve GET /api/skills/orgs/{org}/skills/{skill_name}/
SkillsApi skillsOrgsSkillsThresholdsCreate POST /api/skills/orgs/{org}/skills/thresholds/
SkillsApi skillsOrgsSkillsThresholdsDestroy DELETE /api/skills/orgs/{org}/skills/thresholds/
SkillsApi skillsOrgsSkillsThresholdsPartialUpdate PATCH /api/skills/orgs/{org}/skills/thresholds/
SkillsApi skillsOrgsSkillsThresholdsRetrieve GET /api/skills/orgs/{org}/skills/thresholds/
SkillsApi skillsOrgsSkillsUsersDesiredSkillsRetrieve GET /api/skills/orgs/{org}/skills/users/{user_id}/desired-skills/
SkillsApi skillsOrgsSkillsUsersPointPercentileRetrieve GET /api/skills/orgs/{org}/skills/users/{user_id}/point-percentile/
SkillsApi skillsOrgsSkillsUsersReportedSkillsRetrieve GET /api/skills/orgs/{org}/skills/users/{user_id}/reported-skills/
SkillsApi skillsOrgsSkillsUsersRetrieve GET /api/skills/orgs/{org}/skills/users/{user_id}/

Documentation For Models #

Documentation For Authorization #

Endpoints do not require authorization.

Author #