Skip to main content

A demonstration of the Poe protocol using FastAPI

Project description

fastapi_poe

An implementation of the Poe protocol using FastAPI.

Write your own bot

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

import fastapi_poe as fp

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

if __name__ == "__main__":
    fp.run(EchoBot(), allow_without_key=True)

Now, run your bot using python <filename.py>.

  • In a different terminal, run ngrok to make it publicly.
  • Use the publicly accessible url to integrate your bot with poe

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

Samples

Check out our starter code repository for some examples you can use to get started with bot development.

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

Uploaded Source

Built Distribution

fastapi_poe-0.0.24-py3-none-any.whl (15.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: fastapi_poe-0.0.24.tar.gz
  • Upload date:
  • Size: 15.3 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.24.tar.gz
Algorithm Hash digest
SHA256 979694fb21f7068cee8d6ec899e3df08007ad2c571a23ca90a2c1470fd21ff16
MD5 2c6ace4a5945bb23ef6d8c67deb43e22
BLAKE2b-256 650f6964392d5e4ae6c75279210346d5d9dd64b0aa66b94b67d2b5dddea98b3b

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: fastapi_poe-0.0.24-py3-none-any.whl
  • Upload date:
  • Size: 15.5 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.24-py3-none-any.whl
Algorithm Hash digest
SHA256 df99039852847a264bb20e913716936c6874ae87dd9901ade3a31898406babf0
MD5 73a6d9dffc095ffd14e0aecfa439cab5
BLAKE2b-256 45aa154da86f09764e35059ae3ce76e44eca05dc82442b590b93d721dd7f4c13

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