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

Uploaded Source

Built Distribution

fastapi_poe-0.0.23-py3-none-any.whl (15.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: fastapi_poe-0.0.23.tar.gz
  • Upload date:
  • Size: 15.1 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.23.tar.gz
Algorithm Hash digest
SHA256 8d9fb47890313bc958e8accbf2acb58467722a8ed8acfa78045a710040198d68
MD5 1a5f399eb0871d5e22095eaf5cbf2eea
BLAKE2b-256 af1704d74197b560703e6b001198c4e66cbd1b4d3610a75fe4f86675d5dfa1b9

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: fastapi_poe-0.0.23-py3-none-any.whl
  • Upload date:
  • Size: 15.6 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.23-py3-none-any.whl
Algorithm Hash digest
SHA256 5ba117f85149e08cf490cbdc72ca7e2119a89405c01e80f2b399fb170870922b
MD5 775483aba386237f3199d317beac6df8
BLAKE2b-256 c5c47d1891be5d81892d3f72fcf249fffcb5c60a6cd6f42d5407dc5897b91e1b

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