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.PoeHandler to make a bot:

from fastapi_poe import PoeHandler, run

class EchoHandler(PoeHandler):
    async def get_response(self, query):
        last_message = query.query[-1].content
        yield self.text_event(last_message)

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

Enable authentication

Poe servers send requests containing Authorization HTTP header in the format "Bearer <api_key>," where api_key is the API key configured in the bot settings. \

To validate the requests are from Poe Servers, you can either set the environment variable POE_API_KEY or pass the parameter api_key in the run function like:

if __name__ == "__main__":
    run(EchoHandler(), api_key=<key>)

For a more advanced example that exercises more of the Poe protocol, see Catbot.

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.5.tar.gz (5.1 kB view details)

Uploaded Source

Built Distribution

fastapi_poe-0.0.5-py3-none-any.whl (7.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for fastapi_poe-0.0.5.tar.gz
Algorithm Hash digest
SHA256 55f0eda680fe10d5aa9fd49327ca473e0c22ceab0e02dcd715bdd0544c92515f
MD5 e7b1498b23cbea91fc6d709c7d084d3d
BLAKE2b-256 049464a05dca3e25f5700dca7992db8dcfd8f99006d590995ff6b80f34cd2d79

See more details on using hashes here.

Provenance

File details

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

File metadata

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

File hashes

Hashes for fastapi_poe-0.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 09c38e19eda478010242110286096d62d1f37f48dce8a18da60bdf3d8fad5da0
MD5 5c7981e9974850539b04308c77b34f61
BLAKE2b-256 6603afd293ab47dcba777d38210cc2a5853f33939434bf6da79da67281d58856

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