# Creating and Configuring Your First Agent
Source: https://docs.shortext.ny-corp.io/agents/creating-an-agent

Learn how to create, personalize, and test your first AI-powered agent in Shortext.

In Shortext, an **Agent** is your AI-powered assistant — the entity that interacts with users, handles messages, and triggers automations or API calls.
This guide will show you how to create, configure, and test your first Agent.

***

## 🧩 Step 1 — Access the Agents Section

From your main dashboard, click **“Agents”** in the left navigation sidebar.

<img alt="Agents list screen" />

Here you can view all your existing agents or create new ones.

***

## ⚙️ Step 2 — Create a New Agent

Click **“New Agent”** (or **“Create Agent”**) in the top right corner.

<img alt="Agent creation form" />

Fill in the required details:

* **Agent Name** → e.g. “Support Assistant” or “Recruitment Bot”
* **Description** → A short sentence describing what this agent does.
* **Language** → The default language for conversations (English, French, etc.)
* **Active Status** → Whether the agent is live or in test mode.

<Note type="tip">
  Choose a meaningful name — it will appear in analytics and user session tracking.
</Note>

***

## 🧠 Step 3 — Define the Agent’s Personality

Every agent can have its own **personality** and **tone of voice**.

<img alt="Agent personality configuration" />

You can define:

* **Tone** → friendly, professional, neutral, etc.
* **Behavioral Instructions** → custom rules that guide how the agent responds.
* **Context Memory** → whether the agent remembers past interactions.

Example:

```json theme={null}
{
  "tone": "friendly",
  "style": "concise and helpful",
  "instructions": [
    "Always greet the user warmly.",
    "Keep messages short and easy to understand.",
    "If the question is unclear, ask for clarification."
  ]
}
```

<Note type="info">You can update an agent’s personality anytime without losing its previous conversation data. </Note>

***

## 🔗 Step 4 — Configure Channels

Each agent can be connected to one or more messaging channels.

<img alt="Agent channel configuration" />

Supported channels include:

* WhatsApp Business API
* Telegram
* Web Chat (optional)

Select the channel(s) the agent should respond on, and provide any necessary credentials (like your WhatsApp phone number or API token).

<Note type="warning"> If you’re using WhatsApp, make sure your number is already verified and linked to a WhatsApp
Business Account. </Note>

***

## 🧰 Step 5 — Connect APIs or Automations (Optional)

Agents can perform external actions by calling APIs or triggering automations.
This allows your bot to fetch data, send updates, or perform business logic dynamically.

<img alt="Agent API configuration" />

Examples:

* Fetch a user profile from your CRM
* Send payment confirmation
* Log a new support ticket

Configuration details are covered in:
👉 API Configuration & Testing →

***

## 🧪 Step 6 — Test Your Agent

Once your agent is configured, you can test it directly within Shortext.

<img alt="Agent test chat interface" />

Testing Options:

* **Internal Sandbox Chat** — Send messages to see how the agent responds.
* **Live Channel Test** — If linked to WhatsApp, send a real message from your number.
* **Debug Console** — Inspect the raw message exchange and AI reasoning (if available).

<Note type="success"> Testing helps fine-tune your prompts, responses, and API actions before going live. </Note>

***

## 🚀 Step 7 — Activate Your Agent

Once satisfied with your test results, toggle the “Active” switch.
Your agent is now live and ready to handle conversations from your users.

<img alt="Agent activation toggle" />

🧭 What’s Next

Now that your first agent is up and running, continue with:
Customizing Personality and Responses →
Connecting WhatsApp →
Testing APIs with Your Agent →

<Note type="info"> Agents are central to Shortext — once created, you can link them to automations, monitoring tools,
or even ticketing systems to extend their capabilities. </Note>


# Tools Configuration & Testing
Source: https://docs.shortext.ny-corp.io/agents/tools-configuration

Learn how to connect, configure, and test APIs within your Shortext agents to extend their capabilities.

