Máquina do Tempo (versão prévia)

O Time Machine é uma plataforma de aprendizado corporativo habilitada para IA. Ele transforma documentos, vídeos e conhecimentos de especialistas da empresa em cursos estruturados com módulos, tópicos, testes e exercícios de role-play e acompanha o progresso do aprendiz. Criado para equipes de RH e L&D que integram, treinam e certificam funcionários em escala. O conector automatiza o ciclo de vida de aprendizado completo: gerenciar cursos, usuários, departamentos e funções; gerar testes de documentos; e leia a análise de conclusão.

Esse conector está disponível nos seguintes produtos e regiões:

Serviço	Class	Regions
Copilot Studio	Premium	Todas as regiões Power Automate exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Aplicativos Lógicos	Standard	Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Azure Governamental regiões - Azure regiões da China - Departamento de Defesa dos EUA (DoD)
Power Apps	Premium	Todas as regiões Power Apps exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Power Automate	Premium	Todas as regiões Power Automate exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)

Contato
Nome	Suporte ao computador de tempo
URL	https://timeml.ai

Metadados do conector
Publicador	IA do computador de tempo
Site	https://timeml.ai
Política de privacidade	https://timeml.ai/privacy-policy
Categories	Produtividade; IA

Máquina do Tempo – conector Power Automate

O que é o Computador de Tempo

O Time Machine é uma plataforma de aprendizado organizacional alimentada por IA que ajuda as empresas a criar, operar e melhorar continuamente os sistemas de aprendizagem adaptáveis para equipes modernas. As organizações usam o Time Machine para transformar conhecimentos, documentos, gravações e fluxos de trabalho existentes em experiências de treinamento escalonáveis que aceleram a integração, melhoram a preparação da força de trabalho e replicam a experiência de alto desempenho em toda a organização.

Os administradores de locatários gerenciam usuários, conteúdo de aprendizado, recursos organizacionais e configuração de plataforma por meio da API REST do Time Machine. Esse conector expõe a API REST pública como Power Automate ações, permitindo que você automatize o provisionamento de usuário, a ingestão de conteúdo, a sincronização de conhecimento e o gerenciamento do ciclo de vida sem escrever código.

Pré-requisitos

