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

Uploaded Source

Built Distribution

fastapi_poe-0.0.31-py3-none-any.whl (17.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: fastapi_poe-0.0.31.tar.gz
  • Upload date:
  • Size: 17.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for fastapi_poe-0.0.31.tar.gz
Algorithm Hash digest
SHA256 2e40e4c759ff74f3f3821264c50a6b3a170be665d3e7e5c4b2128efeaa2c87f8
MD5 ee2745414176a0a6c5165e0c64ed38a0
BLAKE2b-256 b635eb275f7e4c3008c6750a51a45b19f09a47226de12e0a5fc4ca19800cb6d3

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: fastapi_poe-0.0.31-py3-none-any.whl
  • Upload date:
  • Size: 17.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for fastapi_poe-0.0.31-py3-none-any.whl
Algorithm Hash digest
SHA256 89b590a46ad366688fba0056bec0abb53dcb7e6d29d6cf9b7667c949b7c94a34
MD5 cbb38cfaca7a42ea2298429339b014bc
BLAKE2b-256 c441ab73a73c42f4499edd263e4b8f96265563abe0f71aa72f83b4d4e2f005de

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