Skip to main content

A demonstration of the Poe protocol using FastAPI

Reason this release was yanked:

Broken, use 0.0.31 instead

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


Release history Release notifications | RSS feed

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

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fastapi_poe-0.0.29-py3-none-any.whl (17.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: fastapi_poe-0.0.29.tar.gz
  • Upload date:
  • Size: 17.7 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.29.tar.gz
Algorithm Hash digest
SHA256 3815111a0e338425e6e6c4a268281f062e5e15ba00442efb96c091dab4981a63
MD5 fa97442525a7f355efcd0c7a7e7f11ee
BLAKE2b-256 b56284101f64a9462576a147246a88c21446eabea1e7dee1bff8fdff223f39f7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: fastapi_poe-0.0.29-py3-none-any.whl
  • Upload date:
  • Size: 17.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.29-py3-none-any.whl
Algorithm Hash digest
SHA256 c6b64082d61e6c8f742e4e1dd146456c4196433282bff3f402e3ba9c77c553e7
MD5 71b76773bc66986f89de30fa502b134a
BLAKE2b-256 86bacd7fd407d0e43553811731ad66d9ab3a4e5c56c78a076c2f39d2192fc343

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page