> For the complete documentation index, see [llms.txt](https://mrbarnk.gitbook.io/waabot-api-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://mrbarnk.gitbook.io/waabot-api-documentation/overview/introduction.md).

# Introduction

Welcome to the official Waabot API documentation! This guide provides comprehensive instructions and references for integrating the Waabot platform into your applications.

**Authentication:**

The Waabot API utilizes an **API Key** and **API Secret** for authentication. These credentials can be obtained from the developer menu within your Waabot account:

* **Access:** Navigate to <https://app.waabot.com/u/developer/api>

**Supported SDKs:**

Waabot offers various SDKs to simplify integration with different programming languages. The Node.js SDK is readily available for download and usage:

* **Repository:** <https://github.com/Waabot/waabot-v2-sdk>

This documentation will detail API endpoints, request/response formats, error codes, and code samples to assist you in effectively utilizing the Waabot platform's functionalities.

### Status Code Errors

The following table outlines the potential error codes you might encounter when interacting with the Waabot API and their corresponding meanings:

| Status Code | Description                                                                                           |
| ----------- | ----------------------------------------------------------------------------------------------------- |
| 200         | OK - Request processed successfully.                                                                  |
| 400         | Bad Request - Invalid request syntax or parameters.                                                   |
| 401         | Unauthorized - Invalid or missing API credentials.                                                    |
| 403         | Forbidden - Insufficient permissions for the requested action.                                        |
| 404         | Not Found - Requested resource not available.                                                         |
| 405         | Method Not Allowed - Attempted to use an unsupported HTTP method for the endpoint.                    |
| 422         | Unprocessable Entity - Request payload is valid but cannot be processed due to business logic errors. |
| 500         | Internal Server Error - Unexpected error on the Waabot server.                                        |
| 502         | Bad Gateway - Waabot server failed to communicate with an upstream service.                           |
| 503         | Service Unavailable - Waabot server is overloaded or undergoing maintenance.                          |

This table provides a starting point for understanding the API's response codes. Specific error messages within the response body might offer further details regarding the encountered issue.