.bg-primary-light{
    background: linear-gradient(to right, #6B00F5, #C633ED, #FF7700);
}
.bg-primary {
    background: linear-gradient(to right, #6B00F5, #C633ED, #FF7700);
}
.bg-primary-dark {
    background: linear-gradient(to right, #6B00F5, #C633ED, #FF7700);
}
.border-primary-light\/30 {
    border: none
}

New Request

Toolzz Docs

Discover our comprehensive suite of AI-powered solutions

Welcome to Toolzz

Get started with Toolzz products in minutes

Quick Start Guide

Learn how to integrate Toolzz products into your applications

Integration Guide

Welcome to the Toolzz AI documentation! Here, you’ll find detailed information about authentication, endpoints, request and response examples, and details about available events.

Introduction

Módulo que lida diretamente com os planos da instituição dentro do Toolzz AI é por meio dele que os Administradores têm acesso as cobranças em cima dos planos e todas as informações necessárias

Planos

Introdução

O objetivo principal desse webhook é fornecer informações em tempo real sobre o progresso e as respostas dos usuários, independentemente do resultado da atividade. Isso permite que a instituição acompanhe o engajamento dos usuários, analise o desempenho nas atividades e tome medidas apropriadas.

Atividade respondida

O objetivo principal desse webhook é fornecer informações atualizadas sobre as matrículas dos usuários, permitindo que a instituição acompanhe o fluxo de inscrições, gerencie recursos e conteúdo do curso e possa tomar ações apropriadas.

Nova matrícula

Curso concluído

O principal propósito desse webhook é fornecer uma notificação em tempo real quando um usuário finalizar com êxito uma trilha de aprendizado. Isso permite que a instituição ou o sistema registre e acompanhe o progresso dos usuários.

Trilha concluída

O principal propósito desse webhook é fornecer uma notificação em tempo real quando um usuário finalizar um conteúdo. Isso permite que a instituição ou o sistema registre e acompanhe o progresso dos usuários.

Conteúdo concluído

Este webhook tem como objetivo enviar um evento sempre que um novo certificado for emitido. Esse evento será acionado quando um usuário concluir um curso e solicitar o acesso ao certificado clicando no botão "Ver Certificado".

Certificado emitido

O principal propósito desse webhook é fornecer uma notificação em tempo real quando um usuário resgatar um produto da loja de gamicação.

Resgate de produto

Resgate de produto da loja de recompensas

Este evento é acionado sempre que um novo usuário é cadastrado na plataforma, independente do método. Ele envia informações sobre o usuário recém-cadastrado para a rota escolhida.

Novo cadastro

O objetivo principal desse webhook é fornecer uma notificação em tempo real quando ocorrer a desabilitação de um cadastro. Isso permite que a instituição ou o sistema acompanhe as mudanças de status dos usuários.

Alteração de Status

Este webhook tem como objetivo enviar um evento toda vez que um cadastro é editado. O evento será acionado quando um usuário realizar a edição das informações do seu perfil ou quando um administrador/gestor fizer a edição em nome do usuário.

Edição de Usuário

Este webhook tem como objetivo enviar um evento com os dados do usuário no momento em que ele aceita ser inserido na newsletter da instituição.

Aceitar newsletter

Welcome to the Toolzz Chat! This documentation provides you with everything you need to get started including security protocols, API references, implementation examples, event system and integration guidelines.

Welcome to the Toolzz Bots documentation! Here, you’ll find detailed information about authentication, endpoints, request and response examples, and details about available events.

System Integration and Connectivity Platform

Toolzz AI

Toolzz LMS

Toolzz Chat

Toolzz Bots

Toolzz Connect

Home

Support

Módulo responsável por lidar com o gerenciamento das interações entre o Agente e o usuário, permitindo acompanhar o custo por pergunta e o custo total em períodos específicos, facilitando a gestão do orçamento e permitindo ajustes estratégicos no uso dos recursos de IA para manter a operação eficiente e dentro do planejamento financeiro.

Analytics

Gere o token de autorização que será usado nas suas requisições.

Token do admin

Token do Administrador

Este endpoint permite a criação de aulas em um curso no Toolzz LMS.

Criar aula

Criar Aulas

Este endpoint da API permite comparar os resultados de uma prova classificatória entre dois alunos no Toolzz LMS.

Comparar resultado

Comparativo de resultados de uma prova classificatória

Este endpoint permite consultar os resultados de uma prova classificatória em um curso específico no Toolzz LMS.

Listar resultados

Listar Resultados de uma Prova Classificatória

Este endpoint permite a criação de questões para provas, recebendo os dados necessários para configurar cada questão.

Criar questões

Criar Questões de Provas

Este endpoint permite listar as avaliações de uma instituição no Toolzz LMS.

Listar avaliações

Listar Avaliações

Este endpoint permite consultar as notas de um aluno em um curso específico no Toolzz LMS.

Listar notas

Listar Notas de um Aluno por Curso

Este endpoint permite consultar as notas de um aluno em diversos cursos no Toolzz LMS.

Listar notas de um aluno em vários cursos

Listar notas de um aluno para vários cursos

Este endpoint permite consultar e listar as atividades corrigidas no Toolzz LMS.

Atividades corrigidas

Lista de Atividades Corrigidas

Este endpoint permite criar uma nova seção no catálogo, apresentando conteúdos em formato de cartão (card) em uma galeria carrossel.

Gerar seções

Gerar Seções Embedáveis

Liste ou gere um arquivo com os conteúdos da sua instituição.

Listar conteúdos

Listagem de Conteúdos

Este endpoint permite recuperar a lista de todos os cursos livres publicados da sua instituição no Toolzz LMS.

Listar cursos

Listar Cursos

Criar cursos

Criar Cursos

Editar cursos

Editar Cursos

Este endpoint permite criar novas aulas em um curso dentro da sua instituição no Toolzz LMS.

Criar aulas

Este endpoint permite inserir moedas na carteira de um aluno.

Ceder moedas

Obter filtros

Obter filtros da instituição ou escola

Este endpoint permite solicitar a autenticação externa para obter um **token de acesso**.

Login de aluno

Login de Aluno

Este endpoint permite incluir um aluno específico em um pacote de cursos.

Incluir aluno

Incluir aluno em um pacote de cursos

Remova um usuário de um pacote de curso específico

Remover aluno

Remover aluno do pacote de Cursos

Recupere os alunos matriculados em um pacote de curso específico

Listar alunos

Listar alunos de um pacote

Recupere os alunos matriculados em um pacote de curso específico.

Listar pacotes

Recupere os dados atualizados de progressão nos cursos de uma escola específica.

Progressão da unidade

Dados de Progressão da Unidade

Recupere os dados atualizados de progressão nos cursos da sua instituição.

Progressão da instituição

Dados de Progressão da Instituição

Retorna os dados de consumo exibidos no dashboard da unidade desejada.

Dashboard da unidade

Dashboard da Unidade

Recupere as avaliações feitas a um curso específico.

Reações de cursos

Dados de reações de cursos

Esta API fornece uma listagem detalhada dos usuários que, atualmente, não estão matriculados em nenhum curso.

Usuários não matriculados

Usuários Não Matriculados

Este endpoint fornece uma listagem detalhada de todos os alunos atualmente matriculados em um ou mais cursos dentro de um grupo específico.

Matrículas de usuários por grupo

Matrículas de Usuários por Grupo

Esta API retorna um relatório paginado dos cursos em que um aluno está matriculado dentro de um grupo.

Detalhes da matrícula do usuário

Detalhes da Matrícula do Usuário em um Grupo da sua Instituição

Esta API fornece informações sobre os cursos disponíveis.

Cursos da instituição

Cursos da Instituição

Esta API é destinada à gestão de membros, fornecendo informações detalhadas sobre os usuários.

Membros da instituição

Membros da Instituição

Criar trilhas

Criar Trilhas

Edite as trilhas criadas previamente na sua instituição

Editar Trilhas

Este `Endpoint` permite listar informações essenciais sobre as turmas dentro das instituições educacionais.

Listar turmas

Listar Turmas

Com este endpoint, é possível vincular uma turma a uma escola, definir seu tipo, código e título, além de associá-la a grupos, subgrupos e especialidades.

Criar turmas

Criar Turmas

Com este endpoint, é possível alterar o código e o título da turma, além de associá-la a grupos, subgrupos e especialidades.

Editar turmas

Editar Turmas

Com este endpoint, é possível excluir uma turma vinculada a uma escola específica.

Excluir turmas

Excluir Turmas

Indique uma turma e envie um ou mais objetos de alunos para remover alunos da turma.

Desmatricular alunos

Desmatricule alunos de uma turma

Indique uma turma e envie um ou mais objetos de alunos para registrá-los na turma.

Matricular alunos

Matricule alunos em uma turma

Cadastre novos alunos no Toolzz em uma ou mais escolas da sua instituição

Criar usuários

Criar usuários em várias escolas

Edite alunos no Toolzz, em uma ou mais escolas da sua instituição

Editar usuário

Consulte os dados do aluno registrado na sua instituição

Consultar alunos

Consulta de alunos por email ou CPF

Recupere as matrículas existentes para um aluno específico

Matrícula de aluno

Matrículas de aluno

Liste as unidades da sua instituição, com todos os seus dados e configurações. Realize uma busca específica pelo nome, número do contrato ou slug da unidade.

Listar unidades

Listar Unidades

O endpoint de criação de unidades permite registrar informações essenciais de instituições educacionais, facilitando o processo de inserção das mesmas.

Criar unidades

Criar Unidades

O endpoint de edição de unidades permite alterar informações essenciais de instituições educacionais.