βš™οΈ
Maax AI Documentation
  • Start Here
    • ▢️Welcome to Maax
      • How does it work?
        • Integrations
        • Dataflow
      • Accessing your account
    • πŸ“šSetting Up Your Knowledge Base
      • Uploading Content
        • Upload Best Practices
      • Testing Responses
    • πŸ’»Web App (Dashboard)
      • Maax AI Setup
        • Upload Content
        • Student Support
        • Sales
      • Leaving Feedback on Conversations
  • Setup Your AI
    • πŸ’ΈSales AI
      • 1. Product
        • 1a. Update Knowledge Base
        • 1b. Create a Product Description
      • 2. Strategy
      • 3. Goal and Goal URL
      • 4. Creating Your Sales AI
    • πŸ¦Έβ€β™‚οΈCustomer Support AI
      • Emergency Notification Setting
  • πŸ”„Setup Your Integration
    • V2 Sales AI - Zapier
      • 1. Send Question to Maax
      • 1a. Explanation of Python Code Step
      • 2. Catch and Map Response From Maax
      • 3. Catch and Map Follow Ups
      • 4. Set up Emergency Notifications
    • V1 Customer AI - Zapier
      • Step 1 – Starting your Zap
      • Step 2 – Use Zapier Python to Send Your Question to Maax
        • Follow-up Message Handling
      • Step 3 – Delay Your Request
      • Step 4 – Get the Answer
      • Step 5 – Map the Answer
    • Example Use Cases
      • Gmail Customer Support Automation with Zapier
  • Technical Guides
    • πŸ”—APIs
      • V1
        • Authentication
        • Base Url
        • Conversations
        • Products
        • Strategies
        • Goals
        • Sales AIs
      • V2
        • Authentication
        • Base Url
        • Outgoing Messages
        • Conversations
    • πŸ‡Explanatory Diagrams
      • Advanced - MAAX AI API Model Architecture
      • Answer Generation With MAAX AI
  • πŸ’¬ Building Good Prompts
    • [Use Case] Engage Cart Abandons
Powered by GitBook
On this page
  • /inititiate_answer_generation
  • Generates an answer to a message.
  • /retrieve_answer
  • Retrieves an answer
  • /create-conversation/
  • Creates a new conversation instance
  • /get_conversations_history/
  • Fetches the history of a given conversation.
  1. Technical Guides
  2. APIs
  3. V1

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.

PreviousBase UrlNextProducts

Last updated 1 year ago

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

Name
Type
Description

message_content*

String

Contents of the message from your customer.

platform*

String

Where will you be sending the response to? website, email, sms

ai_id

Integer

service_type

String

For Customer Support use customer_support_automation.

For Sales use sales_automation.

prospect_id

Integer

The id of prospect who is asking the question (If it is not provided, the new one will be created based on the prospect_info)

prospect_info

JSON

At least one of the contact methods should be provided, along with the first and last names. You can always override these details, so if you do not have a last name, supply a blank string.

conversation_id

Int

output_format

String

Leave blank if you wish to receive a plain text response. Use html if you wish to receive a response formatted as html (recommended for sending email responses).

Headers

Name
Type
Description

Content-Type*

String

application/json

2hd-api-key*

String

/retrieve_answer

Retrieves an answer

GET https://app.maax.ai/api/retrieve_answer/

Path Parameters

Name
Type
Description

service_type*

String

incoming_message_id*

Integer

Headers

Name
Type
Description

2hd-api-key

String

/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

Name
Type
Description

prospect_id

Integer

The id of the prospect for which the conversation is created. If it is not provided, a new prospect will be created based on the prospect_info.

prospect_info

JSON

{ "email": "EMAIL", "phone": "PHONE_NUMBER", "first_name": "FIRST_NAME", "last_name": "LAST_NAME", "instagram": "INSTAGRAM_HANDLE", "facebook": "FACEBOOK_HANDLE" ... }

At least one contact information field (phone, email, Instagram, or Facebook) should be given, along with first name and last name.

Headers

Name
Type
Description

2hd-api-key*

String

/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

Name
Type
Description

conversation_id

Integer

Conversation for which history is desired.

service_type

String

Used for security purposes. Must match the Conversation object identified by 'conversation_id' above.

For Customer Support use customer_support_automation.

For Sales use sales_automation.

Headers

Name
Type
Description

2hd-api-key

String

Leave blank for customer_support_automation service type. For sales_automation service type get the ID from the

{"email":"", "phone":"1234567778" "first_name": "student", "last_name":"test"}

The conversation id between this user and the prospect. If it is not given, the latest conversation between these two will be used, otherwise, a new one will be created. Please review the endpoint if you want to create a conversation and specify an id. Recommended for sales applications.

Your MAAX AI API key, which you can locate at

Must be the same as in the for the given incoming_message_id. Used for security purposes.

An integer returned by a successfully executed

Your MAAX AI API key, which you can locate at

Your MAAX AI API key, which you can locate at

Your MAAX AI API key, which you can locate at

πŸ”—

Answer Generation With MAAX AI

/inititiate_answer_generation
/retrieve_answer
/create-conversation/
/get_conversations_history/
Sales AI dashboard.
email@test.com
https://app.maax.ai/dashboard/api-keys/
https://app.maax.ai/shboard/api-keys/
https://app.maax.ai/shboard/api-keys/
https://app.maax.ai/dashboard/api-keys/
/create_conversation/
/initiate_answer_generation
/initiate_answer_generation