Superagent is an open source agent framework that enables any developer to integrate production ready AI Agents into any application in a matter of minutes.
demo.mp4
We post tutorials regularly on our Youtube channel. Make sure to check them out!
Superagent allows you to build any AI application/micro service you want, including:
- Question/Answering over Documents (LLM Finetuns/Vectorstores)
- Chatbots
- Co-pilots & AI assistants
- Content generation
- Data aggregation
- Workflow automation
- Memory
- Streaming
- Custom finetuning π
- Python/Typescript SDKs
- REST API
- API connectivity
- Vectorization
- Support for proprietory and OSS LLMs
- API concurrency
For full documentation, visit docs.superagent.sh
To see how to contribute, visit Contribution guidelines
Clone the Superagent repository into a public GitHub repository or fork it from https://github.com/homanp/superagent/fork.
If you plan to distribute the code, keep the source code public.
Both the API and UI require a database in order to work. We recommend settings this up on Supabase.
Setting up Supabase
Create a Supabase account and project.
We have seperated the ui and api into two sepearate Supabase projects which is recommended due the fact that the api runs on prisma
.
Supabase setup for Superagent UI project
-
Run the migrations (checkout Superagent UI section for this)
supabase migration up (locally) supabase db push (cloud)
-
Run the following query to setup authentication:
-- inserts a row into public.profiles create function public.handle_new_user() returns trigger language plpgsql security definer set search_path = public as $$ begin insert into public.profiles (user_id) values (new.id); return new; end; $$; -- trigger the function every time a user is created create trigger on_auth_user_created after insert on auth.users for each row execute procedure public.handle_new_user();
-
Create a Supabase storage
-
Set storate permissions: Set the following policy for
storage.objects
Setting up Github OAuth in UI
-
Create a new Github OAuth app in your Github account
-
Copy the
CLIENT_ID
andCLIENT_SECRET
Β and paste them into the.env
Β variabels in the Superagent UI project. -
Set the following callback URL
<YOUR_SUPABASE_URL>/auth/v1/callback
-
Navigate to your Supabase project you have created for Superagent UI and paste the
CLIENT_ID
andCLIENT_SECRET
![Screenshot 2023-09-15 at 09 08 52](https://private-user-images.githubusercontent.com/2464556/268204427-abd1e2fb-df90-413a-b674-766343683f6c.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjQ3OTEyNjYsIm5iZiI6MTcyNDc5MDk2NiwicGF0aCI6Ii8yNDY0NTU2LzI2ODIwNDQyNy1hYmQxZTJmYi1kZjkwLTQxM2EtYjY3NC03NjYzNDM2ODNmNmMucG5nP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI0MDgyNyUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNDA4MjdUMjAzNjA2WiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9ZmE3YThiYTJjZTcyNGNjMTVlOTk5MGYyMzM2YzE2NGUzODk5MmFlOWJmMzI1NDEzNTUzYmQ2NTY4MjQ1N2E5NCZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QmYWN0b3JfaWQ9MCZrZXlfaWQ9MCZyZXBvX2lkPTAifQ.L1KQNr_iJ4OLGDWs2uwBlh6ozQQktlTr1ESbuUl_VrI)
NOTE: You can enable any provider using the steps above.
Superagent API
-
Navigate to
/libs/superagent
-
Rename the
env.example
to.env
and make sure you have all mandatory values set -
Create a virtual environment
virtualenv venv source venv/bin/activate
-
Install dependencies
poetry install
-
Run database migrations
poetry run prisma migrate dev
-
Start the server
uvicorn app.main:app --reload
Superagent UI
-
Navigate to
/libs/ui
-
Rename the
env.example
to.env
and make sure you have all mandatory values set -
Install the dependencies:
npm install
-
Run migrations:
supabase migrate up (local) supabase db push (cloud)
-
Run the development server
npm run dev
Superagent legacy
Please refer to the README in /libs/legacy
for further instructions.
If you are planing on integrating Superagent into your stack, you can use one of the following SDKs:
- Python
- Typescript/Javascript
- Swift (community)
Superagent is an open-source project, and contributions are welcome. If you would like to contribute, you can create new features, fix bugs, or improve the infrastructure. Please refer to the CONTRIBUTING.md file in the repository for more information on how to contribute
We want to give a big shout out to following open source projects, without which Superagent wouldn't be possible.