Especificação OpenAPI
A superfície da API vive em um documento OpenAPI 3.1: operações com identificador próprio, parâmetros tipados, esquemas de resposta e o envelope de erro. Ferramentas de function calling leem esse arquivo sem adaptação.
Documentação
Desenvolvedores e agentes
O que a TreinaWeb publica para máquinas: a especificação da API, os arquivos de descoberta e as páginas em Markdown.
API de parceiros
Empresas com contrato B2B consultam seus alunos, o andamento de cada um nos cursos e geram URLs de login direto. O token chega no fechamento do contrato: não há auto-cadastro nem ambiente de testes aberto. Autentique com o header Authorization: Bearer.
Arquivos para agentes
O llms.txt descreve o site no formato llmstxt.org, com links já apontando para a versão Markdown de cada página. O robots.txt libera os agentes de IA conhecidos e declara o Content-Signal do conteúdo.
Páginas em Markdown
Qualquer página do site responde em Markdown. Envie o header Accept: text/markdown ou acrescente .md ao caminho. O navegador continua recebendo HTML na mesma URL, e a resposta declara Vary: Accept para os caches intermediários.
Servidor MCP
O endpoint MCP responde relatórios e consultas somente leitura da plataforma por OAuth 2.1 com PKCE, no escopo mcp:use. O acesso é restrito a administradores autorizados. Clientes se registram sozinhos pelo endpoint de registro dinâmico.
Erros
Toda rota sob /api responde em JSON, erro
incluído. O código em code é estável e serve
para tratamento programático; a mensagem muda conforme o caso.
{
"error": {
"http_code": 401,
"code": "unauthorized",
"message": "Faltando header de autorização."
}
}Fora da API, um agente que pede Markdown recebe o erro em Markdown, com o status por extenso e os pontos de entrada do site. O navegador continua vendo a página de erro em HTML.
Integrações sob demanda
Precisa de um recurso que não está publicado aqui? Descreva o caso de uso no formulário de contato ou escreva para atendimento@treinaweb.com.br .