O que são collections
Uma collection é um conjunto de requisições HTTP pré-configuradas e organizadas por recurso. Em vez de montar cada request do zero — URL, método, headers, body — você importa o arquivo e já tem todos os endpoints da Timely.ai prontos para executar. Collections são úteis para:Testes rápidos
Valide um endpoint em segundos, sem precisar escrever código de integração ainda.
Debug de produção
Reproduza uma chamada com os parâmetros exatos para isolar erros da API.
Documentação viva
Compartilhe com o time um arquivo que descreve e executa todos os endpoints.
Testes de smoke
Rode a collection após cada deploy para verificar se os endpoints críticos continuam respondendo.
Opções disponíveis
Oferecemos duas collections com cobertura idêntica dos endpoints. Escolha a ferramenta que já faz parte do seu fluxo:Postman
Ferramenta cloud gratuita, popular em times. Interface visual, histórico de execuções, suporte a environments e pre-request scripts.
Bruno
Alternativa open-source e git-friendly. Arquivos
.bru são texto puro — você versiona as requests junto com o código do projeto.Requisitos antes de começar
Antes de importar qualquer collection, você precisa de:API Key
Acesse o dashboard da Timely.ai em Configurações → API Keys e gere uma chave. Copie e guarde em lugar seguro — ela não é exibida novamente.
Workspace configurado
Confirme que seu workspace está ativo e que a chave de API pertence ao workspace correto. Todos os endpoints são escopados por workspace.
Download das collections
| Ferramenta | Arquivo | Formato |
|---|---|---|
| Postman | timely-ai.postman_collection.json | JSON |
| Bruno | timely-ai.bruno.zip | ZIP com arquivos .bru |
Autenticação nas collections
Todos os endpoints da Timely.ai usam autenticação via header:api_key no environment. Os guias de cada ferramenta mostram exatamente como fazer isso.