Conversations
The bread and butter of MAAX AI business is generating perfect messages. This section explains in detail how to use the endpoints needed to make that happen.
There are two endpoints required to create and retrieve a message:
For creating conversations and getting conversation history you can use two other endpoints (used mostly for advanced sales applications):
We highly recommend that you review the visually enhanced explanations of how our API works. As a minimum, please review the following diagram:
/inititiate_answer_generation
Generates an answer to a message.
POST
https://app.max.ai/api/initiate_answer_generation/
This endpoint tasks MAAX AI with generating a response to a message your company received.
Query Parameters
Headers
/retrieve_answer
Retrieves an answer
GET
https://app.maax.ai/api/retrieve_answer/
Path Parameters
Headers
/create-conversation/
Creates a new conversation instance
POST
https://app.maax.ai/api/create-conversation/
This function is responsible for creating a conversation for a given prospect. A prospect is identified by their prospect_id, and additional information about the prospect can be provided in the prospect_info
field. Most often used in sales conversations, and very rarely for customer support conversations.
Query Parameters
Headers
/get_conversations_history/
Fetches the history of a given conversation.
GET
https:/app.maax.ai/create-conversation/
The conversation is identified by its conversation_id
. If a service_type
is provided, the function fetches the history specific to that service type.
Path Parameters
Headers
Last updated