A demonstration of the Poe protocol using FastAPI
Project description
fastapi_poe
An implementation of the Poe protocol using FastAPI.
Write your own bot
This package can also be used as a base to write your own bot. You can inherit from
PoeBot to make a bot:
import fastapi_poe as fp
class EchoBot(fp.PoeBot):
async def get_response(self, request: fp.QueryRequest):
last_message = request.query[-1].content
yield fp.PartialResponse(text=last_message)
if __name__ == "__main__":
fp.run(EchoBot(), allow_without_key=True)
Now, run your bot using python <filename.py>.
- In a different terminal, run ngrok to make it publicly accessible.
- Use the publicly accessible url to integrate your bot with poe
Enable authentication
Poe servers send requests containing Authorization HTTP header in the format "Bearer <access_key>"; the access key is configured in the bot settings page.
To validate that the request is from the Poe servers, you can either set the environment variable POE_ACCESS_KEY or pass the parameter access_key in the run function like:
if __name__ == "__main__":
fp.run(EchoBot(), access_key=<key>)
Samples
Check out our starter code repository for some examples you can use to get started with bot development.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file fastapi_poe-0.0.37.tar.gz.
File metadata
- Download URL: fastapi_poe-0.0.37.tar.gz
- Upload date:
- Size: 19.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 1d470bb121211a3ab6df9fa1fa024b664e51c042839925e7c4c21519642ec8d2 |
|
| MD5 | f3fbf52843122da4dc25b667c25b7c3e |
|
| BLAKE2b-256 | b7852b9a300520e0f34e8f24e91d7a346df2ecb5ae27c848dcebf27f0cfa66f4 |
Provenance
File details
Details for the file fastapi_poe-0.0.37-py3-none-any.whl.
File metadata
- Download URL: fastapi_poe-0.0.37-py3-none-any.whl
- Upload date:
- Size: 19.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | fcdbbb60c845753ed3d359557a37b4830252cc8b0df66b9c4a64972f08148038 |
|
| MD5 | 6003bcb66c81366243e624c2668e72b7 |
|
| BLAKE2b-256 | 2aa6eb2a6395701b57510ee5d43e02a1df73dbe0d30b79b1c95a657acce9f943 |