Shortext Agents can interact with external systems through APIs — allowing them to fetch data, trigger workflows, or update other applications automatically.

This section explains how to configure and test these API integrations step by step.

***

## 🔧 Step 1 — Access the API Settings

From your **Agent Configuration** page, open the **“Tools”** tab.

<img alt="Agent API configuration tab" />

Each agent can have one or more API connections depending on your workflow.

***

## 🧩 Step 2 — Add a New Tool

Click **“New Tool”** to define a new connection.

<img alt="Adding a new API configuration" />

You’ll need to provide:

* **Name** — a friendly *unique* name in camelcase (e.g., `payment_confirmation` or `get_orders`)
* **State** — if the tool can be use or not by the agent (e.g `disable when the api is under maintenance`)
* **Description** — note about what the API does to allow agent to understand when to use it

Example of description:

```md theme={null}
This API provides data on the movies and TV shows available on Netflix, a popular streaming service.
```

***

## ⚙️ Step 3 — Define Endpoint and headers

Set the **endpoints** that will be used to consume your service and the required **headers** such as token, api key.

<img alt="Defining API endpoints" />

<Note type="info">
  Sensitive data such as tokens or API keys are encrypted and stored securely.
</Note>

Each endpoint includes:

* **Method** — `GET`, `POST`, `PUT`, `DELETE`, etc.
* **Url** — the full URL of your service (e.g., `https://acme.com/users/{id}`)
* **Headers** — optional (for content type, authentication)

<Note type="tip">
  You can use **variables** like `{phone}` or `{email}` in your paths.
  These will be replaced dynamically from the user’s conversation context.
</Note>

***

## ⚙️ Step 3 — Define Request Body

**Request Body** — JSON or form data (for POST/PUT requests)

<img alt="Defining API endpoints" />

Each parameter includes:

* **Name** — a friendly *unique* name (e.g., `order_id` or `id`).
* **Type** — the parameter type `STRING`, `INTEGER`, `BOOLEAN`. in case of `STRING`: possible values can be defined
* **Mandatory** — if it should be set always present or not
* **Description** — note about what the parameter does to allow agent to understand how to fill it

**Response Mapping** — always return response that has a clear meaning in JSON or plain text

Example:

```json theme={null}
{
  "success": true,
  "message": "The balance has been refresh successfully",
  "body": {
  "balance": {
    "amount": 634.1987,
    "currency": "EUR"
  },
  "local_balance": {
    "amount": 416618.8856,
    "currency": "XAF"
    }
  }
}
```

***

## 🧠 Step 4 — Usage of the API Inside an Agent

Once your API is configured and enabled, you can make it **callable** from your agent’s workflow or rules.

<img alt="Example of an agent using an API" />

Example:
When a user says *“Check my application status”*, your agent can call:

```json theme={null}
{
  "action": "api.call",
  "api": "RecruitmentService",
  "endpoint": "application_status",
  "params": {
    "phone": "{{user.phone}}"
  }
}
```

<Note type="success">
  You can define conditions so that API calls are triggered only when specific user intents are detected.
</Note>

***

## 🧪 Step 5 — Test the API Connection

Shortext provides a built-in **API Tester** so you can validate your setup before deploying it.

<img alt="API testing interface" />

To test:

1. Click on **Debug** on the endpoint you configured.
2. Provide any **parameters or payload** required.
3. Click **“Run Test”**.
4. View the **response logs** and status code.

<Note type="info">
  All test requests are logged for debugging. You can re-run tests as often as needed without affecting your live agents.
</Note>

***

## 🧭 Step 6 — Monitor API Usage

After deployment, you can track how often your agents call APIs via the **API Usage Log**.

<img alt="API usage logs and monitoring" />

You’ll see:

* **Timestamps** of API calls
* **Response time and status**
* **Agent and user** who triggered the call
* **Error messages** (if any)

