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

Uploaded Source

Built Distribution

fastapi_poe-0.0.10-py3-none-any.whl (7.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for fastapi_poe-0.0.10.tar.gz
Algorithm Hash digest
SHA256 2a286c52de99367943255d762734e2282f00e0a64905e782cd3d283625b19b72
MD5 a01ad9b1c42268a8d944eb5dcfb31563
BLAKE2b-256 d82761bf4761536f4c0639b7418e445177bebd4e00cfd28ba5f2d2f76d147800

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for fastapi_poe-0.0.10-py3-none-any.whl
Algorithm Hash digest
SHA256 8e0db36dd8ddeae0e2532005b8c8405649af20656955018bd3cf8b29fd3b41e6
MD5 c2f0db411dd02fc507b663ac4b2f0b0f
BLAKE2b-256 f08beed2b5a65dec3f191d28206fb6980e307772dc361a1f849a724ee85bb213

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