<aside> 💡

Need help? Scan the QR code to chat with us on WhatsApp or book onto a daily live support sessions, book as often as you like.

→ Log in to your account.

</aside>

This guide provides a comprehensive overview of how to use the Maybe* API for integrating and developing custom solutions. The API is designed for developers to facilitate interaction with Maybe* services, including account management, user interactions, and AI conversations.

Generating an API Key

Steps to Create an API Key

1. Access Settings:
   • Navigate to the 'Settings' section in your Maybe* account.
2. Go to Integrations:
   • Within the settings, find the 'Integrations' section.
3. Create API Key:
   • Locate the 'Create API Key' option.
   • If no API key has been created, a 'Create' button will be available. Click this to generate a new key.

Important: Keep the API key confidential. It is recommended to keep the key hidden for security reasons, although you can copy it for use.

Accessing API Documentation

Viewing the API Documentation

1. Visit **https://apidocs.maybetech.com/

Understanding API Usage

API Features and Endpoints

• For Developers:
  • The API is primarily for developers who will integrate and code using Maybe* services.
• Available Endpoints:
  • GET Account Details: Retrieve information about your account.
  • GET Users: Access user details associated with the account.
  • GET Agents and Create Conversations:
    • Retrieve agent information and initiate conversations.
    • To create an AI conversation, select the desired agent, account, and user, then create a conversation followed by a chat.

Best Practices

• Security: Always keep your API key confidential and avoid exposing it in public repositories or unsecured locations.
• Documentation: Regularly review API documentation for updates and changes.
• Testing: Ensure thorough testing of API integrations in a secure environment before deploying to production.