poe-protocol's Introduction

Poe Bot Protocol

Note: The Poe Protocol is not live yet. The protocol may still change and it is not yet possible to create protocol-based bots.

Poe is a platform for interacting with AI-based bots. That includes well-known chat bots like OpenAI's ChatGPT and Anthropic's Claude, but anyone can create their own bot by implementing the protocol described in this repository.

Repo contents

Protocol specification
Example implementations
- FastAPI, a simple bot to demonstrate the features of the protocol
- aiohttp, the same bot built using aiohttp instead of FastAPI
- LangChain, an example bot built on top of ChatGPT using LangChain

Getting started

Install ngrok and Python 3.7+
python3 -m pip install fastapi_poe
python3 -m fastapi_poe
ngrok http 8080
Go to https://poe.com/create_bot?api=1
Enter your ngrok URL
Create your bot!
Look at the catbot explainer to play with the sample bot's limited capabilities
Now, extend the sample code to write your own bot to do something new and exciting
Check out the spec to take advantage of all the capabilities of API bots

Writing your own bot

To understand what Poe protocol bots can do:
- Read the spec
- Check out the simple samples
- Check out a sample that integrates with ChatGPT
- Check out more samples from LangChain
To get a bot running locally:
- python3 -m pip install fastapi_poe
- python3 -m fastapi_poe
- (or use aiohttp_poe, or write your own implementation of the spec)
To connect your bot to Poe:
- Make it publicly accessible on the Internet, for example:
  - Using ngrok to expose a service running on your machine
  - Using Replit to run a bot in your browser
  - Using any cloud provider you may have access to
To create your bot in Poe:
- https://poe.com/create_bot?api=1

Recommend Projects