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 accessible.
  • 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.48.tar.gz (29.1 kB view details)

Uploaded Source

Built Distribution

fastapi_poe-0.0.48-py3-none-any.whl (25.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: fastapi_poe-0.0.48.tar.gz
  • Upload date:
  • Size: 29.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for fastapi_poe-0.0.48.tar.gz
Algorithm Hash digest
SHA256 3b9dcc978f4272fb473ed78b236dbca8fbd8f87c5cecbfe4c738a6e75814d8be
MD5 4bf37e6eff32a58485fb095ab44a0a05
BLAKE2b-256 0a4af547303461a40624c6e8ccb85d73c1dca97e9c6c2c08b1e5f6a3380ae7fe

See more details on using hashes here.

File details

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

File metadata

  • Download URL: fastapi_poe-0.0.48-py3-none-any.whl
  • Upload date:
  • Size: 25.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for fastapi_poe-0.0.48-py3-none-any.whl
Algorithm Hash digest
SHA256 5305a83a923edade4c37f341941963396df01954786726c396d48a497ad33cc4
MD5 4559cd73d875905c8123733995b289dc
BLAKE2b-256 3f63608c3e9e600046bee4732d18a57c6a860012ccf3fb03b4e2ea000b8a76b1

See more details on using hashes here.

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