Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/icebaker/nano-bots-api
HTTP API for Nano Bots: small, AI-powered bots that can be easily shared as a single file, designed to support multiple providers such as Cohere Command, Google Gemini, Maritaca AI MariTalk, Mistral AI, Ollama, OpenAI ChatGPT, and others, with support for calling tools (functions).
https://github.com/icebaker/nano-bots-api
alpaca chatgpt gemini gemini-pro google-ai google-gemini google-vertex-ai gpt gpt-4 llama llm maritaca-ai mistral-ai nano-bots ollama ollama-api openai openai-api vicuna
Last synced: about 1 month ago
JSON representation
HTTP API for Nano Bots: small, AI-powered bots that can be easily shared as a single file, designed to support multiple providers such as Cohere Command, Google Gemini, Maritaca AI MariTalk, Mistral AI, Ollama, OpenAI ChatGPT, and others, with support for calling tools (functions).
- Host: GitHub
- URL: https://github.com/icebaker/nano-bots-api
- Owner: icebaker
- License: mit
- Created: 2023-05-16T23:12:01.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-23T22:06:10.000Z (3 months ago)
- Last Synced: 2024-08-02T04:37:47.159Z (about 2 months ago)
- Topics: alpaca, chatgpt, gemini, gemini-pro, google-ai, google-gemini, google-vertex-ai, gpt, gpt-4, llama, llm, maritaca-ai, mistral-ai, nano-bots, ollama, ollama-api, openai, openai-api, vicuna
- Language: Ruby
- Homepage: https://api.nbots.io
- Size: 99.6 KB
- Stars: 13
- Watchers: 3
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Nano Bots API
The Nano Bots API leverages [ruby-nano-bots](https://github.com/icebaker/ruby-nano-bots) to create an HTTP API, enabling you to integrate your [Nano Bots](https://spec.nbots.io) through web requests.
Nano Bots are small, AI-powered bots that can be easily shared as a single file, designed to support multiple providers such as [Anthropic Claude](https://www.anthropic.com/claude), [Cohere Command](https://cohere.com), [Google Gemini](https://deepmind.google/technologies/gemini), [Maritaca AI MariTalk](https://www.maritaca.ai), [Mistral AI](https://mistral.ai), [Ollama](https://ollama.ai), [OpenAI ChatGPT](https://openai.com/chatgpt), and others, with support for calling tools (functions).
- [Public API](#public-api)
- [Running](#running)
- [Docker](#docker)
- [Security and Privacy](#security-and-privacy)
- [Tools (Functions)](#tools-functions)
- [API](#api)
- [Development](#Development)
## Public API
This API is available for free as a public API at: https://api.nbots.io
It is used to power the following projects:
- [Nano Bots for Sublime Text](https://github.com/icebaker/sublime-nano-bots)
- [Nano Bots for Visual Studio Code](https://github.com/icebaker/vscode-nano-bots)
- [Nano Bots for Obsidian](https://github.com/icebaker/obsidian-nano-bots)
- [Nano Bots Clinic (Live Editor)](https://clinic.nbots.io)
- [Nano Bots Marketplace](https://nbots.io)
## Running
Requirements:
```bash
build-essential libffi-dev libsodium-dev lua5.4-dev
```
```sh
git clone https://github.com/icebaker/nano-bots-api.git
cd nano-bots-api
```
Copy the `.env.example` file to `.env` and fill in the necessary data and run the server:
```sh
cp .env.example .env
bundle
./init.sh
```
### Docker
```sh
git clone https://github.com/icebaker/nano-bots-api.git
cd nano-bots-api
./build.sh
cp docker-compose.example.yml docker-compose.yml # Provide your credentials.
docker-compose up -d
# http://localhost:3048
```
## Security and Privacy
Read the Ruby Nano Bots documentation to learn about [security and privacy features](https://github.com/icebaker/ruby-nano-bots#security-and-privacy).
We strongly recommend that you define a `NANO_BOTS_ENCRYPTION_PASSWORD` to increase the security and privacy of your users.
### Tools (Functions)
The API ensures that Tools (Functions) run in sandboxed mode when the environment variable `FORCE_SANDBOXED` is set to `true`. You may set it to `false` at your own risk. Learn more about what being sandboxed means in the [Nano Bots specification](https://spec.nbots.io/#/README?id=functions).
Also, the API does not allow `confirmable` tools; as per the current implementation, it would block requests without being able to collect a confirmation answer from users.
## API
| Verb | Path | Description |
|------|------------------------|------------------------------------------------|
| GET | / | Get the version. |
| GET | /cartridges | Get all available cartridges. |
| POST | /cartridges/source | Show the source code of a cartridge. |
| POST | /cartridges | Evaluate the input. |
| POST | /cartridges/stream | Create a stream to be pooled for a evaluation. |
| GET | /cartridges/stream/:id | Get the current stream of a cartridge. |
### Payloads
`POST /cartridges/source`
```json
{
"id": "-"
}
```
`POST /cartridges`
```json
{
"cartridge": "-",
"state": "-",
"input": "hi"
}
```
`POST /cartridges`
```json
{
"cartridge": {
"meta": {
"symbol": "🤖",
"name": "Nano Bot Name",
"author": "Your Name",
"version": "1.0.0",
"license": "CC0-1.0",
"description": "A helpful assistant."
},
"behaviors": {
"interaction": {
"directive": "You are a helpful assistant."
}
},
"interfaces": {
"repl": {
"prompt": [
{ "text": "🤖" },
{ "text": "> ", "color": "blue" }
]
}
},
"provider": {
"id": "openai",
"credentials": {
"access-token": "ENV/OPENAI_API_KEY"
},
"settings": {
"user": "ENV/NANO_BOTS_END_USER",
"model": "gpt-3.5-turbo"
}
}
},
"state": "-",
"input": "hi"
}
```
`POST /cartridges`
```json
{
"as": "repl",
"action": "boot",
"cartridge": "-",
"state": "a21179b6104703af19328485101be839"
}
```
`POST /cartridges`
```json
{
"as": "repl",
"action": "eval",
"cartridge": "-",
"state": "a21179b6104703af19328485101be839"
}
```
`POST /cartridges`
```json
{
"as": "eval",
"action": "boot",
"cartridge": "-",
"state": "5677e56bbff1e8137c8eb1f60d2623ac"
}
```
`POST /cartridges`
```json
{
"as": "eval",
"action": "eval",
"cartridge": "-",
"state": "5677e56bbff1e8137c8eb1f60d2623ac"
}
```
`POST /cartridges/stream`
The same payloads that were used for `POST /cartridges`:
```json
{
"cartridge": "-",
"state": "-",
"input": "hi"
}
```
## Development
Once you've installed the dependencies with `bundle`, run Rubocop with the `-A` flag for automatic fixes.
```sh
rubocop -A
```
If you face issues upgrading gem versions:
```sh
bundle install --full-index
```