AWorld Lab API Reference
API ReferenceApp API (Consumer)Dashboard API (Admin)
API ReferenceApp API (Consumer)Dashboard API (Admin)
  1. AI
  • AI
    • Generate an image with AI
      POST
    • Generate learning path
      POST
    • Generate learning path audio narration
      POST
    • Translate learning path
      POST
    • Generate per-slide avatar video
      POST
    • Translate content
      POST
    • Get AI image generation status
      GET
    • Get generation status
      GET
    • Cancel generation
      DELETE
    • Continue AI generation
      POST
    • List available TTS voices
      GET
    • Ask the assistant
      POST
    • Generate text
      POST
    • Prepare document reading
      GET
    • How a learning path was generated
      GET
    • List the figures of a learning path's documents
      GET
  • Activities
    • Tags
      • List activity tag assignments
      • Create multiple activity tag assignments
      • Update multiple activity tag assignments
      • Delete multiple activity tag assignments
      • Get activity tag assignment
      • Create activity tag assignment
      • Update activity tag assignment
      • Delete activity tag assignment
    • Translations
      • List activity translations
    • List activities
    • Create activity
    • Get activity
    • Update activity
    • List latest activity history across the workspace
    • Archive activity
    • List all history versions of a activity
    • Publish activity
    • Unarchive activity
    • Get an activity history version
    • Get activity translations at a history version
  • Analytics
    • Get content analytics
    • Get economy analytics
    • Get engagement analytics
    • Get gamification analytics
    • Get learning analytics
    • Get analytics overview
    • Get quiz analytics
    • List user analytics
    • Get learning-path detail analytics
    • Get user detail analytics
    • Get survey analytics
    • Get one survey's analytics
    • List one question's answers verbatim
    • List one survey's respondents
  • BadgeConfigurations
    • Tags
      • Create multiple badge configuration tag assignments
      • Delete multiple badge configuration tag assignments
      • List badge configuration tag assignments
      • Update multiple badge configuration tag assignments
      • Create badge configuration tag assignment
      • Delete badge configuration tag assignment
      • Get badge configuration tag assignment
      • Update badge configuration tag assignment
    • Translations
      • List badge configuration translations
    • Create badge configuration
    • List badge configurations
    • Get badge configuration
    • Update badge configuration
    • List latest badgeConfiguration history across the workspace
    • Archive badge configuration
    • List all history versions of a badgeConfiguration
    • Publish badge configuration
    • Unarchive badge configuration
    • Get a badge configuration history version
    • Get badgeConfiguration translations at a history version
  • ContentLayouts
    • Create content layout
    • List content layouts
    • Get content layout
    • Update content layout
    • List latest contentLayout history across the workspace
    • Archive content layout
    • Clone content layout
    • List all history versions of a contentLayout
    • Publish content layout
    • Unarchive content layout
    • Get a content layout history version
    • Get contentLayout translations at a history version
  • ContentThemes
    • List content themes
    • Create content theme
    • Get content theme by ID
    • Update content theme
    • List latest contentTheme history across the workspace
    • Archive a content theme
    • Search content themes
    • Clone content theme from catalog
    • List all history versions of a contentTheme
    • Publish a content theme
    • Unarchive a content theme
    • Get a content theme history version
    • Get contentTheme translations at a history version
  • EmailTemplates
    • List email templates
    • Create email template
    • Get email template
    • Update email template
    • List latest emailTemplate history across the workspace
    • List all history versions of a emailTemplate
    • Publish email template
    • Get an email template history version
    • Get emailTemplate translations at a history version
    • Get core email template
  • Learning Groups
    • Tags
      • List learning group tag assignments
      • Create multiple learning group tag assignments
      • Update multiple learning group tag assignments
      • Delete multiple learning group tag assignments
      • Get learning group tag assignment
      • Create learning group tag assignment
      • Update learning group tag assignment
      • Delete learning group tag assignment
    • Translations
      • List learning group translations
    • List learning groups
    • Create learning group
    • Get learning group
    • Update learning group
    • Archive learning group
    • Publish learning group
    • Unarchive learning group
  • Learning Paths
    • Assignments
      • List learning path assignments
    • Items
      • List learning group items
      • List learning path items
    • Tags
      • List learning path tag assignments
      • Create multiple learning path tag assignments
      • Update multiple learning path tag assignments
      • Delete multiple learning path tag assignments
      • Get learning path tag assignment
      • Create learning path tag assignment
      • Update learning path tag assignment
      • Delete learning path tag assignment
    • Translations
      • List learning path translations
    • List learning paths
    • Create learning path
    • Get learning path
    • Update learning path
    • Archive learning path
    • Clone learning path
    • Publish learning path
    • Unarchive learning path
  • LearningPathAssignments
    • List learning path assignments
    • Create learning path assignment
    • Delete learning path assignments (bulk)
    • Get learning path assignment
    • Delete a learning path assignment
    • Count learning path assignments
    • Search learning path assignments
  • LearningPathRules
    • List learning path rules
    • Create learning path rule
    • Get learning path rule
    • Update learning path rule
    • List latest learningPathRule history across the workspace
    • Preview matching users and learning paths
    • Archive learning path rule
    • List all history versions of a learningPathRule
    • Publish learning path rule
    • Get a learning path rule history version
    • Get learningPathRule translations at a history version
  • Media
    • Tags
      • List media tag assignments
      • Create multiple media tag assignments
      • Update multiple media tag assignments
      • Delete multiple media tag assignments
      • Get media tag assignment
      • Create media tag assignment
      • Update media tag assignment
      • Delete media tag assignment
    • Translations
      • List media translations
    • List media files
    • Get media file by ID
    • Update media file metadata
    • Delete media file
    • Search media
    • Get presigned upload URL
    • Show or hide a media file
  • MissionConfigurations
    • Tags
      • List mission configuration tag assignments
      • Create multiple mission configuration tag assignments
      • Update multiple mission configuration tag assignments
      • Delete multiple mission configuration tag assignments
      • Get mission configuration tag assignment
      • Create mission configuration tag assignment
      • Update mission configuration tag assignment
      • Delete mission configuration tag assignment
    • Translations
      • List mission configuration translations
    • List mission configurations
    • Create mission configuration
    • Get mission configuration
    • Update mission configuration
    • List latest missionConfiguration history across the workspace
    • Archive mission configuration
    • List all history versions of a missionConfiguration
    • Publish mission configuration
    • Unarchive mission configuration
    • Get a mission configuration history version
    • Get missionConfiguration translations at a history version
  • MissionRules
    • Tags
      • List mission rule tag assignments
      • Create multiple mission rule tag assignments
      • Update multiple mission rule tag assignments
      • Delete multiple mission rule tag assignments
      • Get mission rule tag assignment
      • Create mission rule tag assignment
      • Update mission rule tag assignment
      • Delete mission rule tag assignment
    • Translations
      • List mission rule translations
    • List mission rules
    • Create mission rule
    • Get mission rule
    • Update mission rule
    • List latest missionRule history across the workspace
    • Archive mission rule
    • List all history versions of a missionRule
    • Publish mission rule
    • Unarchive mission rule
    • Get a mission rule history version
    • Get missionRule translations at a history version
  • Missions
    • Create mission
  • Mobility
    • List mobility activations
    • Create or update mobility activation
    • List mobility milestones
    • List mobility trackings
    • Get mobility milestone
    • Get MotionTag status
    • Get MotionTag token
    • Redeem mobility milestone
  • Quizzes
    • Tags
      • Create multiple quiz tag assignments
      • Delete multiple quiz tag assignments
      • List quiz tag assignments
      • Update multiple quiz tag assignments
      • Create quiz tag assignment
      • Delete quiz tag assignment
      • Get quiz tag assignment
      • Update quiz tag assignment
    • Create quiz (deprecated: use POST /quizzes/choice)
    • List quizzes
    • Get quiz
    • Update quiz (deprecated: use PUT /quizzes/choice/{quizId})
    • List latest quiz history across the workspace
    • Archive quiz
    • Clone quiz
    • List all history versions of a quiz
    • Publish quiz
    • Unarchive quiz
    • Get a quiz history version
    • Get quiz translations at a history version
    • Create a choice quiz
    • Create a fill-the-blanks exercise
    • Create a matching exercise
    • Create a sorting exercise
    • Update a choice quiz
    • Update a fill-the-blanks exercise
    • Update a matching exercise
    • Update a sorting exercise
  • RewardRules
    • Translations
      • List reward rule translations
    • List reward rules
    • Create reward rule
    • Get reward rule
    • Update reward rule
    • List latest rewardRule history across the workspace
    • Archive reward rule
    • List all history versions of a rewardRule
    • Publish reward rule
    • Unarchive reward rule
    • Get a reward rule history version
    • Get rewardRule translations at a history version
  • Runtime Leaderboards
    • List runtime leaderboards
    • Create runtime leaderboard
    • Get runtime leaderboard
    • Update runtime leaderboard
    • Archive runtime leaderboard
    • Preview leaderboard rankings
    • Get leaderboard rankings
    • Unarchive runtime leaderboard
  • RuntimeLeaderboardConfigurations
    • List runtime leaderboard configurations
    • Create runtime leaderboard configuration
    • Get runtime leaderboard configuration
    • Update runtime leaderboard configuration
    • List latest runtimeLeaderboardConfiguration history across the workspace
    • Archive runtime leaderboard configuration
    • List all history versions of a runtimeLeaderboardConfiguration
    • Create runtime leaderboard instance
    • Publish runtime leaderboard configuration
    • List runtime leaderboard configuration translations
    • Unarchive runtime leaderboard configuration
    • Get a runtime leaderboard configuration history version
    • Get runtimeLeaderboardConfiguration translations at a history version
    • Search leaderboard configuration history (active, or archived)
    • List runtime leaderboard instances of a configuration
    • List archived runtime leaderboard instances of a configuration
  • Slides
    • Tags
      • List slide tag assignments
      • Create multiple slide tag assignments
      • Update multiple slide tag assignments
      • Delete multiple slide tag assignments
      • Get slide tag assignment
      • Create slide tag assignment
      • Update slide tag assignment
      • Delete slide tag assignment
    • Translations
      • List slide translations
    • List slides
    • Create slide
    • Get slide
    • Update slide
    • List latest slide history across the workspace
    • Archive slide
    • Clone slide
    • List all history versions of a slide
    • Publish slide
    • Unarchive slide
    • Get a slide history version
    • Get slide translations at a history version
  • StreakConfigurations
    • Tags
      • Create multiple streak configuration tag assignments
      • Delete multiple streak configuration tag assignments
      • List streak configuration tag assignments
      • Update multiple streak configuration tag assignments
      • Create streak configuration tag assignment
      • Delete streak configuration tag assignment
      • Get streak configuration tag assignment
      • Update streak configuration tag assignment
    • Translations
      • List streak configuration translations
    • Create streak configuration
    • List streak configurations
    • Get streak configuration
    • Update streak configuration
    • List latest streakConfiguration history across the workspace
    • Archive streak configuration
    • List all history versions of a streakConfiguration
    • Publish streak configuration
    • Unarchive streak configuration
    • Get a streak configuration history version
    • Get streakConfiguration translations at a history version
  • StreakRules
    • Tags
      • Create multiple streak rule tag assignments
      • Delete multiple streak rule tag assignments
      • List streak rule tag assignments
      • Update multiple streak rule tag assignments
      • Create streak rule tag assignment
      • Delete streak rule tag assignment
      • Get streak rule tag assignment
      • Update streak rule tag assignment
    • Translations
      • List streak rule translations
    • Create streak rule
    • List streak rules
    • Get streak rule
    • Update streak rule
    • List latest streakRule history across the workspace
    • Archive streak rule
    • List all history versions of a streakRule
    • Publish streak rule
    • Unarchive streak rule
    • Get a streak rule history version
    • Get streakRule translations at a history version
  • TagRules
    • Translations
      • List tag rule translations
    • List tag rules
    • Create tag rule
    • Get tag rule by ID
    • Update tag rule
    • List latest tagRule history across the workspace
    • Archive tag rule
    • List all history versions of a tagRule
    • Publish tag rule
    • Unarchive tag rule
    • Get a tag rule history version
    • Get tagRule translations at a history version
  • Tags
    • List tags
    • Create tag
    • Get tag
    • Update tag
    • List latest tag history across the workspace
    • Search tags
    • Archive tag
    • Clone tag
    • List all history versions of a tag
    • Publish tag
    • List tag translations
    • Unarchive tag
    • Get a tag history version
    • Get tag translations at a history version
  • Users
    • Tags
      • List user tag assignments
      • Create multiple user tag assignments
      • Update multiple user tag assignments
      • Delete multiple user tag assignments
      • Get user tag assignment
      • Create user tag assignment
      • Update user tag assignment
      • Delete user tag assignment
    • List users
    • Create user
    • Get current user principal
    • Get user by ID
    • Update user by ID
    • Delete (anonymise) user by ID
    • Get current user
    • Update current user
    • Search users
    • List notification preferences for a user
    • Get user by external ID
    • List notification preferences for the current user
    • Get current user permissions
    • Get current user referral code
    • Update a notification preference for a user
    • Reset a notification preference for a user
    • Update a notification preference for the current user
    • Reset a notification preference for the current user
  • VirtualCurrencies
    • List virtual currencies
    • Create virtual currency
    • Get virtual currency
    • Update virtual currency
    • List latest virtualCurrency history across the workspace
    • Archive virtual currency
    • List all history versions of a virtualCurrency
    • Publish virtual currency
    • List virtual currency translations
    • Unarchive virtual currency
    • Get a virtual currency history version
    • Get virtualCurrency translations at a history version
  • VirtualTransactions
    • Create virtual transaction
    • Search virtual transactions
  • Workspace
    • Get workspace
  • WorkspaceConfiguration
    • Get workspace configuration
    • Update workspace configuration
    • Delete workspace configuration
    • Publish workspace configuration
  • ContentLayoutTagAssignments
    • Create multiple content layout tag assignments
    • Delete multiple content layout tag assignments
    • List content layout tag assignments
    • Update multiple content layout tag assignments
    • Create content layout tag assignment
    • Delete content layout tag assignment
    • Get content layout tag assignment
    • Update content layout tag assignment
  • ContentLayoutTranslations
    • List content layout translations
  • ContentThemeTagAssignments
    • List content theme tag assignments
    • Create multiple content theme tag assignments
    • Update multiple content theme tag assignments
    • Delete multiple content theme tag assignments
    • Get content theme tag assignment
    • Create content theme tag assignment
    • Update content theme tag assignment
    • Delete content theme tag assignment
  • ContentThemeTranslations
    • List content theme translations
  • Invitations
    • List invitations
    • Create invitation
    • Get invitation by ID
    • Get invitation seat availability
    • Resend invitation
    • Revoke invitation
  • LearningGroups
    • Generate learning group
    • List latest learningGroup history across the workspace
    • Clone learning group
    • List all history versions of a learningGroup
    • Search latest learningGroup history (drafts + published)
    • Get a learning group history version
    • Get learningGroup translations at a history version
  • QuizTranslations
    • List quiz translations
  • UserPrincipals
    • Get user principal
  • WorkspaceCodes
    • List workspace codes
    • Create workspace code
    • Get workspace code by ID
    • Revoke workspace code
    • Get workspace code by code string
  • WorkspaceEntitlement
    • Get workspace entitlement
  • WorkspaceSeat
    • Get workspace seat usage
  • LearningPaths
    • List latest learningPath history across the workspace
    • Search learning paths
    • List all history versions of a learningPath
    • Batch update audioContent on slide / quiz translations
    • Search latest learningPath history (drafts + published, or archived)
    • Batch update entity translations
    • Batch update videoContent on slide translations
    • Get a learning path history version
    • Get learningPath translations at a history version
  • SurveyTagAssignments
    • Create multiple survey tag assignments
    • Delete multiple survey tag assignments
    • List survey tag assignments
    • Update multiple survey tag assignments
    • Create survey tag assignment
    • Delete survey tag assignment
    • Get survey tag assignment
    • Update survey tag assignment
  • Surveys
    • Create survey
    • List surveys
    • Get survey
    • Update survey
    • List latest survey history across the workspace
    • Archive survey
    • Search surveys
    • Clone survey
    • List all history versions of a survey
    • List survey logs
    • Publish survey
    • Unarchive survey
    • Get a survey history version
    • Get survey log
    • Search latest survey history (drafts + published, or archived)
  • AuditLogs
    • List audit logs
    • Search audit logs
  • NotificationRuleTranslations
    • List notification rule translations
  • NotificationRules
    • List notification rules
    • Create notification rule
    • Get notification rule
    • Update notification rule
    • List latest notificationRule history across the workspace
    • Archive notification rule
    • List all history versions of a notificationRule
    • Publish notification rule
    • Unarchive notification rule
    • Get a notification rule history version
    • Get notificationRule translations at a history version
  • Jobs
    • Get async job status
    • Cancel an async job
  • WorkspaceSubscription
    • Get workspace subscription
  • WorkspaceEmailIdentities
    • List workspace email identities
    • Create workspace email identity
    • Get workspace email identity
    • Delete workspace email identity
    • Refresh workspace email identity status
  • Vanity Domains
    • List vanity domains
    • Register a vanity domain
    • Get a vanity domain
    • Update a vanity domain
    • Delete a vanity domain
  • ContentPresetTagAssignments
    • List content preset tag assignments
    • Create multiple content preset tag assignments
    • Update multiple content preset tag assignments
    • Delete multiple content preset tag assignments
    • Get content preset tag assignment
    • Create content preset tag assignment
    • Update content preset tag assignment
    • Delete content preset tag assignment
  • ContentPresetTranslations
    • List content preset translations
  • ContentPresets
    • List content presets
    • Create content preset
    • Get content preset by ID
    • Update content preset
    • List latest contentPreset history across the workspace
    • Search content presets
    • Archive a content preset
    • Clone a content preset
    • List all history versions of a contentPreset
    • Publish a content preset
    • Unarchive a content preset
    • Search latest content preset history (drafts + published, or archived)
    • Get a content preset history version
    • Get contentPreset translations at a history version
  • PromptTagAssignments
    • List prompt tag assignments
    • Create multiple prompt tag assignments
    • Update multiple prompt tag assignments
    • Delete multiple prompt tag assignments
    • Get prompt tag assignment
    • Create prompt tag assignment
    • Update prompt tag assignment
    • Delete prompt tag assignment
  • PromptTranslations
    • List prompt translations
  • Prompts
    • Create prompt
    • List prompts
    • Get prompt
    • Update prompt
    • List latest prompt history across the workspace
    • Search prompts
    • Archive prompt
    • Clone prompt
    • List all history versions of a prompt
    • Publish prompt
    • Unarchive prompt
    • Search latest prompt history (drafts + published, or archived)
    • Get a prompt history version
    • Get prompt translations at a history version
  • VideoAvatarTagAssignments
    • List video avatar tag assignments
    • Create multiple video avatar tag assignments
    • Update multiple video avatar tag assignments
    • Delete multiple video avatar tag assignments
    • Get video avatar tag assignment
    • Create video avatar tag assignment
    • Update video avatar tag assignment
    • Delete video avatar tag assignment
  • VideoAvatarTranslations
    • List videoAvatar translations
  • VideoAvatars
    • Create videoAvatar
    • List videoAvatars
    • Get videoAvatar
    • Update videoAvatar
    • List latest videoAvatar history across the workspace
    • Search video avatars
    • Archive videoAvatar
    • Clone videoAvatar
    • List all history versions of an videoAvatar
    • Publish videoAvatar
    • Unarchive videoAvatar
    • Search latest video avatar history (drafts + published, or archived)
    • Get an videoAvatar history version
    • Get videoAvatar translations at a history version
  • Support Tickets
    • Open a support ticket
  • BadgeLogs
    • Search badge logs
  • RuntimeLeaderboards
    • Search leaderboard instance history (active, or archived)
  • AssignmentRules
    • List assignment rules
    • Create assignment rule
    • Get assignment rule
    • Update assignment rule
    • List latest assignmentRule history across the workspace
    • Preview matching users and learning paths
    • Archive assignment rule
    • List all history versions of a assignmentRule
    • Publish assignment rule
    • Get a assignment rule history version
    • Get assignmentRule translations at a history version
  • Assignments
    • List assignments
    • Create assignment
    • Delete assignments (bulk)
    • Get assignment
    • Delete a assignment
    • Count assignments
    • Search assignments
  • Query Specs
    • Run a draft QuerySpec
  • Schemas
    • ActivityTranslation
    • ActivityWithResolvedFields
    • ArchiveActivityResponse
    • ArchiveBadgeConfigurationResponse
    • ArchiveAssignmentRuleResponse
    • ArchiveContentLayoutResponse
    • ArchiveContentPresetResponse
    • ArchiveContentThemeResponse
    • ArchiveLearningGroupResponse
    • ArchiveLearningPathResponse
    • ArchiveLearningPathRuleResponse
    • ArchiveMissionConfigurationResponse
    • ArchiveMissionRuleResponse
    • ArchiveNotificationRuleResponse
    • ArchivePromptResponse
    • ArchiveQuizResponse
    • ArchiveRewardRuleResponse
    • ArchiveRuntimeLeaderboardConfigurationResponse
    • ArchiveRuntimeLeaderboardResponse
    • ArchiveSlideResponse
    • ArchiveStreakConfigurationResponse
    • ArchiveStreakRuleResponse
    • ArchiveSurveyResponse
    • ArchiveTagResponse
    • AudioContentBatchResponse
    • ArchiveTagRuleResponse
    • BatchTranslationResponse
    • CancelGenerationResponse
    • ArchiveVideoAvatarResponse
    • ArchiveVirtualCurrencyResponse
    • CancelJobResponse
    • AuditLogActor
    • AuditLogSubject
    • CloneContentLayoutResponse
    • CloneContentPresetResponse
    • CloneContentThemeResponse
    • ContentAnalyticsResponse
    • ContinueGenerationResponse
    • CloneLearningGroupResponse
    • CloneLearningPathResponse
    • CountLearningPathAssignmentsResponse
    • CreateActivityResponse
    • ClonePromptResponse
    • CloneQuizResponse
    • CloneSlideResponse
    • CloneSurveyResponse
    • CloneTagResponse
    • CloneVideoAvatarResponse
    • CreateActivityTagAssignmentResponse
    • CreateActivityTagAssignmentsResponse
    • CountAssignmentsResponse
    • CreateBadgeConfigurationResponse
    • CreateBadgeConfigurationTagAssignmentResponse
    • CreateBadgeConfigurationTagAssignmentsResponse
    • CreateContentLayoutTagAssignmentResponse
    • CreateInvitationResponse
    • CreateAssignmentResponse
    • CreateContentLayoutTagAssignmentsResponse
    • CreateAssignmentRuleResponse
    • CreateContentPresetTagAssignmentResponse
    • CreateContentPresetTagAssignmentsResponse
    • CreateContentLayoutResponse
    • CreateChoiceResponse
    • CreateContentThemeTagAssignmentResponse
    • CreateContentThemeTagAssignmentsResponse
    • CreateContentPresetResponse
    • CreateContentThemeResponse
    • CreateLearningGroupTagAssignmentResponse
    • CreateLearningGroupTagAssignmentsResponse
    • CreateEmailTemplateResponse
    • CreateLearningGroupResponse
    • CreateLearningPathTagAssignmentResponse
    • CreateFillTheBlanksResponse
    • CreateLearningPathTagAssignmentsResponse
    • CreateMediaTagAssignmentResponse
    • CreateMobilityActivationResponse
    • CreateMediaTagAssignmentsResponse
    • CreateLearningPathResponse
    • CreateLearningPathAssignmentResponse
    • CreateMissionConfigurationTagAssignmentResponse
    • CreateMissionConfigurationTagAssignmentsResponse
    • CreateLearningPathRuleResponse
    • CreateMissionRuleTagAssignmentResponse
    • CreateMissionConfigurationResponse
    • CreateMissionRuleTagAssignmentsResponse
    • CreateMatchingResponse
    • CreateMissionResponse
    • CreateMissionRuleResponse
    • CreatePromptTagAssignmentResponse
    • CreatePromptTagAssignmentsResponse
    • CreateQuizTagAssignmentResponse
    • CreateQuizTagAssignmentsResponse
    • CreateNotificationRuleResponse
    • CreatePromptResponse
    • CreateSlideTagAssignmentResponse
    • CreateQuizResponse
    • CreateRewardRuleResponse
    • CreateSlideTagAssignmentsResponse
    • CreateRuntimeLeaderboardConfigurationResponse
    • CreateRuntimeLeaderboardInstanceResponse
    • CreateStreakConfigurationTagAssignmentResponse
    • CreateRuntimeLeaderboardResponse
    • CreateStreakConfigurationTagAssignmentsResponse
    • CreateVanityDomainResponse
    • CreateSlideResponse
    • CreateVirtualTransactionResponse
    • CreateStreakRuleTagAssignmentResponse
    • CreateStreakRuleTagAssignmentsResponse
    • CreateStreakConfigurationResponse
    • CreateWorkspaceEmailIdentityResponse
    • CreateSupportTicketResponse
    • CreateSurveyTagAssignmentResponse
    • CreateSurveyTagAssignmentsResponse
    • CreateStreakRuleResponse
    • CreateSortingResponse
    • CreateUserTagAssignmentResponse
    • CreateUserTagAssignmentsResponse
    • CreateSurveyResponse
    • CreateTagResponse
    • CreateVideoAvatarTagAssignmentResponse
    • CreateTagRuleResponse
    • DeleteLearningPathAssignmentResponse
    • CreateVideoAvatarTagAssignmentsResponse
    • CreateUserResponse
    • DeleteLearningPathAssignmentsResponse
    • DeleteMediaResponse
    • DeleteActivityTagAssignmentResponse
    • CreateVideoAvatarResponse
    • DeleteActivityTagAssignmentsResponse
    • DeleteBadgeConfigurationTagAssignmentResponse
    • CreateVirtualCurrencyResponse
    • DeleteBadgeConfigurationTagAssignmentsResponse
    • DeleteContentLayoutTagAssignmentResponse
    • CreateWorkspaceCodeResponse
    • DeleteContentLayoutTagAssignmentsResponse
    • DeleteMyNotificationPreferenceResponse
    • DeleteContentPresetTagAssignmentResponse
    • DeleteNotificationPreferenceResponse
    • DeleteContentPresetTagAssignmentsResponse
    • DeleteContentThemeTagAssignmentResponse
    • DeleteContentThemeTagAssignmentsResponse
    • DeleteAssignmentResponse
    • DeleteLearningGroupTagAssignmentResponse
    • DeleteAssignmentsResponse
    • DeleteLearningGroupTagAssignmentsResponse
    • DeleteLearningPathTagAssignmentResponse
    • DeleteLearningPathTagAssignmentsResponse
    • DeleteMediaTagAssignmentResponse
    • DeleteMediaTagAssignmentsResponse
    • DeleteUserResponse
    • DeleteMissionConfigurationTagAssignmentResponse
    • DeleteMissionConfigurationTagAssignmentsResponse
    • DeleteMissionRuleTagAssignmentResponse
    • DeleteVanityDomainResponse
    • DeleteMissionRuleTagAssignmentsResponse
    • DeleteWorkspaceConfigurationResponse
    • DeleteWorkspaceEmailIdentityResponse
    • EconomyAnalyticsResponse
    • DeletePromptTagAssignmentResponse
    • DeletePromptTagAssignmentsResponse
    • DeleteQuizTagAssignmentResponse
    • EngagementAnalyticsResponse
    • DeleteQuizTagAssignmentsResponse
    • GamificationAnalyticsResponse
    • DeleteSlideTagAssignmentResponse
    • GenerateImageResponse
    • DeleteSlideTagAssignmentsResponse
    • GenerateLearningGroupResponse
    • DeleteStreakConfigurationTagAssignmentResponse
    • GenerateLearningPathAudioResponse
    • DeleteStreakConfigurationTagAssignmentsResponse
    • GenerateLearningPathResponse
    • DeleteStreakRuleTagAssignmentResponse
    • GenerateLearningPathVideoResponse
    • DeleteStreakRuleTagAssignmentsResponse
    • GetActivityHistoryVersionResponse
    • GetActivityResponse
    • DeleteSurveyTagAssignmentResponse
    • DeleteSurveyTagAssignmentsResponse
    • GetActivityTranslationsHistoryVersionResponse
    • DeleteUserTagAssignmentResponse
    • DeleteUserTagAssignmentsResponse
    • DeleteVideoAvatarTagAssignmentResponse
    • DeleteVideoAvatarTagAssignmentsResponse
    • GetContentLayoutTranslationsHistoryVersionResponse
    • GetContentThemeTranslationsHistoryVersionResponse
    • GetCurrentUserPermissionsResponse
    • GetCurrentUserReferralCodeResponse
    • EmailTemplate
    • EmailTemplateTranslation
    • GetActivityTagAssignmentResponse
    • GetGenerationStatusResponse
    • GetInvitationResponse
    • GetBadgeConfigurationHistoryVersionResponse
    • GetBadgeConfigurationResponse
    • GetBadgeConfigurationTagAssignmentResponse
    • GetLearningGroupTranslationsHistoryVersionResponse
    • GetBadgeConfigurationTranslationsHistoryVersionResponse
    • GenerateTextResponse
    • GetContentLayoutTagAssignmentResponse
    • GetAssignmentResponse
    • GetContentPresetTagAssignmentResponse
    • GetAssignmentRuleHistoryVersionResponse
    • GetLearningPathTranslationsHistoryVersionResponse
    • GetContentPresetTranslationsHistoryVersionResponse
    • GetAssignmentRuleResponse
    • GetAssignmentRuleTranslationsHistoryVersionResponse
    • GetContentThemeTagAssignmentResponse
    • GetContentLayoutHistoryVersionResponse
    • GetMissionConfigurationTranslationsHistoryVersionResponse
    • GetContentLayoutResponse
    • GetMissionRuleTranslationsHistoryVersionResponse
    • GetMobilityMilestoneResponse
    • GetMotionTagStatusResponse
    • GetMotionTagTokenResponse
    • GetContentThemeHistoryVersionResponse
    • GetContentThemeResponse
    • GetContentPresetHistoryVersionResponse
    • GetLearningGroupTagAssignmentResponse
    • GetNotificationRuleTranslationsHistoryVersionResponse
    • GetContentPresetResponse
    • GetCoreEmailTemplateResponse
    • GetCurrentUserPrincipalResponse
    • GetCurrentUserResponse
    • GetEmailTemplateHistoryVersionResponse
    • GetEmailTemplateResponse
    • GetLearningPathTagAssignmentResponse
    • GetEmailTemplateTranslationsHistoryVersionResponse
    • GetRuntimeLeaderboardConfigurationTranslationsHistoryVersionResponse
    • GetMediaTagAssignmentResponse
    • GetLearningGroupHistoryVersionResponse
    • GetLearningGroupResponse
    • GetMissionConfigurationTagAssignmentResponse
    • GetMissionRuleTagAssignmentResponse
    • GetStreakConfigurationTranslationsHistoryVersionResponse
    • GetLearningPathAssignmentResponse
    • GetLearningPathRuleTranslationsHistoryVersionResponse
    • GetLearningPathHistoryVersionResponse
    • GetLearningPathResponse
    • GetLearningPathRuleHistoryVersionResponse
    • GetStreakRuleTranslationsHistoryVersionResponse
    • GetLearningPathRuleResponse
    • GetMissionConfigurationHistoryVersionResponse
    • GetMissionConfigurationResponse
    • GetPromptTagAssignmentResponse
    • GetMediaResponse
    • GetPromptTranslationsHistoryVersionResponse
    • GetMissionRuleHistoryVersionResponse
    • GetMissionRuleResponse
    • GetQuizTagAssignmentResponse
    • GetTagRuleTranslationsHistoryVersionResponse
    • GetTagTranslationsHistoryVersionResponse
    • GetUploadUrlResponse
    • GetNotificationRuleHistoryVersionResponse
    • GetNotificationRuleResponse
    • GetVanityDomainResponse
    • GetPromptHistoryVersionResponse
    • GetRuntimeLeaderboardRankingsResponse
    • GetPromptResponse
    • GetVirtualCurrencyTranslationsHistoryVersionResponse
    • GetSlideTagAssignmentResponse
    • GetWorkspaceEmailIdentityResponse
    • GetStreakConfigurationTagAssignmentResponse
    • GetRewardRuleHistoryVersionResponse
    • GetRewardRuleResponse
    • GetQuizHistoryVersionResponse
    • GetRewardRuleTranslationsHistoryVersionResponse
    • GetQuizResponse
    • GetWorkspaceSeatResponse
    • GetRuntimeLeaderboardConfigurationHistoryVersionResponse
    • GetRuntimeLeaderboardConfigurationResponse
    • GetStreakRuleTagAssignmentResponse
    • ImageGenerationStatusResponse
    • GetQuizTranslationsHistoryVersionResponse
    • Invitation
    • InvitationSeatAvailability
    • GetRuntimeLeaderboardResponse
    • JobStatusResponse
    • JobStep
    • GetSurveyTagAssignmentResponse
    • Lang
    • LearningAnalyticsDetailResponse
    • GetStreakConfigurationHistoryVersionResponse
    • LearningAnalyticsListResponse
    • GetStreakConfigurationResponse
    • ListActivitiesResponse
    • GetSlideHistoryVersionResponse
    • GetSlideResponse
    • ListActivityHistoryResponse
    • ListActivityHistoryVersionsResponse
    • GetSlideTranslationsHistoryVersionResponse
    • GetStreakRuleHistoryVersionResponse
    • GetStreakRuleResponse
    • ListActivityTranslationsResponse
    • GetUserTagAssignmentResponse
    • GetSurveyHistoryVersionResponse
    • GetSurveyLogResponse
    • GetSurveyResponse
    • GetTagHistoryVersionResponse
    • GetVideoAvatarTagAssignmentResponse
    • GetTagResponse
    • GetVideoAvatarTranslationsHistoryVersionResponse
    • GetTagRuleHistoryVersionResponse
    • GetTagRuleResponse
    • ListContentLayoutTranslationsResponse
    • GetUserByExternalIdResponse
    • GetUserPrincipalResponse
    • GetUserResponse
    • ListContentThemeTranslationsResponse
    • GetWorkspaceEntitlementResponse
    • ListEmailTemplatesResponse
    • ListInvitationsResponse
    • GetVideoAvatarHistoryVersionResponse
    • GetVideoAvatarResponse
    • GetVirtualCurrencyHistoryVersionResponse
    • GetVirtualCurrencyResponse
    • ListLearningGroupTranslationsResponse
    • GetWorkspaceCodeByCodeResponse
    • GetWorkspaceCodeResponse
    • GetWorkspaceResponse
    • ListActivityTagAssignmentsResponse
    • GetWorkspaceConfigurationResponse
    • GetWorkspaceSubscriptionResponse
    • ListAuditLogsResponse
    • ListBadgeConfigurationHistoryResponse
    • ListLearningPathTranslationsResponse
    • ListBadgeConfigurationHistoryVersionsResponse
    • ListBadgeConfigurationsResponse
    • ListBadgeConfigurationTagAssignmentsResponse
    • ListMediaResponse
    • JsonLogicExpression
    • ListBadgeConfigurationTranslationsResponse
    • ListMediaTranslationsResponse
    • ImageMode
    • ListContentLayoutTagAssignmentsResponse
    • ListMissionConfigurationTranslationsResponse
    • ListContentPresetTagAssignmentsResponse
    • ListArchivedRuntimeLeaderboardInstancesResponse
    • ListContentPresetTranslationsResponse
    • ListAssignmentRuleHistoryResponse
    • LearningPathGeneration
    • ListMissionRuleTranslationsResponse
    • ListAssignmentRuleHistoryVersionsResponse
    • ListMobilityActivationsResponse
    • ListAssignmentRulesResponse
    • ListMobilityMilestonesResponse
    • ListAssignmentsResponse
    • ListContentThemeTagAssignmentsResponse
    • ListMobilityTrackingsResponse
    • ListMyNotificationPreferencesResponse
    • ListNotificationPreferencesResponse
    • ListContentLayoutHistoryResponse
    • ListNotificationRuleTranslationsResponse
    • ListContentLayoutHistoryVersionsResponse
    • ListContentLayoutsResponse
    • ListLearningGroupTagAssignmentsResponse
    • ListRewardRulesResponse
    • ListContentThemeHistoryResponse
    • ListContentThemeHistoryVersionsResponse
    • ListContentThemesResponse
    • ListContentPresetHistoryResponse
    • ListRuntimeLeaderboardConfigurationTranslationsResponse
    • ListContentPresetHistoryVersionsResponse
    • ListContentPresetsResponse
    • ListLearningPathTagAssignmentsResponse
    • ListEmailTemplateHistoryResponse
    • ListEmailTemplateHistoryVersionsResponse
    • ListMediaTagAssignmentsResponse
    • ListLearningGroupHistoryResponse
    • ListLearningGroupHistoryVersionsResponse
    • ListLearningGroupItemsResponse
    • ListLearningGroupsResponse
    • ListMissionConfigurationTagAssignmentsResponse
    • ListStreakConfigurationTranslationsResponse
    • ListMissionRuleTagAssignmentsResponse
    • ListLearningPathHistoryVersionsResponse
    • ListLearningPathItemsResponse
    • ListStreakRuleTranslationResponse
    • ListLearningPathAssignmentsByLPResponse
    • ListLearningPathAssignmentsResponse
    • ListLearningPathHistoryResponse
    • ListLearningPathGenerationFiguresResponse
    • ListLearningPathRuleHistoryResponse
    • ListLearningPathRuleHistoryVersionsResponse
    • ListLearningPathRulesResponse
    • ListLearningPathsResponse
    • ListMissionConfigurationHistoryResponse
    • ListTagRuleTranslationsResponse
    • ListMissionConfigurationHistoryVersionsResponse
    • ListMissionConfigurationsResponse
    • ListTagTranslationsResponse
    • ListPromptTagAssignmentsResponse
    • ListPromptTranslationsResponse
    • ListMissionRuleHistoryResponse
    • ListMissionRuleHistoryVersionsResponse
    • ListVanityDomainsResponse
    • ListMissionRulesResponse
    • ListQuizTagAssignmentsResponse
    • ListVirtualCurrencyTranslationResponse
    • ListWorkspaceCodesResponse
    • ListWorkspaceEmailIdentitiesResponse
    • MediaTranslation
    • OverviewAnalyticsResponse
    • ListNotificationRuleHistoryResponse
    • ListNotificationRuleHistoryVersionsResponse
    • PreviewLearningPathRuleResponse
    • PublishActivityResponse
    • ListNotificationRulesResponse
    • ListPromptHistoryResponse
    • ListPromptHistoryVersionsResponse
    • ListPromptsResponse
    • ListSlideTagAssignmentsResponse
    • ListStreakConfigurationTagAssignmentsResponse
    • ListQuizHistoryResponse
    • ListRewardRuleHistoryResponse
    • ListQuizHistoryVersionsResponse
    • ListRewardRuleHistoryVersionsResponse
    • ListRewardRuleTranslationsResponse
    • ListQuizTranslationsResponse
    • ListStreakRuleTagAssignmentsResponse
    • ListQuizzesResponse
    • ListRuntimeLeaderboardConfigurationHistoryResponse
    • ListRuntimeLeaderboardConfigurationHistoryVersionsResponse
    • ListRuntimeLeaderboardConfigurationInstancesResponse
    • ListRuntimeLeaderboardConfigurationsResponse
    • ListRuntimeLeaderboardsResponse
    • ListSurveyTagAssignmentsResponse
    • QuizAnalyticsResponse
    • RedeemMobilityMilestoneResponse
    • RefreshWorkspaceEmailIdentityResponse
    • ResendInvitationResponse
    • ResolvedNotificationPreference
    • RevokeInvitationResponse
    • ListStreakConfigurationHistoryResponse
    • ListStreakConfigurationHistoryVersionsResponse
    • ListStreakConfigurationsResponse
    • ListSlideHistoryResponse
    • ListUserTagAssignmentsResponse
    • ListSlideHistoryVersionsResponse
    • ListSlidesResponse
    • ListStreakRuleHistoryResponse
    • ListStreakRuleHistoryVersionsResponse
    • ListSlideTranslationsResponse
    • ListStreakRulesResponse
    • ListVideoAvatarTagAssignmentsResponse
    • ListSurveyHistoryResponse
    • ListVideoAvatarTranslationsResponse
    • SourceRegion
    • ListSurveyHistoryVersionsResponse
    • Timezone
    • ListSurveyLogsResponse
    • TranslateLearningPathResponse
    • ListSurveysResponse
    • TranslateResponse
    • UnarchiveActivityResponse
    • ListTagHistoryResponse
    • ListVoicesResponse
    • ListTagHistoryVersionsResponse
    • ListTagRuleHistoryResponse
    • ListTagRuleHistoryVersionsResponse
    • ListTagRulesResponse
    • ListTagsResponse
    • ListUsersResponse
    • PreviewRuntimeLeaderboardRankingsResponse
    • PublishBadgeConfigurationResponse
    • ListVideoAvatarHistoryResponse
    • ListVideoAvatarHistoryVersionsResponse
    • ListVideoAvatarsResponse
    • ListVirtualCurrenciesResponse
    • ListVirtualCurrencyHistoryResponse
    • ListVirtualCurrencyHistoryVersionsResponse
    • UpdateActivityResponse
    • PreviewAssignmentRuleResponse
    • PublishAssignmentRuleResponse
    • MediaWithResolvedFields
    • PublishContentLayoutResponse
    • PublishContentThemeResponse
    • PublishEmailTemplateResponse
    • PublishLearningGroupResponse
    • PublishLearningPathResponse
    • PublishMissionConfigurationResponse
    • PublishMissionRuleResponse
    • PublishNotificationRuleResponse
    • PublishContentPresetResponse
    • PublishPromptResponse
    • PublishLearningPathRuleResponse
    • PublishRewardRuleResponse
    • SearchAuditLogsResponse
    • PublishRuntimeLeaderboardConfigurationResponse
    • PublishSlideResponse
    • PublishStreakConfigurationResponse
    • PublishQuizResponse
    • PublishStreakRuleResponse
    • PublishSurveyResponse
    • PublishTagResponse
    • UpdateMyNotificationPreferenceResponse
    • PublishTagRuleResponse
    • UpdateNotificationPreferenceResponse
    • PublishVirtualCurrencyResponse
    • PublishVideoAvatarResponse
    • QuerySearch
    • QuerySearchScope
    • QuerySpecDryRunResponse
    • PublishWorkspaceConfigurationResponse
    • UnarchiveBadgeConfigurationResponse
    • RevokeWorkspaceCodeResponse
    • RewardRuleWithResolvedFields
    • SearchAssignmentsResponse
    • SearchBadgeLogsResponse
    • SearchContentThemesResponse
    • SearchFilterExpression
    • SearchLearningGroupsHistoryResponse
    • UpdateVanityDomainResponse
    • SearchContentPresetsHistoryResponse
    • SearchContentPresetsResponse
    • SearchPromptsHistoryResponse
    • UserAnalyticsDetailResponse
    • SearchLearningPathAssignmentsResponse
    • SearchPromptsResponse
    • UsersAnalyticsListResponse
    • SearchLearningPathsHistoryResponse
    • SearchRuntimeLeaderboardConfigurationsHistoryResponse
    • SearchLearningPathsResponse
    • VideoContentBatchResponse
    • SearchRuntimeLeaderboardsHistoryResponse
    • SearchSurveysHistoryResponse
    • UpdateActivityTagAssignmentResponse
    • SearchSurveysResponse
    • UpdateActivityTagAssignmentsResponse
    • SearchTagsResponse
    • WorkspaceEmailIdentityDnsRecord
    • SearchUsersResponse
    • SearchMediaResponse
    • WorkspaceEmailIdentityView
    • UpdateBadgeConfigurationTagAssignmentResponse
    • UpdateBadgeConfigurationResponse
    • UpdateBadgeConfigurationTagAssignmentsResponse
    • SearchVideoAvatarsHistoryResponse
    • SearchVideoAvatarsResponse
    • SurveyAnalyticsAnswersResponse
    • SearchVirtualTransactionsHistoryResponse
    • UpdateContentLayoutTagAssignmentResponse
    • SurveyAnalyticsDetailResponse
    • UpdateContentLayoutTagAssignmentsResponse
    • SurveyAnalyticsListResponse
    • SurveyAnalyticsRespondentsResponse
    • UpdateContentPresetTagAssignmentResponse
    • UpdateContentPresetTagAssignmentsResponse
    • UpdateContentThemeTagAssignmentResponse
    • UpdateContentThemeTagAssignmentsResponse
    • SetMediaVisibilityResponse
    • UnarchiveContentLayoutResponse
    • UnarchiveContentThemeResponse
    • UpdateLearningGroupTagAssignmentResponse
    • UnarchiveLearningGroupResponse
    • UpdateLearningGroupTagAssignmentsResponse
    • UnarchiveLearningPathResponse
    • UpdateLearningPathTagAssignmentResponse
    • UnarchiveMissionConfigurationResponse
    • UnarchiveMissionRuleResponse
    • UpdateLearningPathTagAssignmentsResponse
    • UnarchiveNotificationRuleResponse
    • UnarchivePromptResponse
    • UpdateMediaTagAssignmentResponse
    • UpdateMediaTagAssignmentsResponse
    • UnarchiveRewardRuleResponse
    • UnarchiveRuntimeLeaderboardConfigurationResponse
    • UnarchiveContentPresetResponse
    • UpdateMissionConfigurationTagAssignmentResponse
    • UnarchiveRuntimeLeaderboardResponse
    • UnarchiveSlideResponse
    • UpdateMissionConfigurationTagAssignmentsResponse
    • UnarchiveStreakConfigurationResponse
    • UnarchiveQuizResponse
    • UpdateMissionRuleTagAssignmentResponse
    • UnarchiveStreakRuleResponse
    • UpdateMissionRuleTagAssignmentsResponse
    • UnarchiveSurveyResponse
    • UnarchiveTagResponse
    • UnarchiveTagRuleResponse
    • UnarchiveVirtualCurrencyResponse
    • UnarchiveVideoAvatarResponse
    • UpdatePromptTagAssignmentResponse
    • UpdatePromptTagAssignmentsResponse
    • UpdateQuizTagAssignmentResponse
    • UpdateAssignmentRuleResponse
    • UpdateQuizTagAssignmentsResponse
    • UpdateContentLayoutResponse
    • UpdateSlideTagAssignmentResponse
    • UpdateSlideTagAssignmentsResponse
    • UpdateStreakConfigurationTagAssignmentResponse
    • UpdateContentThemeResponse
    • UpdateStreakConfigurationTagAssignmentsResponse
    • UpdateChoiceResponse
    • UpdateStreakRuleTagAssignmentResponse
    • UpdateStreakRuleTagAssignmentsResponse
    • UpdateCurrentUserResponse
    • UpdateEmailTemplateResponse
    • UpdateLearningGroupResponse
    • UpdateSurveyTagAssignmentResponse
    • UpdateSurveyTagAssignmentsResponse
    • UpdateLearningPathResponse
    • UpdateContentPresetResponse
    • UpdateUserTagAssignmentResponse
    • UpdateUserTagAssignmentsResponse
    • UpdateFillTheBlanksResponse
    • UpdateVideoAvatarTagAssignmentResponse
    • UpdateVideoAvatarTagAssignmentsResponse
    • UpdateMissionConfigurationResponse
    • UpdateLearningPathRuleResponse
    • UpdateMissionRuleResponse
    • UpdateMatchingResponse
    • Voice
    • UpdateNotificationRuleResponse
    • UpdatePromptResponse
    • UpdateMediaResponse
    • UpdateRewardRuleResponse
    • UpdateRuntimeLeaderboardConfigurationResponse
    • UpdateRuntimeLeaderboardResponse
    • UpdateSlideResponse
    • UpdateQuizResponse
    • UpdateStreakConfigurationResponse
    • UpdateStreakRuleResponse
    • UpdateSurveyResponse
    • UpdateTagResponse
    • UpdateSortingResponse
    • UpdateTagRuleResponse
    • UpdateUserResponse
    • UpdateVideoAvatarResponse
    • UpdateVirtualCurrencyResponse
    • WorkspaceCode
    • VirtualTransactionHistoryRewardRule
    • VirtualTransactionHistoryRuleTranslation
    • VirtualTransactionHistorySourceEntity
    • VirtualTransactionHistoryStreakRule
    • VirtualTransactionHistoryUser
    • UpdateWorkspaceConfigurationResponse
    • VirtualTransactionHistoryVirtualCurrency
    • WorkspaceConfiguration
    • WarmDocumentExtractorResponse
  1. AI

Prepare document reading

GET
/ai/documents/warm
AI
Gets document reading ready ahead of a learning path generation from attached files, so the generation does not wait for it to start.
Sends no data and changes nothing. Call it when the generation wizard opens and when a file is selected; it answers within a few seconds and never fails because of the warm-up itself: when readiness cannot be confirmed, status is unavailable and the generation still works.

Request

None

Responses

🟢200OK
application/json
Warm-up requested
Bodyapplication/json

🟠401Unauthorized
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.aworld.cloud/dashboard/v1/ai/documents/warm'
Response Response Example
{
    "status": "warm"
}
Modified at 2026-10-22 16:59:20
Previous
Generate text
Next
How a learning path was generated
Built with