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

Uploaded Source

Built Distribution

fastapi_poe-0.0.28-py3-none-any.whl (17.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: fastapi_poe-0.0.28.tar.gz
  • Upload date:
  • Size: 17.6 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.28.tar.gz
Algorithm Hash digest
SHA256 0cf9eeecb7149cede28a39e6977aa36173bccacbd783a1c0645a24e42ad31c70
MD5 553ae0e3cb03dd20fbf2cf32966250d6
BLAKE2b-256 184d1b76e87841a74d7f5915975d4096751c42590390817f371e53c14b71e1fa

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for fastapi_poe-0.0.28-py3-none-any.whl
Algorithm Hash digest
SHA256 0f96a6e9f1547c4f2bca7650d90b37ea9196bc038b4b03bd8f43cd9511219645
MD5 5d04db6a60da5b1c42affc2ddc069c61
BLAKE2b-256 ae86a4e84955b5825cbdf25d7639d6b56544986cb344fef9d52bf729b8d76710

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