Skip to content

Postman collection

Import a pre-built Postman collection to explore and test all Chatevo API endpoints without writing requests from scratch.

FormatURL
Collection JSONhttps://api.chatevo.ai/api/docs/postman/collection.json
Environment templatehttps://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.

  1. Open Postman → Import.
  2. Upload collection.json or paste the URL above.
  3. Import environment.json as a new environment.
  4. Set environment variables:
VariableExample value
base_urlhttps://api.chatevo.ai
api_keych_live_xxx
deployment_iddep_abc123
assistant_idasst_7xK9mN2p
knowledge_base_idkb_3fG8hJ1k
FolderRequests
AssistantsList, create, get, update, attach KB/tool
Knowledge basesCRUD, upload document, reindex, status
ToolsCRUD, test invocation
ConversationsList, create, close
MessagesSend sync, send stream
WidgetConfig (with Origin header), messages
WebhooksCreate, list, test delivery

Collection-level auth is set to Bearer Token using {{api_key}}.

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.

Several requests include Postman test scripts that:

  • Assert 200/201 status codes
  • Save conversation_id from the first message to the environment
  • Log X-RateLimit-Remaining headers

Use the Collection Runner to execute the full flow: create assistant → upload doc → send message.

Export Newman-compatible runs:

Terminal window
npx newman run collection.json \
-e environment.json \
--env-var "api_key=$CHATEVO_API_KEY"