What are collections
A collection is a set of pre-configured HTTP requests organized by resource. Instead of building each request from scratch — URL, method, headers, body — you import the file and have all the Timely.ai endpoints ready to run. Collections are useful for:Quick testing
Validate an endpoint in seconds, without having to write integration code yet.
Production debugging
Reproduce a call with the exact parameters to isolate API errors.
Living documentation
Share a file with your team that both describes and executes all endpoints.
Smoke tests
Run the collection after each deploy to verify that critical endpoints are still responding.
Available options
We offer two collections with identical endpoint coverage. Choose the tool that already fits your workflow:Postman
Free cloud tool, popular with teams. Visual interface, execution history, support for environments and pre-request scripts.
Bruno
Open-source, git-friendly alternative.
.bru files are plain text — you version your requests alongside your project code.Requirements before you start
Before importing any collection, you need:API Key
Access the Timely.ai dashboard under Settings → API Keys and generate a key. Copy it and store it somewhere safe — it won’t be shown again.
Workspace configured
Confirm that your workspace is active and that the API key belongs to the correct workspace. All endpoints are scoped by workspace.
Download collections
| Tool | File | Format |
|---|---|---|
| Postman | timely-ai.postman_collection.json | JSON |
| Bruno | timely-ai.bruno.zip | ZIP with .bru files |
Authentication in collections
All Timely.ai endpoints use header-based authentication:api_key variable in the environment. The guide for each tool shows exactly how to do this.