Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/i-am-bee/bee-api
API backend for Bee
https://github.com/i-am-bee/bee-api
agents ai api assistants-api bee-agent-framework fastify
Last synced: 20 days ago
JSON representation
API backend for Bee
- Host: GitHub
- URL: https://github.com/i-am-bee/bee-api
- Owner: i-am-bee
- License: apache-2.0
- Created: 2024-10-16T14:49:14.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2024-10-19T01:33:36.000Z (28 days ago)
- Last Synced: 2024-10-19T11:39:55.437Z (28 days ago)
- Topics: agents, ai, api, assistants-api, bee-agent-framework, fastify
- Language: TypeScript
- Homepage:
- Size: 488 KB
- Stars: 13
- Watchers: 5
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Bee API
OpenAI-compatible Assistants API backed by [Bee Agent Framework](https://github.com/i-am-bee/bee-agent-framework)
## Getting started
1. Create `.env` (from `.env.example`) and fill in values.
2. Run `pnpm install` to install dependencies.
3. Start the server with `pnpm start:dev`
## Technologies
- [Fastify](https://fastify.dev/) as the web framework
- [MikroORM](https://mikro-orm.io/) backed by [MongoDB](https://www.mongodb.com/) as the database layer
- [BullMQ](https://docs.bullmq.io/guide/jobs) backed by [Redis](https://redis.io/) as the job executor
- [Bee Agent Framework](https://github.com/i-am-bee/bee-agent-framework) as the agent execution engine
## Architecture overview
The Assistants API consists mostly of CRUDL endpoints for managing API resources like assistants, threads, runs and more. Furthermore, some resources are asynchronous in a sense that they contain `status` changing over time as the background execution progresses. Clients use polling or streaming to watch for status updates of such resources.
### Infrastructure
The infrastructure consists of:
- REST API server
- MongoDB
- Redis
The REST API server stores resources in MongoDB database. Redis is used by BullMQ, rate limiter and as pub/sub broker for event streaming. Agent execution is performed by the Bee Agent Framework using various adapters for inference and embeddings.
### Server
The codebase contains several types of modules:
- `*.modules.ts` containing endpoint handlers
- `*.services.ts` containing services for the handlers
- `dtos/*.ts` containing JSON schema definitions for resources
- `*.entity.ts` containing ORM definitions for database entities
- `*.queue.ts` containing BullMQ queues and workers for asynchronous execution
These modules are connected in the following manner
```
module ---> dto
---> service ---> entity
---> queue ---> entity
```
OpenAPI schema is auto-generated from the `dtos` and exposed on the `/docs` endpoint.