How can we help?

API Access
API Access

API Access

Guide to accessing and using the Algomo API for advanced integrations.

What is this?

This feature enables you to directly interact with our AI engine, bypassing the traditional widget interface for a more headless approach. By offering this level of access, you can tackle complex use-cases, customizing your AI customer service strategies with greater flexibility and control.

Prerequisites

Before diving into the API, ensure the following:
  1. Create a Chatbot: Navigate to Algomo's chatbots dashboard.
  1. Add Data Sources: Visit the data sources dashboard.
  1. Assign Data Sources: Link the data sources to your chatbot through the chatbots dashboard.
  1. Generate an API Token: Obtain your API token from the organization settings page.
Perform preliminary tests on your chatbot and adjust your data sources as needed. Use test mode after linking your chatbot to a widget.

API Endpoint Specifications

Considerations

  • Rate Limits: A limit of 5 messages per minute is enforced.
  • Token Rules: Only one token can be active at a time.
  • Payload Size Limit: Messages must not exceed 1000 characters.
  • Behaviour/Tools: This endpoint will only generate responses to messages. Side effects (such as sending emails or escalating conversations) will not be triggered.

Identifying Your Chatbot ID

Find the chatbot ID in the URL while browsing your bot's page.
notion image

API Call for Bot Response Generation

HTTP Method: POST
Endpoint: https://app.algomo.com/api/v2/external/api-access/get-bot-response

Request Payload Schema

  • Authorization Header: Use the Bearer token for authentication in the Authorization header.
  • botId: The identifier for the chatbot.
  • messageText: The message that you wish to generate a response for.
  • conversationId (optional): A user-defined identifier for threading conversations.
    • This allows the bot to refer to previous messages when responding, providing more contextually relevant answers. If conversationId isn't provided, one will be generated for you

Example Request Payload

cURL Request

Response Types

  • 200 OK: Successful request, with a bot-generated response returned.
  • 400 Validation Error: Data validation failure.
  • 401 Unauthorized: Access unauthorized due to invalid token.
  • 404 Not Found: Specified bot ID not found.
  • 429 Too Many Requests Error: Rate limiting.
  • 500 Internal Server Error: Unspecified server error, contact support.

Example Successful Response

Example Error Response

 
 
 
Last updated on Feb 7, 2024
Previous Slack
Previous Slack
 
 
Did this answer your question?
Help Center
Home