<Note type="warning">
  Frequent or failed API calls may impact performance. Monitor this section to ensure stability.
</Note>

***

## 🧰 Example Use Cases

Here are a few examples of how API connections can enhance your agents:

| Use Case                 | Description                              | Example API             |
| ------------------------ | ---------------------------------------- | ----------------------- |
| **CRM Lookup**           | Fetch user info based on phone number    | `GET /users/{phone}`    |
| **Order Tracking**       | Retrieve delivery updates                | `GET /orders/{id}`      |
| **Payment Confirmation** | Validate or trigger a transaction        | `POST /payments/verify` |
| **Ticket Creation**      | Send a complaint or issue to your system | `POST /tickets/create`  |

***

## 🚀 Next Steps

Now that you’ve connected your APIs, you can:

* [Build Automations That Use API Data →](/automations/creating-automation)
* [Test Conversations with Live API Calls →](/agents/testing-conversation)
* [View API Analytics and Logs →](/api/logs)

***

<Note type="success">
  Shortext APIs give your agents the power to act — not just respond.
  With proper configuration, your bot can become a true workflow engine for your business.
</Note>


# Search agents
Source: https://docs.shortext.ny-corp.io/api-reference/agents/search-agents

api-reference/openapi.json get /agent/search



# get business balance
Source: https://docs.shortext.ny-corp.io/api-reference/business--manager/get-business-balance

api-reference/openapi.json get /business-manager/balance



# Send Message
Source: https://docs.shortext.ny-corp.io/api-reference/endpoint/message

POST /messages/send
Envoie un message au destinataire via l'API Shortext

<Tabs>
  <Tab title="Text">
    Text messages are messages containing only a text body and an optional link preview.

    <Card title="Text Message" />

    ## Link Preview

    You can have the WhatsApp client attempt to render a preview of the first URL in the body text string, if it
    contains one. URLs must begin with http\:// or https\://. If multiple URLs are in the body text string, only the
    first URL will be rendered.

    <Note>If omitted, or if unable to retrieve a link preview, a clickable link will be rendered instead.</Note>
  </Tab>

  <Tab title="Interactive Button Reply">
    <Card title="Interactive Button Reply">
      Interactive reply buttons messages allow you to send up to three predefined replies for users to choose from.

      <img />
    </Card>

    <Card title="User respond to interactive button">
      Users can respond to a message by selecting one of the predefined buttons, which triggers a messages webhook describing their selection.

      <img />
    </Card>
  </Tab>

  <Tab title="Interactive List Messages">
    <Card title="Interactive Button Reply">
      Interactive list messages allow you to present WhatsApp users with a list of options to choose from (options are defined as rows in the request payload):

      <img />
    </Card>

    <Card title="User respond to interactive button">
      When a user taps the button in the message, it displays a modal that lists the options available:

      <img />
    </Card>

    <Card title="User respond to interactive button">
      Users can then choose one option and their selection will be sent as a reply:

      <img />
    </Card>

    <Note>Interactive list messages support up to 10 sections, with up to 10 rows per section, and can include an optional header and footer.</Note>
  </Tab>

  <Tab title="Third Tab">
    💪 Here's content that's only inside the third Tab.
  </Tab>

  <Tab title="Third Tab">
    💪 Here's content that's only inside the third Tab.
  </Tab>
</Tabs>


# Health Check
Source: https://docs.shortext.ny-corp.io/api-reference/health/health-check

api-reference/openapi.json get /up
Check if the service is up



# Introduction
Source: https://docs.shortext.ny-corp.io/api-reference/introduction

Section for showcasing API endpoints

## Welcome

For SWAGGER lover, we are using the following OpenAPI specification.

<Card title="Shortext Endpoints" icon="leaf" href="https://shortext.ny-corp.io/api/docs">
  View the OpenAPI specification file
</Card>

## Authentication

All API endpoints are authenticated using Bearer tokens and picked up from the specification file.

```http request theme={null}
"Autorization": bearer <token>
```

