🔌 Using TIXAE Agents API for Scalable Data Access & Pagination

Learn how to interact with the TIXAE Agents API to fetch clients, analytics, and more — with proper authentication and efficient pagination techniques.

🧠 Introduction

TIXAE Agents offers a robust and developer-friendly API for managing AI-powered agents, clients, conversations, analytics, and channel integrations.

The API supports:

• 🚀 Real-time and batch access to agents, clients, conversations
• 📈 Analytics across time ranges for performance monitoring
• 🌐 Multi-region support (EU, NA)
• 🔒 Bearer token–based authentication
• 📦 Efficient pagination for large datasets

In this guide, you'll learn:

• How to authenticate and access TIXAE APIs
• How pagination works and why it matters
• Practical examples to fetch clients and analytics

---

⚙️ 1. API Basics

🧭 Base URLs by Region

| Region | v2 (legacy) | v3 (current/latest) | |--------|-------------|---------------------| | EU | https://eu-vg-edge.moeaymandev.workers.dev/v2 | https://eu-runtime.tixaeagents.org/v3 | | NA | https://na-vg-edge.moeaymandev.workers.dev/v2 | https://na-runtime.tixaeagents.org/v3 |

---

🔐 Authentication

All API requests require a Bearer token in the headers:

Authorization: Bearer 

Tokens can be:

• Workspace tokens (access to all clients/agents)
• Agent tokens (access limited to a specific agent)

---

🔁 2. Understanding Pagination

TIXAE APIs support offset-based pagination, which is crucial when retrieving large lists of resources.

Supported Query Params:

• limit: Number of results per request
• offset: Starting index (0 for first page, then increase)

🔄 Pagination Flow:

1. Fetch the first page: limit=100&offset=0 2. If 100 results are returned, fetch the next: offset=100 3. Stop when fewer results than limit are returned

---

📊 3. Example: Fetching Clients with Pagination

GET /clients?limit=100&offset=0
Host: na-vg-edge.moeaymandev.workers.dev
Authorization: Bearer 

➡️ For the next page:

GET /clients?limit=100&offset=100

---

📈 4. Example: Fetching Analytics for an Agent

GET /agents/{agent_id}/analytics?start_ts=1680000000&stop_ts=1690000000&limit=50&offset=0
Authorization: Bearer 

• start_ts and stop_ts are Unix timestamps
• Useful for aggregating usage within specific time windows

---

🐍 5. Python Example: Paginate Through Clients

import requests
BASE = "https://na-vg-edge.moeaymandev.workers.dev/v2"
TOKEN = "Bearer YOUR_WORKSPACE_TOKEN"
def get_all_clients():
    offset, limit = 0, 100
    all_clients = []
    while True:
        res = requests.get(
            f"{BASE}/clients?limit={limit}&offset={offset}",
            headers={"Authorization": TOKEN}
        )
        clients = res.json().get("clients", [])
        all_clients.extend(clients)
        if len(clients) < limit:
            break
        offset += limit
    return all_clients

---

💡 6. Best Practices

| Tip | Why it Matters | |-----|----------------| | ✅ Use limit and offset for all list queries | Ensures scalability | | ✅ Filter by start_ts and stop_ts for analytics | Reduces unnecessary data | | ✅ Handle empty results gracefully | Avoids infinite loops | | ✅ Keep requests under 200 results/page | Prevents timeouts or overload | | ✅ Use exponential backoff for rate limiting | Keeps your integration robust |

---

🧪 7. Bonus: Useful Endpoints with Pagination

Here are commonly paginated endpoints:

• /clients
• /agents
• /agents/{agent_id}/analytics
• /conversations
• /kb (Knowledge Base Items)

Each supports limit and offset parameters.

---

📦 8. Common Use Cases

• ✅ Dashboard Reporting — Pull analytics and usage metrics
• ✅ Client Management Tools — List, search, and filter clients
• ✅ Data Pipelines — Automate syncing TIXAE data to external DBs
• ✅ Auditing — Fetch historical conversations and agent activity
• ✅ Voiceflow Agent Syncing — Fetch data from multiple agents with batching

---

✅ 9. Conclusion

The TIXAE Agents API is a powerful interface to build custom dashboards, sync data, or automate workflows across your AI ecosystem. With reliable token-based authentication and standardized pagination, you can confidently scale your integrations and applications.

Make sure to:

• Use correct region and API version
• Apply pagination (limit, offset)
• Combine pagination with filtering for best performance

---

📚 10. Additional Resources

• 📖 Official API Reference
• 🧠 Voiceflow Integration Guide
• 🎥 YouTube Channel
• 💬 Discord Support