Postman Collection

To try the API without writing any code, download a ready-made Postman collection for your agent. It contains the three core requests — start, message, history — pre-filled with your agent's ID and host, plus variables and a Bearer-token auth setup.

Download

From the agent context, request the collection:

GET /download-postman-collection/{agentId}?apiKey=YOUR_API_KEY

This returns a *.postman_collection.json file. The apiKey query parameter is optional — include it to have the collection pre-wired with your API key as a Bearer token.

What's inside

• Start Conversation — captures the returned conversationId into a collection variable so the next requests can use it automatically.
• Send Message — posts a message to the active conversation.
• Get Conversation History — retrieves the full transcript.
• Variables — base_url, agent_id, conversation_id, and api_key.

Use it

1. Download the collection (link/endpoint above).
2. Import the file into Postman.
3. Run Start Conversation, then Send Message — the conversation_id flows through automatically.

Tip: The collection is the quickest way to validate connectivity and auth before you wire the API into your own application. Once it works in Postman, the REST endpoints map one-to-one to your code.

Next steps

• Back to the REST Endpoints reference.
• Administering the platform? Head to Administration.