Skip to main content

A demonstration of the Poe protocol using FastAPI

Project description

fastapi_poe

An implementation of the Poe protocol using FastAPI.

To run it:

  • Create a virtual environment (Python 3.7 or higher)
  • pip install .
  • python -m fastapi_poe
  • In a different terminal, run ngrok to make it publicly accessible

Write your own bot

This package can also be used as a base to write your own bot. You can inherit from fastapi_poe.PoeBot to make a bot:

from fastapi_poe import PoeBot, run
from fastapi_poe.types import PartialResponse

class EchoBot(PoeBot):
    async def get_response(self, request):
        last_message = request.query[-1].content
        yield PartialResponse(text=last_message)

if __name__ == "__main__":
    run(EchoBot())

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__":
    run(EchoBot(), access_key=<key>)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fastapi_poe-0.0.21.tar.gz (14.8 kB view details)

Uploaded Source

Built Distribution

fastapi_poe-0.0.21-py3-none-any.whl (15.1 kB view details)

Uploaded Python 3

File details

Details for the file fastapi_poe-0.0.21.tar.gz.

File metadata

  • Download URL: fastapi_poe-0.0.21.tar.gz
  • Upload date:
  • Size: 14.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for fastapi_poe-0.0.21.tar.gz
Algorithm Hash digest
SHA256 1543790e41f1e359b56d12111a07813d3ca9025d4bf23a0ee0b771380c8285b4
MD5 d4c559a849fc315f256b6a4f1dfedfe2
BLAKE2b-256 aa234da21f6c71f7e564c555410a0d5cd6e031b303271f942c08226264784778

See more details on using hashes here.

Provenance

File details

Details for the file fastapi_poe-0.0.21-py3-none-any.whl.

File metadata

  • Download URL: fastapi_poe-0.0.21-py3-none-any.whl
  • Upload date:
  • Size: 15.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for fastapi_poe-0.0.21-py3-none-any.whl
Algorithm Hash digest
SHA256 560130b3f17633e53ab4d567e2992100597b5bb76f5b408fa23c8a0e21bdca43
MD5 7d4558a37fb053bd9f37aeebac29921b
BLAKE2b-256 9d548f1e88bd6acd6eda71e0c720dd53e421a58c43acf42d52b90a9a5933e990

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page