On this page

API Reference

A complete guide to our platform's API endpoints and functionalities.

Introduction

Welcome to the developer documentation. Our API allows you to programmatically interact with our platform, giving you the power to build custom integrations and automate workflows.

All API access is over HTTPS, and is accessed from the https://api.yourdomain.com endpoint. All data is sent and received as JSON.

Base URL: https://api.yourdomain.com/v1

Authentication

To use the API, you will need an API key. You can generate a new key from your account settings page under the "API" tab.

Include your API key in the Authorization header of your requests:

curl "https://api.yourdomain.com/v1/agents" \
  -H "Authorization: Bearer YOUR_API_KEY"

Rate Limiting

The API is rate-limited to 100 requests per minute. If you exceed this limit, you will receive a 429 Too Many Requests response.


#### 2. For Integrations

*   Create a new folder named `integrations` inside `src/contents/docs/`.
*   Inside `src/contents/docs/integrations/`, create a new file named `slack.mdx`.

**File:** `src/contents/docs/integrations/slack.mdx`
**Content:**
```mdx

title: Slack Integration
description: Learn how to connect your account to Slack to receive notifications and manage your agents.


## Connecting to Slack

Our Slack integration makes it easy to stay updated on your agent's activity without leaving your workspace.

<Steps>
  <Step title="Go to Settings">
    Navigate to the "Integrations" tab in your account settings.
  </Step>

  <Step title="Connect Slack">
    Click the "Add to Slack" button and follow the on-screen instructions to authorize the connection.
  </Step>

  <Step title="Configure Notifications">
    Once connected, you can choose which channel to post notifications to and select the events you want to be notified about.
  </Step>
</Steps>

## Available Notifications

You can configure notifications for various events, including:

- New user conversation started
- Agent fails to answer a question
- User provides a low rating

<Info>
This setup allows your team to monitor agent performance and intervene when necessary, directly from Slack.
</Info>