Logo

Quickstart

Prerequisites

Before installing Assistant-Engine, ensure you have the following prerequisites:

  • PHP: Version 8.0 or higher
  • Composer: Latest stable version
  • Filament: Optional, for using pre-built UI components
  • Laravel: Optional, for using pre-built UI components

Sign Up for an Account

To begin using Assistant-Engine, sign up for an account at https://assistant-engine.com

Homepage

Choose Your Plan

Assistant-Engine offers three subscription tiers. After signing up, you will be automatically assigned to our Free subscription plan. If you need more liberty feel free to upgrade or get in touch.

Plans

Note: In Assistant-Engine, a 'Call' refers specifically to interactions with the OpenAI API, and it includes the following actions:

  • The execution of a task.
  • The creation of a new conversation.
  • The processing of a new message within an existing conversation.

Each of these actions triggers a new AssistantThreadRun with OpenAI in the background. Even if an error occurs during the AssistantThreadRun, it still counts as a call. Internal services that do not involve OpenAI are not counted toward your call limit. This ensures that only interactions that directly utilize the OpenAI API affect your call count.

Once you have created your account you can access the Assistant-Engine Admin Panel and begin integrating AI into your projects. To set up a Project, Tasks, Assistants, and Tools please refer to the Instructions in the Assistant-Engine section.

Filament Plugin (Optional)

Assistant-Engine comes with free to use pre-built UI components for Filament you can use to execute tasks or integrate a chat assistant into your Filament project. Alternatively, you can create your own components by directly using the Assistant-Engine API, giving you full control over the integration and customization. For instructions on how to do so and how to install the Plugin visit the detailed Filament Plugin Installation Guide

Laravel Plugin (Optional)

Assistant-Engine provides free to use pre-built UI components for Laravel you can use to execute tasks or integrate a chat assistant into your Laravel software project. Alternatively, you can create your own components by directly using the Assistant-Engine API, giving you full control over the integration and customization. For instructions on how to do so and how to install the Plugin visit the detailed Laravel Plugin Installation Guide

Previous

Introduction

Next

Projects

On this page