Um locatário do Time Machine ativo com acesso de administrador
Uma chave de API do Computador de Tempo emitida de Configurações → Chaves de API no painel de administração (https://web.timeml.ai). A chave é um valor que começa com tm_live_.

Authentication

Cada ação é autenticada com uma chave de API no Authorization cabeçalho. Ao criar uma conexão no Power Automate:

Campo: API key
Valor: cole Bearer tm_live_<your-token> (a cadeia de caracteres completa, incluindo o Bearer prefixo e um espaço antes do token)

Ações disponíveis

O conector espelha a API REST pública da Máquina do Tempo (116 pontos de extremidade). As ações são agrupadas por recurso:

Cursos — listar/criar/atualizar/excluir/publicar cursos, atribuir funções, gerar conteúdo criado por IA
Usuários — listar/criar/atualizar/desativar/reativar usuários
Documentos — listar/carregar/atualizar/excluir documentos
Mídia — listar/carregar/atualizar/excluir itens de mídia
Departamentos — listar/criar/atualizar/excluir departamentos, gerenciar funções, atribuir usuários a funções
Especialistas — listar/criar perfis de especialistas, fazer perguntas a especialistas, atribuir documentos e funções
Treinamentos de demonstração — listar/criar/atualizar/excluir treinamentos de demonstração
Conteúdo do Curso – módulos, tópicos, lições, exercícios, perguntas de teste
Insights – análise por aluno, por curso e no nível da empresa
Certificados – listar certificados de alunos, baixar PDFs de certificado

A referência completa do ponto de extremidade está disponível em https://api.timeml.ai/api/v1/docs.

Exemplos de fluxos de trabalho

Versão do Confluence → Time Machine: quando uma página de lançamento é publicada no Confluence, carregue-a como um Documento no Computador do Tempo para que ela flua para a biblioteca de bytes de aprendizado.
Integração de RH: quando uma nova linha de funcionário aparece em seu HRIS, crie um usuário do Time Machine com suas atribuições de função e departamento, disparando o convite de link mágico.
Notificações de conclusão do curso: quando um aluno concluir um curso, envie um pdf de certificado para o Slack e registre a conclusão em uma Planilha do Google.

Limitações conhecidas

Rotação de chaves de API: as conexões devem ser atualizadas manualmente quando a chave de API é girada. Não há mecanismo de atualização automática.
Uploads de várias partes: ações de upload de arquivo (Carregar Documento, Carregar Mídia) aceitam arquivos de até 50 MB. Para mídia maior, divida em vários uploads ou entre em contato com o suporte do Time Machine.
Operações em lote: a API opera em um registro por vez. Para ações em massa, use o controle de aplicação interno de Power Automate a cada um.

Support

Para perguntas ou problemas com o conector, entre em contato com sua equipe de conta do Time Machine ou com o suporte por email.support@timeml.ai

Criando uma conexão

O conector dá suporte aos seguintes tipos de autenticação:


Default	Parâmetros para criar conexão.	Todas as regiões	Não compartilhável

Padrão

Aplicável: todas as regiões

Parâmetros para criar conexão.

Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Nome	Tipo	Description	Required
Chave de API do Computador de Tempo (formato: portador tm_live_...)	secureString	A chave da API do Computador de Tempo (formato: portador tm_live_...) para esta api	Verdade

Ações

Adicionar um byte de aprendizado a um tópico	Cria um novo byte de aprendizado dentro do tópico especificado.
Adicionar um exercício ILE_TEXT a um tópico	Cria um novo exercício de ILE_TEXT dentro do tópico especificado.
Adicionar um exercício RPE_VIDEO a um tópico	Cria um novo exercício de RPE_VIDEO role-play dentro do tópico especificado.
Adicionar um exercício RPE_VOICE a um tópico	Cria um novo exercício de RPE_VOICE role-play dentro do tópico especificado.
Adicionar um módulo a um curso	Cria um novo módulo dentro do curso especificado.
Adicionar um tópico a um módulo	Cria um novo tópico dentro do módulo especificado.
Adicionar uma lição a um byte de aprendizado	Cria uma nova lição dentro do byte de aprendizado especificado.
Adicionar uma pergunta de teste a um módulo	Cria uma nova pergunta de teste dentro do módulo especificado.
Adicionar uma pergunta de teste a um tópico	Cria uma nova pergunta de teste dentro do tópico especificado.
Adicionar uma pergunta na lição	o tipo deve ser MULTIPLE_CHOICE (requer opções) ou OPEN_ENDED
Alternar a disponibilidade para os alunos	Defina se o treinamento de demonstração é publicado para os alunos. Idempotentes.
Atribuir documentos a um especialista	Vincule documentos em massa ao especialista. Idempotentes.
Atribuir funções a um curso	Aditivo – as funções já atribuídas são ignoradas. Retorna os detalhes do curso atualizado
Atribuir funções a um especialista	Aditivo – funções já atribuídas são mantidas; novos acrescentados. Retorna especialista atualizado
Atribuir um usuário a uma função	Idempotente
Atualizar metadados de bytes de aprendizado	Campos omitidos preservam valores atuais
Atualizar metadados de mídia	Atualizar nome e/ou descrição
Atualizar metadados do curso	Atualizar o nome do curso
Atualizar metadados do documento	Atualizar nome e/ou descrição
Atualizar metadados do módulo	Atualiza o nome e/ou a descrição. Campos omitidos preservam valores atuais
Atualizar metadados do tópico	Atualiza o nome e/ou a descrição. Campos omitidos preservam valores atuais
Atualizar o conteúdo da lição	O conteúdo omitido preserva o valor atual
Atualizar um departamento	Atualizar nome e/ou descrição
Atualizar um exercício	Reconhecimento de tipo: ILE_TEXT usa apenas prompt + generatedContent.scenario; RPE_* usa todos os campos RPE. Os campos omitidos preservam os valores atuais.
Atualizar um treinamento de demonstração	Atualização parcial. Passe apenas os campos que você deseja alterar. assignedRoleIds substitui o conjunto atual.
Atualizar um usuário	Atualize firstName, lastName, isAdmin e atribuições de função. O email não é editável na v1.
Atualizar uma pergunta de teste em um módulo	Forneça campos correspondentes ao tipo armazenado; campos não relacionados são ignorados.
Atualizar uma pergunta de teste em um tópico	Forneça campos correspondentes ao tipo armazenado; campos não relacionados são ignorados.
Atualizar uma pergunta na lição	Forneça campos correspondentes ao tipo armazenado; campos não relacionados são ignorados
Baixar pdf de certificado	Transmite o PDF do certificado. Retorna 404 se o certificado ainda não tiver PDF
Cancelar a atribuição de um documento de um especialista	Idempotente
Cancelar a atribuição de um usuário de uma função	Idempotente — 204 mesmo que não tenha sido atribuído
Carregar um documento	Upload de várias partes (arquivo + descrição opcional). Máximo de 50 MB.
Carregar um item de mídia	Upload de várias partes (arquivo + descrição opcional). Máximo de 50 MB para imagens, 500 MB para vídeos.
Criar um curso vazio	Cria um novo shell de curso com o nome fornecido
Criar um departamento	Cria um novo departamento na empresa do chamador.
Criar um treinamento de demonstração	Cria um treinamento de demonstração de um arquivo de vídeo carregado anteriormente e inicia o processamento
Criar um usuário	Cria um usuário e dispara o fluxo de convite de link mágico
Criar uma função em um departamento	Cria uma nova função com escopo para o departamento fornecido.
Definir a contagem de testes de módulo para um tipo de pergunta	Substitui a contagem do questionType especificado (MULTIPLE_CHOICE ou OPEN_ENDED). A contagem de outros tipos é preservada
Definir a contagem de testes de tópico para um tipo de pergunta	Substitui a contagem do questionType especificado (MULTIPLE_CHOICE ou OPEN_ENDED). A contagem de outros tipos é preservada
Definir ou substituir uma introdução de módulo	Upsert – cria se ausente, substitui se presente
Definir ou substituir uma introdução de tópico	Upsert – cria se ausente, substitui se presente
Desativar um usuário	Idempotente – retorna o usuário mesmo que já tenha sido desativado
Desvincular um documento de um tópico	Idempotente
Detalhes do certificado	Retorna um certificado com escopo para a empresa do chamador
Disparar geração de conteúdo de IA para tópicos	Enfileira a geração de conteúdo de IA para os tópicos especificados no curso
Eventos de atividade por aluno	Fluxo de eventos somente para encaminhamento paginado
Excluir (desativar) um departamento	Idempotente — retorna 204 mesmo que já tenha sido desativado. Cascatas para atribuições de função.
Excluir (desativar) um documento	Idempotente — retorna 204 mesmo se o documento já estiver excluído ou ausente
Excluir (desativar) um item de mídia	Idempotente — retorna 204 mesmo se o item já estiver excluído ou ausente
Excluir (suave) um curso	Idempotente — retorna 204 mesmo que o curso já tenha sido removido
Excluir um byte de aprendizado (suave)	Idempotente — 204 mesmo que já tenha sido removido
Excluir um exercício	Idempotente — 204 mesmo que já tenha sido removido
Excluir um módulo (suave)	Idempotente – retorna 204 mesmo que o módulo já tenha sido removido
Excluir um treinamento de demonstração	Idempotente – retorna 204 mesmo que o treinamento de demonstração não exista ou já tenha sumido
Excluir um tópico (suave)	Idempotente — retorna 204 mesmo que o tópico já tenha sido removido
Excluir uma lição (suave)	Idempotente — 204 mesmo que já tenha sido removido
Excluir uma pergunta de teste em um módulo	Idempotente — 204 mesmo que já tenha sido removido
Excluir uma pergunta de teste em um tópico	Idempotente — 204 mesmo que já tenha sido removido
Excluir uma pergunta na lição	Idempotente — 204 mesmo que já tenha sido removido
Executar novamente o processamento de vídeo	Envia novamente o vídeo para segmentação de IA. Opcionalmente, substitua o prompt de processamento.
Faça uma pergunta a um especialista	Wrapper síncrono em torno do chat de IA de streaming. Retorna a resposta montada.
Gerar um curso completo com conteúdo de IA	Cria o shell de curso, todos os módulos, todos os tópicos e enfileira a geração de conteúdo de IA para cada tópico
Insights no nível da empresa	KPIs de linha superior para a empresa do chamador
Insights por aluno	Resumo agregado e detalhamento por curso para a janela fornecida
Listar bytes de aprendizagem em um tópico	Retorna bytes de aprendizagem que pertencem ao tópico especificado.
Listar certificados de um aluno	Retorna certificados obtidos pelo aluno especificado dentro da empresa do chamador
Listar cursos	Lista paginada de cursos na empresa do chamador
Listar departamentos	Todos os departamentos na empresa do chamador com funções aninhadas
Listar documentos	Lista paginada de documentos na empresa do chamador
Listar documentos vinculados a um tópico	Paginado; pesquisa opcional por nome do documento
Listar especialistas	Lista paginada de especialistas na empresa do chamador
Listar exercícios em um tópico	Tipos mistos (ILE_TEXT/RPE_VOICE/RPE_VIDEO) ordenados por ordinalNumber
Listar lições em um byte de aprendizagem	Retorna lições que pertencem ao byte de aprendizagem especificado.
Listar módulos em um curso	Retorna módulos ativos ordenados por ordinalNumber
Listar perguntas de teste em um módulo	Retorna perguntas de teste anexadas ao módulo especificado.
Listar perguntas de teste em um tópico	Retorna perguntas de teste anexadas ao tópico especificado.
Listar perguntas na lição	Retorna perguntas de verificação de conhecimento anexadas à lição fornecida.
Listar treinamentos de demonstração	Lista paginada com escopo para a empresa do chamador
Listar tópicos em um módulo	Retorna tópicos ativos ordenados por ordinalNumber
Listar usuários	Lista paginada de usuários na empresa do chamador
Listar versões do curso	Retorna metadados de versão publicados (contagens + informações de publicação) ordenados pelo número de versão
Mover um tópico para outro módulo	targetOrdinalNumber é opcional; se omitido, o tópico será acrescentado ao módulo de destino
Mídia de lista	Lista paginada de itens de mídia na empresa do chamador
Obter o status de geração de IA para um curso	Retorna a lista de solicitações de geração de IA ativas para o curso com informações de progresso e destino
Obter um byte de aprendizado	Retorna metadados e lições aninhadas
Obter um curso	Retorna metadados de curso com resumos de módulo e funções/departamentos atribuídos
Obter um documento	Retorna metadados de documento e uma URL de download assinada de curta duração
Obter um especialista	Retorna metadados de especialistas, documentos vinculados e funções/departamentos atribuídos
Obter um exercício	Retorna detalhes do exercício para a ID fornecida.
Obter um instantâneo de versão do curso	Retorna a árvore de conteúdo completa (módulos, tópicos, lições, exercícios, perguntas) para a versão fornecida
Obter um item de mídia	Retorna metadados de mídia e uma URL de download assinada de curta duração
Obter um módulo	Retorna detalhes do módulo para a ID fornecida.
Obter um treinamento de demonstração	Retorna o treinamento completo de demonstração com segmentos
Obter um tópico	Retorna detalhes do tópico para a ID fornecida.
Obter um usuário	Retorna metadados de usuário e atribuições de departamento/função
Obter uma introdução de módulo	Retorna o conjunto de texto de introdução no módulo especificado.
Obter uma introdução de tópico	Retorna o conjunto de texto de introdução no tópico especificado.
Obter uma lição	Retorna conteúdo da lição, mídia e perguntas na lição
Obter uma pergunta de teste em um módulo	Retorna uma única pergunta de teste anexada ao módulo especificado.
Obter uma pergunta de teste em um tópico	Retorna uma única pergunta de teste anexada ao tópico especificado.
Obter uma pergunta na lição	Retorna uma única pergunta em lição por sua ID.
Publicar um curso	Publica o curso; falha com 400 se ele não tiver conteúdo publicável
Reativar um usuário	Idempotente – retorna o usuário mesmo que já esteja ativo
Regenerar um item específico por meio da IA	Regenera uma única lição, perguntas de lição, teste, introdução ou exercício
Remover todas as atribuições de função de um curso	Idempotente
Remover todas as atribuições de função de um especialista	Idempotente
Remover uma atribuição de função de um curso	Idempotente
Remover uma atribuição de função de um especialista	Idempotente
Remover uma introdução de módulo	Idempotente — 204 mesmo que nenhuma introdução esteja definida
Remover uma introdução de tópico	Idempotente — 204 mesmo que nenhuma introdução esteja definida
Reordenar módulos em um curso	moduleIds devem incluir todos os módulos ativos exatamente uma vez, na nova ordem
Reordenar perguntas de teste em um módulo	questionIds devem incluir todas as perguntas de teste ativas para o módulo, na nova ordem.
Reordenar perguntas de teste sobre um tópico	questionIds devem incluir todas as perguntas de teste ativas para o tópico, na nova ordem.
Reordenar perguntas na lição	questionIds devem incluir todas as perguntas ativas para a lição, na nova ordem
Reordenar tópicos dentro de um módulo	topicIds devem incluir todos os tópicos ativos exatamente uma vez, na nova ordem
Substituir binário de documento	Substitui o binário de arquivo de um documento existente; metadados são preservados
Substituir binário de mídia	Substitui o binário de arquivo de um item de mídia existente em vigor; metadados são preservados
Vincular documentos a um tópico	Aditivo — documentos já vinculados são ignorados

Adicionar um byte de aprendizado a um tópico

ID da operação:: addLearningByteToTopic

Cria um novo byte de aprendizado dentro do tópico especificado.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do tópico	topicId	True	uuid	ID do tópico
nome	name	True	string
description	description		string

Retornos

Corpo: LearningByteDetailDto

Adicionar um exercício ILE_TEXT a um tópico

ID da operação:: addIleTextExercise

Cria um novo exercício de ILE_TEXT dentro do tópico especificado.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do tópico	topicId	True	uuid	ID do tópico
solicitação	prompt		string

Retornos

Corpo: ExerciseDto

Adicionar um exercício RPE_VIDEO a um tópico

ID da operação:: addRpeVideoExercise

Cria um novo exercício de RPE_VIDEO role-play dentro do tópico especificado.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do tópico	topicId	True	uuid	ID do tópico
solicitação	prompt		string
avatarPictureId	avatarPictureId		uuid
avatarCharacteristics	avatarCharacteristics		string
reverseRolePlayEnabled	reverseRolePlayEnabled		boolean
reverseRolePlayMandatory	reverseRolePlayMandatory		boolean

Retornos

Corpo: ExerciseDto

Adicionar um exercício RPE_VOICE a um tópico

ID da operação:: addRpeVoiceExercise

Cria um novo exercício de RPE_VOICE role-play dentro do tópico especificado.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do tópico	topicId	True	uuid	ID do tópico
solicitação	prompt		string
avatarPictureId	avatarPictureId		uuid
avatarCharacteristics	avatarCharacteristics		string
reverseRolePlayEnabled	reverseRolePlayEnabled		boolean
reverseRolePlayMandatory	reverseRolePlayMandatory		boolean

Retornos

Corpo: ExerciseDto

Adicionar um módulo a um curso

ID da operação:: addModuleToCourse

Cria um novo módulo dentro do curso especificado.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do curso	courseId	True	uuid	ID do curso
nome	name	True	string
description	description		string

Retornos

Corpo: ModuleDetailDto

Adicionar um tópico a um módulo

ID da operação:: addTopicToModule

Cria um novo tópico dentro do módulo especificado.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do módulo	moduleId	True	uuid	ID do módulo
nome	name	True	string
description	description		string

Retornos

Corpo: TopicDto

Adicionar uma lição a um byte de aprendizado

ID da operação:: addLessonToLearningByte

Cria uma nova lição dentro do byte de aprendizado especificado.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Lb Id	lbId	True	uuid	Lb Id
conteúdo	content	True	string

Retornos

Corpo: LessonDetailDto

Adicionar uma pergunta de teste a um módulo

ID da operação:: addModuleQuizQuestion

Cria uma nova pergunta de teste dentro do módulo especificado.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do módulo	moduleId	True	uuid	ID do módulo
tipo	type	True	string
enviar SMS	text	True	string
ordinalNumber	ordinalNumber		integer
enviar SMS	text	True	string
isCorrect	isCorrect		boolean
expectedAnswer	expectedAnswer		string

Retornos

Corpo: QuestionDto

Adicionar uma pergunta de teste a um tópico

ID da operação:: addTopicQuizQuestion

Cria uma nova pergunta de teste dentro do tópico especificado.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do tópico	topicId	True	uuid	ID do tópico
tipo	type	True	string
enviar SMS	text	True	string
ordinalNumber	ordinalNumber		integer
enviar SMS	text	True	string
isCorrect	isCorrect		boolean
expectedAnswer	expectedAnswer		string

Retornos

Corpo: QuestionDto

Adicionar uma pergunta na lição

ID da operação:: addLessonQuestion

o tipo deve ser MULTIPLE_CHOICE (requer opções) ou OPEN_ENDED

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da lição	lessonId	True	uuid	ID da lição
tipo	type	True	string
enviar SMS	text	True	string
ordinalNumber	ordinalNumber		integer
enviar SMS	text	True	string
isCorrect	isCorrect		boolean
expectedAnswer	expectedAnswer		string

Retornos

Corpo: QuestionDto

Alternar a disponibilidade para os alunos

ID da operação:: updateDemoTrainingAvailability

Defina se o treinamento de demonstração é publicado para os alunos. Idempotentes.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Id	id	True	uuid	Id
available	available	True	boolean

Retornos

Corpo: DemoTrainingDto

Atribuir documentos a um especialista

ID da operação:: assignDocumentsToExpert

Vincule documentos em massa ao especialista. Idempotentes.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Id	id	True	uuid	Id
documentIds	documentIds	True	array of uuid

Retornos

Corpo: ExpertDetailDto

Atribuir funções a um curso

ID da operação:: assignRolesToCourse

Aditivo – as funções já atribuídas são ignoradas. Retorna os detalhes do curso atualizado

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Id	id	True	uuid	Id
roleIds	roleIds	True	array of uuid

Retornos

Corpo: CourseDetailDto

Atribuir funções a um especialista

ID da operação:: assignRolesToExpert

Aditivo – funções já atribuídas são mantidas; novos acrescentados. Retorna especialista atualizado

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Id	id	True	uuid	Id
roleIds	roleIds	True	array of uuid

Retornos

Corpo: ExpertDetailDto

Atribuir um usuário a uma função

ID da operação:: assignUserToRole

Idempotente

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Id	id	True	uuid	Id
ID da função	roleId	True	uuid	ID da função
userId	userId	True	uuid

Retornos

Corpo: DepartmentDto

Atualizar metadados de bytes de aprendizado

ID da operação:: updateLearningByte

Campos omitidos preservam valores atuais

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Lb Id	lbId	True	uuid	Lb Id
nome	name		string
description	description		string

Retornos

Corpo: LearningByteDetailDto

Atualizar metadados de mídia

ID da operação:: updateMediaMetadata

Atualizar nome e/ou descrição

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Id	id	True	uuid	Id
nome	name		string
description	description		string

Retornos

Corpo: MediaDetailDto

Atualizar metadados do curso

ID da operação:: updateCourse

Atualizar o nome do curso

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Id	id	True	uuid	Id
nome	name		string

Retornos

Corpo: CourseDetailDto

Atualizar metadados do documento

ID da operação:: updateDocumentMetadata

Atualizar nome e/ou descrição

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Id	id	True	uuid	Id
nome	name		string
description	description		string

Retornos

Corpo: DocumentDetailDto

Atualizar metadados do módulo

ID da operação:: updateModule

Atualiza o nome e/ou a descrição. Campos omitidos preservam valores atuais

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do módulo	moduleId	True	uuid	ID do módulo
nome	name		string
description	description		string

Retornos

Corpo: ModuleDetailDto

Atualizar metadados do tópico

ID da operação:: updateTopic

Atualiza o nome e/ou a descrição. Campos omitidos preservam valores atuais

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do tópico	topicId	True	uuid	ID do tópico
nome	name		string
description	description		string

Retornos

Corpo: TopicDto

Atualizar o conteúdo da lição

ID da operação:: updateLesson

O conteúdo omitido preserva o valor atual

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da lição	lessonId	True	uuid	ID da lição
conteúdo	content		string

Retornos

Corpo: LessonDetailDto

Atualizar um departamento

ID da operação:: updateDepartment

Atualizar nome e/ou descrição

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Id	id	True	uuid	Id
nome	name		string
description	description		string

Retornos

Corpo: DepartmentDto

Atualizar um exercício

ID da operação:: updateExercise

Reconhecimento de tipo: ILE_TEXT usa apenas prompt + generatedContent.scenario; RPE_* usa todos os campos RPE. Os campos omitidos preservam os valores atuais.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Id	id	True	uuid	Id
solicitação	prompt		string
avatarPictureId	avatarPictureId		uuid
avatarCharacteristics	avatarCharacteristics		string
reverseRolePlayEnabled	reverseRolePlayEnabled		boolean
reverseRolePlayMandatory	reverseRolePlayMandatory		boolean
cenário	scenario		string
traineeRole	traineeRole		string
avatarName	avatarName		string
avatarDescription	avatarDescription		string
operationalChallenge	operationalChallenge		string
successMetric	successMetric		string

Retornos

Corpo: ExerciseDto

Atualizar um treinamento de demonstração

ID da operação:: updateDemoTraining

Atualização parcial. Passe apenas os campos que você deseja alterar. assignedRoleIds substitui o conjunto atual.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Id	id	True	uuid	Id
nome	name		string
description	description		string
trainingType	trainingType		string
departmentId	departmentId		uuid
assignedRoleIds	assignedRoleIds		array of uuid

Retornos

Corpo: DemoTrainingDto

Atualizar um usuário

ID da operação:: updateUser

Atualize firstName, lastName, isAdmin e atribuições de função. O email não é editável na v1.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Id	id	True	uuid	Id
firstName	firstName		string
lastName	lastName		string
isAdmin	isAdmin		boolean
departmentRoleIds	departmentRoleIds		array of uuid

Retornos

Corpo: UserDto

Atualizar uma pergunta de teste em um módulo

ID da operação:: updateModuleQuizQuestion

Forneça campos correspondentes ao tipo armazenado; campos não relacionados são ignorados.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do módulo	moduleId	True	uuid	ID do módulo
ID da pergunta	questionId	True	uuid	ID da pergunta
enviar SMS	text		string
enviar SMS	text	True	string
isCorrect	isCorrect		boolean
expectedAnswer	expectedAnswer		string

Retornos

Corpo: QuestionDto

Atualizar uma pergunta de teste em um tópico

ID da operação:: updateTopicQuizQuestion

Forneça campos correspondentes ao tipo armazenado; campos não relacionados são ignorados.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do tópico	topicId	True	uuid	ID do tópico
ID da pergunta	questionId	True	uuid	ID da pergunta
enviar SMS	text		string
enviar SMS	text	True	string
isCorrect	isCorrect		boolean
expectedAnswer	expectedAnswer		string

Retornos

Corpo: QuestionDto

Atualizar uma pergunta na lição

ID da operação:: updateLessonQuestion

Forneça campos correspondentes ao tipo armazenado; campos não relacionados são ignorados

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da lição	lessonId	True	uuid	ID da lição
ID da pergunta	questionId	True	uuid	ID da pergunta
enviar SMS	text		string
enviar SMS	text	True	string
isCorrect	isCorrect		boolean
expectedAnswer	expectedAnswer		string

Retornos

Corpo: QuestionDto

Baixar pdf de certificado

ID da operação:: downloadCertificatePdf

Transmite o PDF do certificado. Retorna 404 se o certificado ainda não tiver PDF

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Id	id	True	uuid	Id

Retornos

response: StreamingResponseBody

Cancelar a atribuição de um documento de um especialista

ID da operação:: unassignDocumentFromExpert

Idempotente

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Id	id	True	uuid	Id
ID do Documento	documentId	True	uuid	ID do Documento

Cancelar a atribuição de um usuário de uma função

ID da operação:: unassignUserFromRole

Idempotente — 204 mesmo que não tenha sido atribuído

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Id	id	True	uuid	Id
ID da função	roleId	True	uuid	ID da função
Id do usuário	userId	True	uuid	Id do usuário

Carregar um documento

ID da operação:: uploadDocument

Upload de várias partes (arquivo + descrição opcional). Máximo de 50 MB.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
File	file	True	file	File
Description	description		string	Description

Retornos

Corpo: DocumentDetailDto

Carregar um item de mídia

ID da operação:: uploadMedia

Upload de várias partes (arquivo + descrição opcional). Máximo de 50 MB para imagens, 500 MB para vídeos.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
File	file	True	file	File
Description	description		string	Description

Retornos

Corpo: MediaDetailDto

Criar um curso vazio

ID da operação:: createCourse

Cria um novo shell de curso com o nome fornecido

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
nome	name	True	string

Retornos

Corpo: CourseDetailDto

Criar um departamento

ID da operação:: createDepartment

Cria um novo departamento na empresa do chamador.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
nome	name	True	string
description	description		string

Retornos

Corpo: DepartmentDto

Criar um treinamento de demonstração

ID da operação:: createDemoTraining

Cria um treinamento de demonstração de um arquivo de vídeo carregado anteriormente e inicia o processamento

Parâmetros

Nome	Chave	Obrigatório	Tipo
nome	name	True	string
description	description		string
trainingType	trainingType	True	string
videoFileId	videoFileId	True	uuid
departmentId	departmentId		uuid
processingPrompt	processingPrompt		string

Retornos

Corpo: DemoTrainingDto

Criar um usuário

ID da operação:: createUser

Cria um usuário e dispara o fluxo de convite de link mágico

Parâmetros

Nome	Chave	Obrigatório	Tipo
email	email	True	email
firstName	firstName		string
lastName	lastName		string
isAdmin	isAdmin		boolean
departmentRoleIds	departmentRoleIds		array of uuid

Retornos

Corpo: UserDto

Criar uma função em um departamento

ID da operação:: createRoleInDepartment

Cria uma nova função com escopo para o departamento fornecido.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Id	id	True	uuid	Id
nome	name	True	string
fullName	fullName		string
description	description		string

Retornos

Corpo: DepartmentDto

Definir a contagem de testes de módulo para um tipo de pergunta

ID da operação:: setModuleQuizSettings

Substitui a contagem do questionType especificado (MULTIPLE_CHOICE ou OPEN_ENDED). A contagem de outros tipos é preservada

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do módulo	moduleId	True	uuid	ID do módulo
questionType	questionType	True	string
contagem	count		integer

Retornos

Corpo: ModuleDetailDto

Definir a contagem de testes de tópico para um tipo de pergunta

ID da operação:: setTopicQuizSettings

Substitui a contagem do questionType especificado (MULTIPLE_CHOICE ou OPEN_ENDED). A contagem de outros tipos é preservada

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do tópico	topicId	True	uuid	ID do tópico
questionType	questionType	True	string
contagem	count		integer

Retornos

Corpo: TopicDto

Definir ou substituir uma introdução de módulo

ID da operação:: setModuleIntro

Upsert – cria se ausente, substitui se presente

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do módulo	moduleId	True	uuid	ID do módulo
introdução	introduction		string

Retornos

Corpo: IntroDto

Definir ou substituir uma introdução de tópico

ID da operação:: setTopicIntro

Upsert – cria se ausente, substitui se presente

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do tópico	topicId	True	uuid	ID do tópico
introdução	introduction		string

Retornos

Corpo: IntroDto

Desativar um usuário

ID da operação:: deactivateUser

Idempotente – retorna o usuário mesmo que já tenha sido desativado

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Id	id	True	uuid	Id

Retornos

Corpo: UserDto

Desvincular um documento de um tópico

ID da operação:: unlinkDocumentFromTopic

Idempotente

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do tópico	topicId	True	uuid	ID do tópico
ID do Documento	documentId	True	uuid	ID do Documento

Detalhes do certificado

ID da operação:: getCertificate

Retorna um certificado com escopo para a empresa do chamador

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Id	id	True	uuid	Id

Retornos

Corpo: CertificateDto

Disparar geração de conteúdo de IA para tópicos

ID da operação:: generateCourseContent

Enfileira a geração de conteúdo de IA para os tópicos especificados no curso

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Id	id	True	uuid	Id
topicIds	topicIds	True	array of uuid

Retornos

Corpo: GenerationRequestResponse

Eventos de atividade por aluno

ID da operação:: listStudentEvents

Fluxo de eventos somente para encaminhamento paginado

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Id do usuário	userId	True	uuid	Id do usuário
Page	page		integer	Page
Tamanho	size		integer	Tamanho

Retornos

Corpo: EventListResponse

Excluir (desativar) um departamento

ID da operação:: deleteDepartment

Idempotente — retorna 204 mesmo que já tenha sido desativado. Cascatas para atribuições de função.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Id	id	True	uuid	Id

Excluir (desativar) um documento

ID da operação:: deleteDocument

Idempotente — retorna 204 mesmo se o documento já estiver excluído ou ausente

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Id	id	True	uuid	Id

Excluir (desativar) um item de mídia

ID da operação:: deleteMedia

Idempotente — retorna 204 mesmo se o item já estiver excluído ou ausente

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Id	id	True	uuid	Id

Excluir (suave) um curso

ID da operação:: deleteCourse

Idempotente — retorna 204 mesmo que o curso já tenha sido removido

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Id	id	True	uuid	Id

Excluir um byte de aprendizado (suave)

ID da operação:: deleteLearningByte

Idempotente — 204 mesmo que já tenha sido removido

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Lb Id	lbId	True	uuid	Lb Id

Excluir um exercício

ID da operação:: deleteExercise

Idempotente — 204 mesmo que já tenha sido removido

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Id	id	True	uuid	Id

Excluir um módulo (suave)

ID da operação:: deleteModule

Idempotente – retorna 204 mesmo que o módulo já tenha sido removido

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do módulo	moduleId	True	uuid	ID do módulo

Excluir um treinamento de demonstração

ID da operação:: deleteDemoTraining

Idempotente – retorna 204 mesmo que o treinamento de demonstração não exista ou já tenha sumido

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Id	id	True	uuid	Id

Excluir um tópico (suave)

ID da operação:: deleteTopic

Idempotente — retorna 204 mesmo que o tópico já tenha sido removido

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do tópico	topicId	True	uuid	ID do tópico

Excluir uma lição (suave)

ID da operação:: deleteLesson

Idempotente — 204 mesmo que já tenha sido removido

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da lição	lessonId	True	uuid	ID da lição

Excluir uma pergunta de teste em um módulo

ID da operação:: deleteModuleQuizQuestion

Idempotente — 204 mesmo que já tenha sido removido

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do módulo	moduleId	True	uuid	ID do módulo
ID da pergunta	questionId	True	uuid	ID da pergunta

Excluir uma pergunta de teste em um tópico

ID da operação:: deleteTopicQuizQuestion

Idempotente — 204 mesmo que já tenha sido removido

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do tópico	topicId	True	uuid	ID do tópico
ID da pergunta	questionId	True	uuid	ID da pergunta

Excluir uma pergunta na lição

ID da operação:: deleteLessonQuestion

Idempotente — 204 mesmo que já tenha sido removido

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da lição	lessonId	True	uuid	ID da lição
ID da pergunta	questionId	True	uuid	ID da pergunta

Executar novamente o processamento de vídeo

ID da operação:: reprocessDemoTraining

Envia novamente o vídeo para segmentação de IA. Opcionalmente, substitua o prompt de processamento.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Id	id	True	uuid	Id
processingPrompt	processingPrompt		string

Retornos

Corpo: DemoTrainingDto

Faça uma pergunta a um especialista

ID da operação:: askExpert

Wrapper síncrono em torno do chat de IA de streaming. Retorna a resposta montada.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Id	id	True	uuid	Id
pergunta	question	True	string

Retornos

Corpo: AskResponse

Gerar um curso completo com conteúdo de IA

ID da operação:: generateCourse

Cria o shell de curso, todos os módulos, todos os tópicos e enfileira a geração de conteúdo de IA para cada tópico

Parâmetros

Nome	Chave	Obrigatório	Tipo
nome	name	True	string
description	description		string
nome	name	True	string
description	description		string
nome	name	True	string
description	description		string

Retornos

Corpo: GenerateCourseResponse

Insights no nível da empresa

ID da operação:: getCompanyInsights

KPIs de linha superior para a empresa do chamador

Retornos

Corpo: CompanyInsightsDto

Insights por aluno

ID da operação:: getStudentInsights

Resumo agregado e detalhamento por curso para a janela fornecida

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Id do usuário	userId	True	uuid	Id do usuário
Janela	window		string	Janela

Retornos

Corpo: StudentInsightsDto

Listar bytes de aprendizagem em um tópico

ID da operação:: listLearningBytesInTopic

Retorna bytes de aprendizagem que pertencem ao tópico especificado.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do tópico	topicId	True	uuid	ID do tópico

Retornos

Corpo: LearningByteListResponse

Listar certificados de um aluno

ID da operação:: listStudentCertificates

Retorna certificados obtidos pelo aluno especificado dentro da empresa do chamador

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Id do usuário	userId	True	uuid	Id do usuário

Retornos

Corpo: CertificateListResponse

Listar cursos

ID da operação:: listCourses

Lista paginada de cursos na empresa do chamador

Parâmetros

Nome	Chave	Tipo	Description
Page	page	integer	Page
Tamanho	size	integer	Tamanho
Pesquisa	search	string	Pesquisa
Status	status	string	Status
IDs de função de departamento	departmentRoleIds	string	IDs de função de departamento

Retornos

Corpo: CourseListResponse

Listar departamentos

ID da operação:: listDepartments

Todos os departamentos na empresa do chamador com funções aninhadas

Retornos

Corpo: DepartmentListResponse

Listar documentos

ID da operação:: listDocuments

Lista paginada de documentos na empresa do chamador

Parâmetros

Nome	Chave	Tipo	Description
Page	page	integer	Page
Tamanho	size	integer	Tamanho
Pesquisa	search	string	Pesquisa
Tipos mime	mimeTypes	string	Tipos mime
Status	status	string	Status

Retornos

Corpo: DocumentListResponse

Listar documentos vinculados a um tópico

ID da operação:: listTopicLinkedDocuments

Paginado; pesquisa opcional por nome do documento

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do tópico	topicId	True	uuid	ID do tópico
Page	page		integer	Page
Tamanho	size		integer	Tamanho
Pesquisa	search		string	Pesquisa

Retornos

Corpo: TopicLinkedDocumentListResponse

Listar especialistas

ID da operação:: listExperts

Lista paginada de especialistas na empresa do chamador

Parâmetros

Nome	Chave	Tipo	Description
Page	page	integer	Page
Tamanho	size	integer	Tamanho
Pesquisa	search	string	Pesquisa

Retornos

Corpo: ExpertListResponse

Listar exercícios em um tópico

ID da operação:: listExercisesInTopic

Tipos mistos (ILE_TEXT/RPE_VOICE/RPE_VIDEO) ordenados por ordinalNumber

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do tópico	topicId	True	uuid	ID do tópico

Retornos

Corpo: ExerciseListResponse

Listar lições em um byte de aprendizagem

ID da operação:: listLessonsInLearningByte

Retorna lições que pertencem ao byte de aprendizagem especificado.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Lb Id	lbId	True	uuid	Lb Id

Retornos

Corpo: LessonListResponse

Listar módulos em um curso

ID da operação:: listModulesInCourse

Retorna módulos ativos ordenados por ordinalNumber

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do curso	courseId	True	uuid	ID do curso

Retornos

Corpo: ModuleListResponse

Listar perguntas de teste em um módulo

ID da operação:: listModuleQuizQuestions

Retorna perguntas de teste anexadas ao módulo especificado.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do módulo	moduleId	True	uuid	ID do módulo

Retornos

Corpo: QuestionListResponse

Listar perguntas de teste em um tópico

ID da operação:: listTopicQuizQuestions

Retorna perguntas de teste anexadas ao tópico especificado.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do tópico	topicId	True	uuid	ID do tópico

Retornos

Corpo: QuestionListResponse

Listar perguntas na lição

ID da operação:: listLessonQuestions

Retorna perguntas de verificação de conhecimento anexadas à lição fornecida.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da lição	lessonId	True	uuid	ID da lição

Retornos

Corpo: QuestionListResponse

Listar treinamentos de demonstração

ID da operação:: listDemoTrainings

Lista paginada com escopo para a empresa do chamador

Parâmetros

Nome	Chave	Tipo	Description
Page	page	integer	Page
Tamanho	size	integer	Tamanho
Pesquisa	search	string	Pesquisa
Tipos de treinamento	trainingTypes	string	Tipos de treinamento
Estados	statuses	string	Estados
IDs do departamento	departmentIds	string	IDs do departamento
Está disponível	isAvailable	boolean	Está disponível

Retornos

Corpo: DemoTrainingListResponse

Listar tópicos em um módulo

ID da operação:: listTopicsInModule

Retorna tópicos ativos ordenados por ordinalNumber

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do módulo	moduleId	True	uuid	ID do módulo

Retornos

Corpo: TopicListResponse

Listar usuários

ID da operação:: listUsers

Lista paginada de usuários na empresa do chamador

Parâmetros

Nome	Chave	Tipo	Description
Page	page	integer	Page
Tamanho	size	integer	Tamanho
Pesquisa	search	string	Pesquisa
Status	status	string	Status
IDs do departamento	departmentIds	string	IDs do departamento
IDs de função	roleIds	string	IDs de função
Variante	kind	string	Variante

Retornos

Corpo: UserListResponse

Listar versões do curso

ID da operação:: listCourseVersions

Retorna metadados de versão publicados (contagens + informações de publicação) ordenados pelo número de versão

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do curso	courseId	True	uuid	ID do curso

Retornos

Corpo: CourseVersionListResponse

Mover um tópico para outro módulo

ID da operação:: moveTopic

targetOrdinalNumber é opcional; se omitido, o tópico será acrescentado ao módulo de destino

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do tópico	topicId	True	uuid	ID do tópico
targetModuleId	targetModuleId	True	uuid
targetOrdinalNumber	targetOrdinalNumber		integer

Retornos

Corpo: TopicDto

Mídia de lista

ID da operação:: listMedia

Lista paginada de itens de mídia na empresa do chamador

Parâmetros

Nome	Chave	Tipo	Description
Page	page	integer	Page
Tamanho	size	integer	Tamanho
Pesquisa	search	string	Pesquisa
Variante	kind	string	Variante
Status	status	string	Status

Retornos

Corpo: MediaListResponse

Obter o status de geração de IA para um curso

ID da operação:: getCourseGenerationStatus

Retorna a lista de solicitações de geração de IA ativas para o curso com informações de progresso e destino

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Id	id	True	uuid	Id

Retornos

Corpo: GenerationStatusResponse

Obter um byte de aprendizado

ID da operação:: getLearningByte

Retorna metadados e lições aninhadas

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Lb Id	lbId	True	uuid	Lb Id

Retornos

Corpo: LearningByteDetailDto

Obter um curso

ID da operação:: getCourse

Retorna metadados de curso com resumos de módulo e funções/departamentos atribuídos

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Id	id	True	uuid	Id

Retornos

Corpo: CourseDetailDto

Obter um documento

ID da operação:: getDocument

Retorna metadados de documento e uma URL de download assinada de curta duração

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Id	id	True	uuid	Id

Retornos

Corpo: DocumentDetailDto

Obter um especialista

ID da operação:: getExpert

Retorna metadados de especialistas, documentos vinculados e funções/departamentos atribuídos

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Id	id	True	uuid	Id

Retornos

Corpo: ExpertDetailDto

Obter um exercício

ID da operação:: getExercise

Retorna detalhes do exercício para a ID fornecida.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Id	id	True	uuid	Id

Retornos

Corpo: ExerciseDto

Obter um instantâneo de versão do curso

ID da operação:: getCourseVersion

Retorna a árvore de conteúdo completa (módulos, tópicos, lições, exercícios, perguntas) para a versão fornecida

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do curso	courseId	True	uuid	ID do curso
Número de Versão	versionNumber	True	integer	Número de Versão

Retornos

Corpo: CourseVersionSnapshotDto

Obter um item de mídia

ID da operação:: getMediaItem

Retorna metadados de mídia e uma URL de download assinada de curta duração

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Id	id	True	uuid	Id

Retornos

Corpo: MediaDetailDto

Obter um módulo

ID da operação:: getModule

Retorna detalhes do módulo para a ID fornecida.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do módulo	moduleId	True	uuid	ID do módulo

Retornos

Corpo: ModuleDetailDto

Obter um treinamento de demonstração

ID da operação:: getDemoTraining

Retorna o treinamento completo de demonstração com segmentos

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Id	id	True	uuid	Id

Retornos

Corpo: DemoTrainingDto

Obter um tópico

ID da operação:: getTopic

Retorna detalhes do tópico para a ID fornecida.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do tópico	topicId	True	uuid	ID do tópico

Retornos

Corpo: TopicDto

Obter um usuário

ID da operação:: getUser

Retorna metadados de usuário e atribuições de departamento/função

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Id	id	True	uuid	Id

Retornos

Corpo: UserDto

Obter uma introdução de módulo

ID da operação:: getModuleIntro

Retorna o conjunto de texto de introdução no módulo especificado.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do módulo	moduleId	True	uuid	ID do módulo

Retornos

Corpo: IntroDto

Obter uma introdução de tópico

ID da operação:: getTopicIntro

Retorna o conjunto de texto de introdução no tópico especificado.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do tópico	topicId	True	uuid	ID do tópico

Retornos

Corpo: IntroDto

Obter uma lição

ID da operação:: getLesson

Retorna conteúdo da lição, mídia e perguntas na lição

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da lição	lessonId	True	uuid	ID da lição

Retornos

Corpo: LessonDetailDto

Obter uma pergunta de teste em um módulo

ID da operação:: getModuleQuizQuestion

Retorna uma única pergunta de teste anexada ao módulo especificado.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do módulo	moduleId	True	uuid	ID do módulo
ID da pergunta	questionId	True	uuid	ID da pergunta

Retornos

Corpo: QuestionDto

Obter uma pergunta de teste em um tópico

ID da operação:: getTopicQuizQuestion

Retorna uma única pergunta de teste anexada ao tópico especificado.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do tópico	topicId	True	uuid	ID do tópico
ID da pergunta	questionId	True	uuid	ID da pergunta

Retornos

Corpo: QuestionDto

Obter uma pergunta na lição

ID da operação:: getLessonQuestion

Retorna uma única pergunta em lição por sua ID.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da lição	lessonId	True	uuid	ID da lição
ID da pergunta	questionId	True	uuid	ID da pergunta

Retornos

Corpo: QuestionDto

Publicar um curso

ID da operação:: publishCourse

Publica o curso; falha com 400 se ele não tiver conteúdo publicável

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Id	id	True	uuid	Id

Retornos

Corpo: CourseDetailDto

Reativar um usuário

ID da operação:: reactivateUser

Idempotente – retorna o usuário mesmo que já esteja ativo

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Id	id	True	uuid	Id

Retornos

Corpo: UserDto

Regenerar um item específico por meio da IA

ID da operação:: regenerateCourseItem

Regenera uma única lição, perguntas de lição, teste, introdução ou exercício

Parâmetros

Nome	Chave	Obrigatório	Tipo
destino	target	True	string
targetId	targetId	True	uuid
tipo de pai	parentType		string

Retornos

Corpo: GenerationRequestResponse

Remover todas as atribuições de função de um curso

ID da operação:: removeAllRolesFromCourse

Idempotente

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Id	id	True	uuid	Id

Remover todas as atribuições de função de um especialista

ID da operação:: removeAllRolesFromExpert

Idempotente

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Id	id	True	uuid	Id

Remover uma atribuição de função de um curso

ID da operação:: removeRoleFromCourse

Idempotente

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Id	id	True	uuid	Id
ID da função	roleId	True	uuid	ID da função

Remover uma atribuição de função de um especialista

ID da operação:: removeRoleFromExpert

Idempotente

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Id	id	True	uuid	Id
ID da função	roleId	True	uuid	ID da função

Remover uma introdução de módulo

ID da operação:: removeModuleIntro

Idempotente — 204 mesmo que nenhuma introdução esteja definida

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do módulo	moduleId	True	uuid	ID do módulo

Remover uma introdução de tópico

ID da operação:: removeTopicIntro

Idempotente — 204 mesmo que nenhuma introdução esteja definida

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do tópico	topicId	True	uuid	ID do tópico

Reordenar módulos em um curso

ID da operação:: reorderModulesInCourse

moduleIds devem incluir todos os módulos ativos exatamente uma vez, na nova ordem

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do curso	courseId	True	uuid	ID do curso
moduleIds	moduleIds	True	array of uuid

Retornos

Corpo: ModuleListResponse

Reordenar perguntas de teste em um módulo

ID da operação:: reorderModuleQuizQuestions

questionIds devem incluir todas as perguntas de teste ativas para o módulo, na nova ordem.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do módulo	moduleId	True	uuid	ID do módulo
questionIds	questionIds	True	array of uuid

Retornos

Corpo: QuestionListResponse

Reordenar perguntas de teste sobre um tópico

ID da operação:: reorderTopicQuizQuestions

questionIds devem incluir todas as perguntas de teste ativas para o tópico, na nova ordem.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do tópico	topicId	True	uuid	ID do tópico
questionIds	questionIds	True	array of uuid

Retornos

Corpo: QuestionListResponse

Reordenar perguntas na lição

ID da operação:: reorderLessonQuestions

questionIds devem incluir todas as perguntas ativas para a lição, na nova ordem

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da lição	lessonId	True	uuid	ID da lição
questionIds	questionIds	True	array of uuid

Retornos

Corpo: QuestionListResponse

Reordenar tópicos dentro de um módulo

ID da operação:: reorderTopicsInModule

topicIds devem incluir todos os tópicos ativos exatamente uma vez, na nova ordem

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do módulo	moduleId	True	uuid	ID do módulo
topicIds	topicIds	True	array of uuid

Retornos

Corpo: TopicListResponse

Substituir binário de documento

ID da operação:: replaceDocumentFile

Substitui o binário de arquivo de um documento existente; metadados são preservados

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Id	id	True	uuid	Id
File	file	True	file	File

Retornos

Corpo: DocumentDetailDto

Substituir binário de mídia

ID da operação:: replaceMediaFile

Substitui o binário de arquivo de um item de mídia existente em vigor; metadados são preservados

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Id	id	True	uuid	Id
File	file	True	file	File

Retornos

Corpo: MediaDetailDto

Vincular documentos a um tópico

ID da operação:: linkDocumentsToTopic

Aditivo — documentos já vinculados são ignorados

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do tópico	topicId	True	uuid	ID do tópico
documentIds	documentIds	True	array of uuid

Definições

QuizSettingDto

Nome	Caminho	Tipo	Description
questionType	questionType	string
contagem	count	integer

TopicDto

Nome	Caminho	Tipo
id	id	uuid
moduleId	moduleId	uuid
nome	name	string
description	description	string
ordinalNumber	ordinalNumber	integer
hasContent	hasContent	boolean
quizSettings	quizSettings	array of QuizSettingDto

IntroDto

Nome	Caminho	Tipo
id	id	uuid
ID do componente	componentId	uuid
componentType	componentType	string
introdução	introduction	string
fonte	source	string
createdAt	createdAt	date-time
updatedAt	updatedAt	date-time

ModuleDetailDto

Nome	Caminho	Tipo
id	id	uuid
courseId	courseId	uuid
nome	name	string
description	description	string
productId	productId	uuid
ordinalNumber	ordinalNumber	integer
lockedForGeneration	lockedForGeneration	boolean
quizSettings	quizSettings	array of QuizSettingDto
topics	topics	array of TopicDto

MediaDetailDto

Nome	Caminho	Tipo
id	id	uuid
nome	name	string
description	description	string
kind	kind	string
Tipo MIME	mimeType	string
sizeBytes	sizeBytes	integer
status	status	string
processingStatus	processingStatus	string
createdAt	createdAt	date-time
uploadedBy	uploadedBy	UploadedByDto
url de download	downloadUrl	string

UploadedByDto

Nome	Caminho	Tipo
id	id	uuid
kind	kind	string
nome	name	string

DocumentDetailDto

Nome	Caminho	Tipo
id	id	uuid
nome	name	string
description	description	string
Tipo MIME	mimeType	string
sizeBytes	sizeBytes	integer
status	status	string
createdAt	createdAt	date-time
uploadedBy	uploadedBy	UploadedByDto
url de download	downloadUrl	string

DepartmentRoleDto

Nome	Caminho	Tipo
departmentId	departmentId	uuid
nomeDoDepartamento	departmentName	string
roleId	roleId	uuid
nome_do_papel	roleName	string

UserDto

Nome	Caminho	Tipo
id	id	uuid
email	email	string
firstName	firstName	string
lastName	lastName	string
status	status	string
kind	kind	string
isAdmin	isAdmin	boolean
createdAt	createdAt	date-time
departmentRoles	departmentRoles	array of DepartmentRoleDto

QuestionDto

Nome	Caminho	Tipo
id	id	uuid
tipo	type	string
ID do pai	parentId	uuid
tipo de pai	parentType	string
enviar SMS	text	string
ordinalNumber	ordinalNumber	integer
fonte	source	string
expectedAnswer	expectedAnswer	string
Opções	options	array of QuestionOptionDto
createdAt	createdAt	date-time
updatedAt	updatedAt	date-time

QuestionOptionDto

Nome	Caminho	Tipo
enviar SMS	text	string
isCorrect	isCorrect	boolean
ordinalNumber	ordinalNumber	integer

QuestionListResponse

Nome	Caminho	Tipo	Description
itens	items	array of QuestionDto

LearningByteDetailDto

Nome	Caminho	Tipo
id	id	uuid
topicId	topicId	uuid
nome	name	string
description	description	string
ordinalNumber	ordinalNumber	integer
fonte	source	string
createdAt	createdAt	date-time
updatedAt	updatedAt	date-time
lições	lessons	array of LessonDto

LessonDto

Nome	Caminho	Tipo
id	id	uuid
learningByteId	learningByteId	uuid
conteúdo	content	string
ordinalNumber	ordinalNumber	integer
fonte	source	string
questionCount	questionCount	integer
mediaCount	mediaCount	integer
createdAt	createdAt	date-time
updatedAt	updatedAt	date-time

ExerciseDto

Nome	Caminho	Tipo
id	id	uuid
topicId	topicId	uuid
tipo	type	string
solicitação	prompt	string
ordinalNumber	ordinalNumber	integer
fonte	source	string
isGenerated	isGenerated	boolean
avatarPictureId	avatarPictureId	uuid
avatarCharacteristics	avatarCharacteristics	string
reverseRolePlayEnabled	reverseRolePlayEnabled	boolean
reverseRolePlayMandatory	reverseRolePlayMandatory	boolean
generatedContent	generatedContent	ExerciseGeneratedContentDto
createdAt	createdAt	date-time
updatedAt	updatedAt	date-time

ExerciseGeneratedContentDto

Nome	Caminho	Tipo
id	id	uuid
regenerationId	regenerationId	uuid
cenário	scenario	string
traineeRole	traineeRole	string
avatarName	avatarName	string
avatarDescription	avatarDescription	string
operationalChallenge	operationalChallenge	string
successMetric	successMetric	string
instrução	instruction	string
instructionReverse	instructionReverse	string
exerciseKnowledgeBase	exerciseKnowledgeBase	string
topicKnowledgeBase	topicKnowledgeBase	string

TopicListResponse

Nome	Caminho	Tipo	Description
itens	items	array of TopicDto

LessonDetailDto

Nome	Caminho	Tipo
id	id	uuid
learningByteId	learningByteId	uuid
conteúdo	content	string
ordinalNumber	ordinalNumber	integer
fonte	source	string
createdAt	createdAt	date-time
updatedAt	updatedAt	date-time
mídia	media	array of MediaLinkDto
perguntas	questions	array of QuestionDto

MediaLinkDto

Nome	Caminho	Tipo
id	id	uuid
fileId	fileId	uuid
ordinalNumber	ordinalNumber	integer
fonte	source	string

ExpertDetailDto

Nome	Caminho	Tipo
id	id	uuid
nome	name	string
description	description	string
status	status	string
linkedDocumentCount	linkedDocumentCount	integer
createdAt	createdAt	date-time
updatedAt	updatedAt	date-time
assignedRoleIds	assignedRoleIds	array of uuid
assignedDepartmentIds	assignedDepartmentIds	array of uuid
linkedDocuments	linkedDocuments	array of LinkedDocumentDto

LinkedDocumentDto

Nome	Caminho	Tipo
id	id	uuid
nome	name	string
extensão	extension	string
sizeBytes	sizeBytes	integer
description	description	string
linkedAt	linkedAt	date-time

AskResponse

Nome	Caminho	Tipo	Description
resposta	answer	string
durationMs	durationMs	integer

DepartmentDto

Nome	Caminho	Tipo
id	id	uuid
nome	name	string
description	description	string
status	status	string
createdAt	createdAt	date-time
funções	roles	array of DepartmentRoleDto

DemoTrainingDto

Nome	Caminho	Tipo
id	id	uuid
companyId	companyId	uuid
departmentId	departmentId	uuid
nome	name	string
description	description	string
trainingType	trainingType	string
status	status	string
está disponível	isAvailable	boolean
videoFileId	videoFileId	uuid
processingPrompt	processingPrompt	string
errorMessage	errorMessage	string
assignedRoleIds	assignedRoleIds	array of uuid
Segmentos	segments	array of DemoTrainingSegmentDto
createdAt	createdAt	date-time
updatedAt	updatedAt	date-time

DemoTrainingSegmentDto

Nome	Caminho	Tipo
id	id	uuid
ordinalNumber	ordinalNumber	integer
nome	name	string
transcrição	transcript	string
durationSeconds	durationSeconds	integer

CourseDetailDto

Nome	Caminho	Tipo
id	id	uuid
nome	name	string
status	status	string
moduleCount	moduleCount	integer
topicCount	topicCount	integer
hasUnpublishedChanges	hasUnpublishedChanges	boolean
currentVersionNumber	currentVersionNumber	integer
createdAt	createdAt	date-time
updatedAt	updatedAt	date-time
assignedRoleIds	assignedRoleIds	array of uuid
assignedDepartmentIds	assignedDepartmentIds	array of uuid
modules	modules	array of ModuleSummaryDto

ModuleSummaryDto

Nome	Caminho	Tipo
id	id	uuid
nome	name	string
ordinalNumber	ordinalNumber	integer
topicCount	topicCount	integer

GenerationRequestResponse

Nome	Caminho	Tipo	Description
id	id	uuid
status	status	string

ModuleDto

Nome	Caminho	Tipo
id	id	uuid
courseId	courseId	uuid
nome	name	string
description	description	string
productId	productId	uuid
ordinalNumber	ordinalNumber	integer
lockedForGeneration	lockedForGeneration	boolean
topicCount	topicCount	integer
quizSettings	quizSettings	array of QuizSettingDto

ModuleListResponse

Nome	Caminho	Tipo	Description
itens	items	array of ModuleDto

GenerateCourseResponse

Nome	Caminho	Tipo	Description
courseId	courseId	uuid
generationRequestId	generationRequestId	uuid

PageInfo

Nome	Caminho	Tipo
size	size	integer
número	number	integer
totalElements	totalElements	integer
total de páginas	totalPages	integer

UserListResponse

Nome	Caminho	Tipo	Description
itens	items	array of UserDto
página	page	PageInfo

TopicLinkedDocumentDto

Nome	Caminho	Tipo
id	id	uuid
nome	name	string
extensão	extension	string
size	size	integer
processingStatus	processingStatus	string
description	description	string
fonte	source	string
linkType	linkType	string
linkedAt	linkedAt	date-time

TopicLinkedDocumentListResponse

Nome	Caminho	Tipo	Description
itens	items	array of TopicLinkedDocumentDto
página	page	PageInfo

LearningByteDto

Nome	Caminho	Tipo
id	id	uuid
topicId	topicId	uuid
nome	name	string
description	description	string
ordinalNumber	ordinalNumber	integer
fonte	source	string
lessonCount	lessonCount	integer
createdAt	createdAt	date-time
updatedAt	updatedAt	date-time

LearningByteListResponse

Nome	Caminho	Tipo	Description
itens	items	array of LearningByteDto

ExerciseListResponse

Nome	Caminho	Tipo	Description
itens	items	array of ExerciseDto

CertificateDto

Nome	Caminho	Tipo
id	id	uuid
ID da inscrição	enrollmentId	uuid
studentId	studentId	uuid
companyId	companyId	uuid
courseId	courseId	uuid
courseVersionId	courseVersionId	uuid
studentName	studentName	string
CompanyName	companyName	string
courseName	courseName	string
serialNumber	serialNumber	string
completedAt	completedAt	date-time
emitido em	issuedAt	date-time
pdfFileId	pdfFileId	uuid
pdf Disponível	pdfAvailable	boolean

CertificateListResponse

Nome	Caminho	Tipo	Description
itens	items	array of CertificateDto

MediaDto

Nome	Caminho	Tipo
id	id	uuid
nome	name	string
description	description	string
kind	kind	string
Tipo MIME	mimeType	string
sizeBytes	sizeBytes	integer
status	status	string
processingStatus	processingStatus	string
createdAt	createdAt	date-time
uploadedBy	uploadedBy	UploadedByDto

MediaListResponse

Nome	Caminho	Tipo	Description
itens	items	array of MediaDto
página	page	PageInfo

LessonListResponse

Nome	Caminho	Tipo	Description
itens	items	array of LessonDto

CourseBreakdownDto

Nome	Caminho	Tipo
courseId	courseId	uuid
courseName	courseName	string
progressPercent	progressPercent	integer
hoursSpent	hoursSpent	double
startedAt	startedAt	date-time
completedAt	completedAt	date-time

StudentInsightsDto

Nome	Caminho	Tipo
userId	userId	uuid
janela	window	WindowDto
resumo	summary	StudentSummaryDto
byCourse	byCourse	array of CourseBreakdownDto

StudentSummaryDto

Nome	Caminho	Tipo
activeDays	activeDays	integer
lessonsCompleted	lessonsCompleted	integer
exercisesCompleted	exercisesCompleted	integer
quizzesPassed	quizzesPassed	integer
hoursSpent	hoursSpent	double

WindowDto

Nome	Caminho	Tipo
kind	kind	string
de	from	date-time
para	to	date-time

EventItemDto

Nome	Caminho	Tipo
id	id	uuid
kind	kind	string
ação	action	string
courseId	courseId	uuid
courseName	courseName	string
occurredAt	occurredAt	date-time

EventListResponse

Nome	Caminho	Tipo	Description
itens	items	array of EventItemDto
página	page	PageInfo

CompanyInsightsDto

Nome	Caminho	Tipo	Description
companyId	companyId	uuid
resumo	summary	CompanySummaryDto

CompanySummaryDto

Nome	Caminho	Tipo
totalStudents	totalStudents	integer
averageProgressPercent	averageProgressPercent	integer
activeThisWeekCount	activeThisWeekCount	integer
completedCount	completedCount	integer
completionRatePercent	completionRatePercent	integer

ExpertDto

Nome	Caminho	Tipo
id	id	uuid
nome	name	string
description	description	string
status	status	string
linkedDocumentCount	linkedDocumentCount	integer
createdAt	createdAt	date-time
updatedAt	updatedAt	date-time

ExpertListResponse

Nome	Caminho	Tipo	Description
itens	items	array of ExpertDto
página	page	PageInfo

DocumentDto

Nome	Caminho	Tipo
id	id	uuid
nome	name	string
description	description	string
Tipo MIME	mimeType	string
sizeBytes	sizeBytes	integer
status	status	string
createdAt	createdAt	date-time
uploadedBy	uploadedBy	UploadedByDto

DocumentListResponse

Nome	Caminho	Tipo	Description
itens	items	array of DocumentDto
página	page	PageInfo

DepartmentListResponse

Nome	Caminho	Tipo	Description
itens	items	array of DepartmentDto

DemoTrainingListItemDto

Nome	Caminho	Tipo
id	id	uuid
departmentId	departmentId	uuid
videoFileId	videoFileId	uuid
nome	name	string
description	description	string
trainingType	trainingType	string
status	status	string
está disponível	isAvailable	boolean
assignedRoleIds	assignedRoleIds	array of uuid
segmentCount	segmentCount	integer
durationSeconds	durationSeconds	integer
createdAt	createdAt	date-time

DemoTrainingListResponse

Nome	Caminho	Tipo	Description
itens	items	array of DemoTrainingListItemDto
página	page	PageInfo

CourseDto

Nome	Caminho	Tipo
id	id	uuid
nome	name	string
status	status	string
moduleCount	moduleCount	integer
topicCount	topicCount	integer
hasUnpublishedChanges	hasUnpublishedChanges	boolean
currentVersionNumber	currentVersionNumber	integer
latestPublishedAt	latestPublishedAt	date-time
createdAt	createdAt	date-time

CourseListResponse

Nome	Caminho	Tipo	Description
itens	items	array of CourseDto
página	page	PageInfo

GenerationProgressDto

Nome	Caminho	Tipo
totalTasks	totalTasks	integer
completedTasks	completedTasks	integer
tarefas falhadas	failedTasks	integer

GenerationRequestInfoDto

Nome	Caminho	Tipo
id	id	uuid
status	status	string
createdAt	createdAt	string
completedAt	completedAt	string
erro	error	string
progress	progress	GenerationProgressDto
destino	target	string
targetId	targetId	uuid
tipo de pai	parentType	string
topicIds	topicIds	array of uuid
moduleIds	moduleIds	array of uuid

GenerationStatusResponse

Nome	Caminho	Tipo	Description
activeRequests	activeRequests	array of GenerationRequestInfoDto

CourseVersionDto

Nome	Caminho	Tipo
id	id	uuid
courseId	courseId	uuid
versionNumber	versionNumber	integer
publishedAt	publishedAt	date-time
publishedBy	publishedBy	uuid
moduleCount	moduleCount	integer
topicCount	topicCount	integer
lessonCount	lessonCount	integer
exerciseCount	exerciseCount	integer
questionCount	questionCount	integer
estimatedTimeSeconds	estimatedTimeSeconds	integer

CourseVersionListResponse

Nome	Caminho	Tipo	Description
itens	items	array of CourseVersionDto

AuditSnapshot

Nome	Caminho	Tipo
createdAt	createdAt	date-time
createdBy	createdBy	uuid
updatedAt	updatedAt	date-time
atualizadoPor	updatedBy	uuid

CourseSnapshot

Nome	Caminho	Tipo
nome	name	string
coverImageId	coverImageId	uuid
prerequisiteCourseId	prerequisiteCourseId	uuid
courseGuideline	courseGuideline	string
lessonsGuideline	lessonsGuideline	string
questionsGuideline	questionsGuideline	string
exercisesGuideline	exercisesGuideline	string
modules	modules	array of ModuleSnapshot

CourseVersionSnapshotDto

Nome	Caminho	Tipo
id	id	uuid
courseId	courseId	uuid
versionNumber	versionNumber	integer
instantâneo	snapshot	CourseSnapshot

ExerciseSnapshot

Nome	Caminho	Tipo
id	id	uuid
topicId	topicId	uuid
exerciseType	exerciseType	string
solicitação	prompt	string
ordinalNumber	ordinalNumber	integer
isGenerated	isGenerated	boolean
fonte	source	string
auditoria	audit	AuditSnapshot
avatarCharacteristics	avatarCharacteristics	string
avatarPictureId	avatarPictureId	uuid
reverseRolePlayEnabled	reverseRolePlayEnabled	boolean
reverseRolePlayMandatory	reverseRolePlayMandatory	boolean
cenário	scenario	string
traineeRole	traineeRole	string
avatarName	avatarName	string
avatarDescription	avatarDescription	string
operationalChallenge	operationalChallenge	string
successMetric	successMetric	string
instrução	instruction	string
instructionReverse	instructionReverse	string
exerciseKnowledgeBase	exerciseKnowledgeBase	string

LearningByteSnapshot

Nome	Caminho	Tipo
id	id	uuid
topicId	topicId	uuid
nome	name	string
description	description	string
ordinalNumber	ordinalNumber	integer
fonte	source	string
auditoria	audit	AuditSnapshot
lições	lessons	array of LessonSnapshot

LessonSnapshot

Nome	Caminho	Tipo
id	id	uuid
learningByteId	learningByteId	uuid
conteúdo	content	string
ordinalNumber	ordinalNumber	integer
fonte	source	string
auditoria	audit	AuditSnapshot
mídia	media	array of MediaSnapshot
perguntas	questions	array of QuestionSnapshot

LinkedDocumentSnapshot

Nome	Caminho	Tipo
id	id	uuid
fileId	fileId	uuid
linkType	linkType	string
isSupplement	isSupplement	boolean
nome	name	string
extensão	extension	string
size	size	integer
description	description	string

MediaSnapshot

Nome	Caminho	Tipo
id	id	uuid
fileId	fileId	uuid
ordinalNumber	ordinalNumber	integer
mediaType	mediaType	string
fonte	source	string

ModuleSnapshot

Nome	Caminho	Tipo
id	id	uuid
courseId	courseId	uuid
productId	productId	uuid
nome	name	string
description	description	string
Introdução	intro	string
ordinalNumber	ordinalNumber	integer
quizSettings	quizSettings	array of QuizSettingSnapshot
quizQuestions	quizQuestions	array of QuestionSnapshot
topics	topics	array of TopicSnapshot

OptionSnapshot

Nome	Caminho	Tipo
id	id	uuid
optionText	optionText	string
isCorrect	isCorrect	boolean
ordinalNumber	ordinalNumber	integer

QuestionSnapshot

Nome	Caminho	Tipo
id	id	uuid
questionType	questionType	string
questionText	questionText	string
expectedAnswer	expectedAnswer	string
ordinalNumber	ordinalNumber	integer
fonte	source	string
auditoria	audit	AuditSnapshot
Opções	options	array of OptionSnapshot

QuizSettingSnapshot

Nome	Caminho	Tipo	Description
questionType	questionType	string
contagem	count	integer

TopicSnapshot

Nome	Caminho	Tipo
id	id	uuid
moduleId	moduleId	uuid
nome	name	string
description	description	string
Introdução	intro	string
ordinalNumber	ordinalNumber	integer
quizSettings	quizSettings	array of QuizSettingSnapshot
quizQuestions	quizQuestions	array of QuestionSnapshot
learningBytes	learningBytes	array of LearningByteSnapshot
exercícios	exercises	array of ExerciseSnapshot
linkedDocuments	linkedDocuments	array of LinkedDocumentSnapshot
topicKnowledgeBase	topicKnowledgeBase	string

StreamingResponseBody