AyAgent Documentation

Follow these steps to set up your first AI agent and connect it to a communication channel:

Once you've completed these steps, your AI agent will be ready to interact with your customers. You can customize its behavior, train it with your data, and monitor its performance from the dashboard.

Creating Your First Agent

After signing in to your account, navigate to the Agents section and click on "Create New Agent." You'll be presented with several template options to choose from based on your business needs:

• Customer Support Agent - Handles frequently asked questions and basic support inquiries
• Lead Generation Agent - Qualifies leads and collects contact information
• Appointment Scheduling Agent - Books appointments and sends reminders
• Order Processing Agent - Processes orders and provides order status updates

Select the template that best matches your use case and give your agent a name. You can then proceed to customize its responses and behavior.

AyAgent is a cloud-based platform that doesn't require any installation. Simply sign up for an account and you can start using it right away through your web browser.

If you want to integrate AyAgent with your existing systems, you can use our API or SDKs:

curl -X POST https://api.ayagent.com/v1/agents \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Support Agent", "template_id": "t_123456"}'

System Requirements

Since AyAgent is a cloud-based platform, you only need:

• A modern web browser (Chrome, Firefox, Safari, or Edge)
• Internet connection
• For WhatsApp integration: A WhatsApp Business account or personal WhatsApp account

Agents are the core of the AyAgent platform. An agent is an AI-powered entity that can interact with your customers through various communication channels.

Agent Capabilities

AyAgent's AI agents are equipped with advanced capabilities that make them powerful tools for customer communication:

Training Your Agent

To get the most out of your agents, make sure to provide them with accurate information about your business, products, and services. The more information you provide, the better your agents will be able to assist your customers.

You can train your agent by:

• Uploading knowledge base documents
• Creating FAQ pairs
• Providing sample conversations
• Connecting to your product database

AyAgent uses advanced machine learning techniques to understand your data and use it to generate accurate responses to customer inquiries.

Templates define how your agents behave and respond to different situations. AyAgent provides pre-built templates for common use cases, or you can create custom templates.

Using Templates Effectively

When selecting a template for your agent, consider the following:

• Primary use case: Choose a template that aligns with your main goal
• Industry specifics: Some templates are tailored for specific industries
• Customization needs: Consider how much you'll need to modify the template

Once you've selected a template, you can customize it by editing conversation flows, adding your own knowledge base, and configuring integration with your existing systems.

The knowledge base is a central repository of information that your agents can access to provide accurate responses to customer inquiries.

Supported Content Types

AyAgent's knowledge base supports various content types:

• Documents - PDF, Word, and text files
• FAQs - Question and answer pairs
• URLs - Web pages that contain relevant information
• Product information - Details about your products or services

Creating a Knowledge Base

To create a knowledge base:

1. Navigate to the Knowledge Base section in your dashboard
2. Click "Create Knowledge Base" and give it a name
3. Upload documents or add content manually
4. Organize your content into categories for better management

Once your knowledge base is created, you can connect it to your agents to enhance their capabilities.

// Connect a knowledge base to an agent using the JavaScript SDK
const knowledgeBase = await ayagent.knowledgeBases.create({
  name: 'Product Information',
  description: 'Contains information about our products and services'
});

// Upload a document to the knowledge base
await ayagent.knowledgeBases.uploadDocument(knowledgeBase.id, {
  file: fs.createReadStream('product_catalog.pdf'),
  fileName: 'product_catalog.pdf'
});

// Connect the knowledge base to an agent
await ayagent.agents.update(agentId, {
  knowledgeBaseIds: [knowledgeBase.id]
});

AyAgent provides a RESTful API that allows you to integrate the platform with your existing systems. To use the API, you'll need to authenticate your requests using an API key.

Obtaining an API Key

To get an API key:

1. Log in to your AyAgent account
2. Go to Settings → API Keys
3. Click "Create API Key" and provide a name for the key
4. Copy the API key and store it securely

Using the API Key

To authenticate your API requests, include your API key in the Authorization header of your requests:

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

Replace YOUR_API_KEY with your actual API key.

API Rate Limits

To ensure fair usage of the API, we enforce rate limits based on your subscription plan:

• Free Plan: 100 requests per minute
• Standard Plan: 500 requests per minute
• Enterprise Plan: Custom limits based on your needs

If you exceed your rate limit, you'll receive a 429 Too Many Requests response. The response will include headers indicating your current rate limit status.

Credentials in AyAgent allow you to connect your agents to various communication channels such as WhatsApp, Email, or Live Chat.

For a detailed guide on setting up and managing credentials, see the Credentials documentation.

Available Channels

AyAgent currently supports the following channels:

• WhatsApp - Connect your WhatsApp Business account
• Email - Set up email communication for your agents
• Live Chat - Embed live chat on your website
• Telegram - Connect with customers through Telegram
• SMS - Send and receive text messages