## API Response Schema

All API endpoints return code 200 with this json structure the content of the response will always be accessible by the *body* key

<Note>
  trace\_id : present only when success=false. Can be used for support request
</Note>

```json theme={null}
{
  "success": true,
  "message": "Request success.",
  "code": 1000,
  "body": "< CAN BE NULL, A STRING OR JSON OBJECT OR JSON ARRAY>",
  "trace_id": ""
}
```

## Response schema for pagination

All items will be accessible from the data. To navigate to any page juste append **?page=page-number** on the path

> example : [https://shortext.ny-corp.io/api/agent/search?page=1](https://shortext.ny-corp.io/api/agent/search?page=1)

```json theme={null}
{
    "current_page": 1,
    "data": [

    ],
    "first_page_url": "https://shortext.ny-corp.io/api/agent/search?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "https://shortext.ny-corp.io/api/agent/search?page=1",
    "next_page_url": null,
    "path": "https://shortext.ny-corp.io/api/agent/search",
    "per_page": 50,
    "prev_page_url": null,
    "to": 8,
    "total": 8
}
```

## Response Code

| Code | Description                                                                                                         |
| ---- | ------------------------------------------------------------------------------------------------------------------- |
| 1    | The token has expired / Le token a expiré.                                                                          |
| 2    | The token is blacklisted / Le token est dans la liste noire.                                                        |
| 3    | The token is invalid / Le token est invalide.                                                                       |
| 4    | The token was not found / Le token n'a pas été trouvé.                                                              |
| 5    | The user associated with the token was not found / L'utilisateur associé au token n'a pas été trouvé                |
| 1000 | The request was successful / La requête a réussi.                                                                   |
| 1001 | The request failed / La requête a échoué.                                                                           |
| 1002 | Request validation error / Erreur de validation de la requête.                                                      |
| 1003 | The request has expired / La requête a expiré.                                                                      |
| 1004 | Trying to insert a duplicate entry / Tentative d'insertion d'un doublon.                                            |
| 1005 | The request is not authorized / La requête n'est pas autorisée.                                                     |
| 1006 | An exception occurred while processing the request / Une exception s'est produite lors du traitement de la requête. |
| 1007 | The request was not found / La requête n'a pas été trouvée.                                                         |
| 1008 | Incorrect JSON format in the request / Format JSON incorrect dans la requête.                                       |
| 1009 | The service is not available / Le service n'est pas disponible.                                                     |
| 1010 | Emergency request / Requête d'urgence.                                                                              |
| 1100 | The account is not verified / Le compte n'est pas vérifié.                                                          |
| 1101 | Incorrect username / Nom d'utilisateur incorrect.                                                                   |
| 1102 | Incorrect password / Mot de passe incorrect.                                                                        |
| 1103 | Incorrect credentials / Identifiants incorrects.                                                                    |
| 1104 | The account is verified / Le compte est vérifié.                                                                    |
| 1105 | The account does not exist / Le compte n'existe pas.                                                                |


# Send a message
Source: https://docs.shortext.ny-corp.io/api-reference/messages/send-a-message

api-reference/openapi.json post /messages/send
Envoie un message au destinataire via l'API Shortext



# Search a ticket
Source: https://docs.shortext.ny-corp.io/api-reference/tickets/search-a-ticket

api-reference/openapi.json get /ticket/search



# Search ticket sla records
Source: https://docs.shortext.ny-corp.io/api-reference/tickets/search-ticket-sla-records

api-reference/openapi.json get /ticket/sla/search



# Search ticket status records
Source: https://docs.shortext.ny-corp.io/api-reference/tickets/search-ticket-status-records

api-reference/openapi.json get /ticket/status/search



# Creating an Account
Source: https://docs.shortext.ny-corp.io/getting-started/creating-an-account

Learn how to create your Shortext account and access your dashboard in a few simple steps.

Getting started with **Shortext** only takes a few minutes.
This guide will walk you through creating your account, verifying it, and exploring the main dashboard.

***

## 🪄 Step 1 — Sign Up

Go to  and click **“Create Account”**.

You can register using:

* Your **email address**, or
* A **third-party provider** (if enabled on your workspace).

<img alt="Shortext sign-up screen" />

<Note type="info">
  Use a valid business email to ensure smooth account verification and communication.
</Note>

***

## 🧩 Step 2 — Verify Your Email

After signing up, you’ll receive a verification email.
Click the **“Verify Account”** button to activate your profile.

<img alt="Email verification message" />

<Note type="success">
  Once verified, you’ll be redirected automatically to your dashboard.
</Note>

***

## 💼 Step 3 — Complete Your Profile

To personalize your experience, Shortext will ask for a few details:

* Your **Company or Project Name**
* Your **Primary Use Case** (e.g., Customer Support, Sales, Recruitment)
* Your **Country / Region**

<img alt="Shortext profile setup" />

These details help us tailor automation suggestions and analytics to your needs.

***

## 🖥 Step 4 — Explore Your Dashboard

Once you’re logged in, you’ll arrive at the **Shortext Dashboard** — the control center of your communication ecosystem.

<img alt="Shortext dashboard overview" />

From here, you can:

* Create and manage **AI Agents**
* Monitor **Conversations** and **Sessions**
* Configure **APIs and Integrations**
* Access **Billing and Account Settings**

<Note type="tip">
  If this is your first time, explore the sidebar menu to familiarize yourself with key modules like “Agents”, “Messages”, and “Automations”.
</Note>

***

## ⚙️ Step 5 — Next Steps

You’re all set to start using Shortext 🎉

Continue with:

* [Creating Your First Agent →](/agents/creating-an-agent)
* [Connecting WhatsApp →](/integrations/whatsapp-setup)
* [Testing APIs with Your Agent →](/api/configuration)

***

<Note type="info">
  Need assistance during setup?
  You can chat directly with our support agent inside the dashboard or check the **FAQ section**.
</Note>


# Platform Overview
Source: https://docs.shortext.ny-corp.io/getting-started/platform-overview

Discover how the Shortext dashboard is organized and how to navigate its main features.

The **Shortext dashboard** is where you control everything — from AI agents and automations to integrations and analytics.
This section gives you a quick tour of the main components and how to use them efficiently.

***

## 🏠 Main Dashboard

After logging in, you’ll land on the **main dashboard**.
It provides an overview of your workspace activity — including active conversations, session status, and quick insights about your agents.

<img alt="Shortext main dashboard" />

### Key Elements:

* **Navigation Sidebar** — Access core modules like Agents, Conversations, and Automations.
* **Top Bar** — Contains search, account settings, and notifications.
* **Quick Stats** — Displays total conversations, active sessions, and response rate.

<Note type="info">
  Your dashboard adapts dynamically to your plan and enabled features. Some items may appear or hide based on your permissions.
</Note>

***

## 💬 Conversations

The **Conversations** module is the heart of your communication.
It displays real-time interactions between your users and your AI agents.

<img alt="Conversations view" />

### You can:

* View and filter messages by **status** or **agent**.
* Inspect user sessions and message history.
* Manually reply when needed.

<Note type="tip">
  When a user sends a message on WhatsApp or another channel, it instantly appears here.
</Note>

***

## 🤖 Agents

The **Agents** section lets you create, configure, and train your AI-powered assistants.

<img alt="Agents list view" />

Each agent can be personalized with:

* A **name** and **profile**
* A **personality** or tone of voice
* **Custom behaviors** or rules
* **Linked APIs** for advanced automation

> Agents are the backbone of Shortext’s automation system — they handle messages, trigger actions, and can even make external API calls.

***

## 🔄 Automations

Automations allow you to create tasks that run automatically — like scheduled notifications or daily summaries.

<img alt="Automations view" />

Examples:

* Send a message every morning at 9 AM.
* Notify a team when a ticket is created.
* Perform an API request at a fixed interval.

<Note type="warning">
  Use automations wisely — each scheduled task consumes resources and may affect your monthly usage limits.
</Note>

***

## ⚙️ Settings

The **Settings** section is where you configure everything related to your account and workspace.

<img alt="Settings screen" />

You’ll find:

* **Billing and Subscription** information
* **Integrations** (WhatsApp, Telegram, API keys)
* **Team Members and Roles**
* **Notification Preferences**

<Note type="success">
  Admins can control which modules each user can access through Role Management.
</Note>

***

## 📊 Insights (optional module)

If enabled, the **Insights** page displays analytics about conversations, agent performance, and response quality.

<img alt="Analytics and Insights" />

Metrics include:

* Total conversations per day
* Response rate per agent
* Average session duration
* User retention indicators

***

## 🚀 Next Steps

Now that you’re familiar with the dashboard, continue with:

* [Creating and Configuring Your First Agent →](/agents/creating-an-agent)
* [Connecting WhatsApp →](/integrations/whatsapp-setup)
* [Testing Your API Connections →](/api/configuration)

***

<Note type="info">
  Each module has its own dedicated section in this documentation where you’ll find detailed guides and examples.
</Note>


# What is Shortext ?
Source: https://docs.shortext.ny-corp.io/introduction/what-is-shortext

Discover what Shortext is, why it exists, and how it transforms customer interactions through intelligent automation.

Shortext is an **AI-powered communication platform** designed to help businesses manage and automate customer interactions — especially on messaging channels like **WhatsApp**.

It combines the simplicity of chat with the power of automation, giving you a flexible environment to build, deploy, and manage intelligent agents that handle messages, track sessions, and assist your customers in real time.

***

## ✨ Core Mission

At its core, Shortext aims to **simplify communication** between businesses and their clients.
Instead of juggling multiple tools or relying on manual replies, Shortext lets you centralize and automate conversations intelligently.

> “Our goal is not just to respond faster — it’s to create meaningful, automated experiences that feel human.”

***

## 🧠 How It Works

Shortext connects directly to your messaging channels (like WhatsApp Business API) and enables you to:

* Create and manage **AI agents** that understand and respond to users.
* Keep track of **active sessions** and conversations.
* Trigger **automated actions** based on user messages or events.
* Integrate with external systems using **custom APIs**.

Under the hood, Shortext is built with a modular architecture that combines:

* A smart **conversation engine** powered by AI.
* A **gateway system** that manages incoming and outgoing messages.
* A flexible **API layer** for developers and integrations.

***

## 🚀 Why Teams Use Shortext

Teams and organizations choose Shortext because it provides:

* **Full automation** — no human supervision required.
* **24/7 availability** to respond to clients anytime.
* **Easy integration** with existing tools and workflows.
* **Real-time insights** on messages, sessions, and engagement.

Whether you’re a startup looking to automate client follow-ups or a support team managing thousands of messages, Shortext adapts to your needs.

***

## 💡 Example Use Cases

Shortext is used across different industries to improve communication and support operations.

| Use Case               | Description                                                          |
| ---------------------- | -------------------------------------------------------------------- |
| **Customer Support**   | Automate replies, collect feedback, and track complaints.            |
| **Sales & Marketing**  | Send promotions or re-engage users within WhatsApp’s 24-hour window. |
| **Recruitment**        | Manage job applications and candidate communication automatically.   |
| **Internal Workflows** | Notify agents, assign tasks, or track operations in real time.       |

***

## 🧩 What’s Next

To get started, continue to:

* [Create your first account →](/getting-started/creating-an-account)
* [Explore the agent system →](/agents/introduction)
* [Learn how to configure APIs →](/api/configuration)

***

<Alert type="info">
  Need help or have questions? Contact us directly from your Shortext dashboard or visit the support section.
</Alert>