​
Copilotz API Documentation

​
Introduction

Welcome to the Copilotz API documentation! Copilotz is an AI-powered platform designed to help developers integrate intelligent agents into their applications, with a focus on WhatsApp interactions. Whether you want to build transcribers, chatbots, task managers, or API-integrating function executors, Copilotz provides you with the tools to create these agents and automate workflows seamlessly.

This documentation will guide you through everything you need to know to get started with Copilotz and unlock its full potential, from API authentication to integrating advanced workflows.

​
Key Features

  • WhatsApp Integration: Connect your agents to WhatsApp to enable AI-driven communication with your users. With Copilotz, you can link your API directly to WhatsApp through OpenAPI specs, allowing AI agents to respond to messages, handle requests, and even execute functions on behalf of users.

  • Multiple Agent Types: Copilotz offers pre-built agents, each tailored for specific use cases:

    • Transcriber: Converts voice messages to text.
    • Chat: Manages ongoing conversations with users, maintaining context across messages.
    • Function Call: Executes API calls or custom functions based on user input, using OpenAPI specs or JavaScript modules.
    • Task Manager: Automates complex workflows with multiple steps and tasks, tracking progress from start to finish.

  • Flexible Workflows: Define multi-step workflows that your agents can follow to complete tasks, whether it’s handling customer support requests, onboarding users, or any other custom business logic. Workflows can adapt based on user input or external events, and they support both success and failure paths.

  • OpenAPI Spec Integration: Simply provide your API’s OpenAPI specification, and Copilotz will handle the rest. Your agents can use this spec to dynamically call your API, perform actions, and return results.

  • Built for Developers: Copilotz is designed to fit seamlessly into your existing stack. Whether you’re working with REST APIs, integrating JavaScript functions, or building serverless apps, Copilotz can handle it all. The API is flexible, easy to integrate, and fully supports modern development workflows.

​
Who Should Use Copilotz?

If you’re a developer looking to:

  • Automate processes by building AI agents that interact with users in real-time.
  • Integrate your API directly with WhatsApp using OpenAPI specifications.
  • Create multi-step workflows that manage tasks, execute actions, and update systems automatically.
  • Reduce manual interactions with customers, improve service response time, or handle complex multi-step processes programmatically.

Then Copilotz is the platform for you!

​
What You’ll Find in This Documentation

This documentation covers all aspects of integrating and building with Copilotz, including:

  • Getting Started: Learn how to quickly set up your account, generate API keys, and start building agents.

  • Authentication: Understand how to authenticate your API calls using Bearer Tokens, including examples of how to retrieve and manage these tokens.

  • Resources: Detailed explanations and examples for working with Copilotz resources such as Actions, Channels, Workflows, Steps, and Tasks. Each section will guide you through creating, updating, and managing these resources via the Copilotz API.

  • Agent Types: Discover how to create and configure different types of agents, including real-world use cases and examples to help you build more effectively.

  • Workflows and Tasks: Learn how to define custom workflows and tasks that allow your agents to handle complex processes. This section also covers error handling, task progression, and how to manage state across multiple workflow steps.

  • Testing and Debugging: Information on how to test your agents and workflows using the Copilotz sandbox environment, along with tips for debugging and monitoring your agent interactions.

​
Getting Started

Before diving into the API, make sure to sign up for an account and obtain your API keys by clicking the Getting Started button on the Copilotz landing page. Once registered, you’ll be able to create your first agent and start integrating with WhatsApp using our free-tier sandbox environment.

Copilotz was built to be easy to use and flexible, making it a powerful tool for developers who want to streamline their applications with AI-driven automation. Explore the documentation, follow along with our examples, and start building your own agents today!