Postman collection
Import a pre-built Postman collection to explore and test all Chatevo API endpoints without writing requests from scratch.
Download
Section titled “Download”| Format | URL |
|---|---|
| Collection JSON | https://api.chatevo.ai/api/docs/postman/collection.json |
| Environment template | https://api.chatevo.ai/api/docs/postman/environment.json |
Alternatively, import directly from the OpenAPI spec using Postman’s Import → Link with https://api.chatevo.ai/api/docs/openapi.json.
Import steps
Section titled “Import steps”- Open Postman → Import.
- Upload
collection.jsonor paste the URL above. - Import
environment.jsonas a new environment. - Set environment variables:
| Variable | Example value |
|---|---|
base_url | https://api.chatevo.ai |
api_key | ch_live_xxx |
deployment_id | dep_abc123 |
assistant_id | asst_7xK9mN2p |
knowledge_base_id | kb_3fG8hJ1k |
Collection structure
Section titled “Collection structure”| Folder | Requests |
|---|---|
| Assistants | List, create, get, update, attach KB/tool |
| Knowledge bases | CRUD, upload document, reindex, status |
| Tools | CRUD, test invocation |
| Conversations | List, create, close |
| Messages | Send sync, send stream |
| Widget | Config (with Origin header), messages |
| Webhooks | Create, list, test delivery |
Collection-level auth is set to Bearer Token using {{api_key}}.
Widget folder notes
Section titled “Widget folder notes”Widget requests include an Origin header pre-filled with https://www.example.com. Change it to a domain on your deployment’s allowlist before testing.
Running tests
Section titled “Running tests”Several requests include Postman test scripts that:
- Assert
200/201status codes - Save
conversation_idfrom the first message to the environment - Log
X-RateLimit-Remainingheaders
Use the Collection Runner to execute the full flow: create assistant → upload doc → send message.
CI integration
Section titled “CI integration”Export Newman-compatible runs:
npx newman run collection.json \ -e environment.json \ --env-var "api_key=$CHATEVO_API_KEY"