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

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

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

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(EchoBot(), 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.12.tar.gz (5.5 kB view details)

Uploaded Source

Built Distribution

fastapi_poe-0.0.12-py3-none-any.whl (7.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: fastapi_poe-0.0.12.tar.gz
  • Upload date:
  • Size: 5.5 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.12.tar.gz
Algorithm Hash digest
SHA256 23234044a352e3591c2b3709f22a734bbcf8ee7850866aab7d7251a528e84f1c
MD5 830d4bf0e812ff8409825c1def583422
BLAKE2b-256 8f1c483603111f9a03cd811844a0de249437e97bbbbc20c69636a274ca728839

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for fastapi_poe-0.0.12-py3-none-any.whl
Algorithm Hash digest
SHA256 64e9d700fabd4d73cb65332689f2b64cd0a3e6c51156974a20780e97c5741580
MD5 1e371e7aeab9f6f368479582b064bfca
BLAKE2b-256 067e80e539b77fe31e562c9aecae557adf922748015dcb2182de34abef7719cb

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